/[drupal]/contributions/modules/week/week.module

Diff of /contributions/modules/week/week.module

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.19.2.1.2.3,
Sun Aug 30 23:49:20 2009 UTC
+revision 1.19.2.1.2.4,
Mon Aug 31 15:47:32 2009 UTC
 Line 1
  <?php
- /* $Id: week.module,v 1.19.2.1.2.2 2009/08/30 23:15:27 prometheus6 Exp $ */
+ /* $Id: week.module,v 1.19.2.1.2.3 2009/08/30 23:49:20 prometheus6 Exp $ */
  define('ARCHIVEROOTBEFORETYPE', 1);
  define('TYPEBEFOREARCHIVEROOT', 2);
- function _week_week_data(&$link_data) {
+ /**
-   // calculate the start and end of the week
+  * Calculate beginning and end dates for a given year and week
+  * @param $date_data must have at least $date_data['year'] and $date_data['week'] populated
+  */
+ function _week_week_data(&$date_data) {
+   //  This is a mess because there's no function that gives you the first day of the week for a given year and week combination.
+   //  Drupal allows you to set any day as the first day of the week. However, the ISO8601 standard specifies Monday as the first day of the week
+   //  and the USofA standard specifies Sunday. So we are going to make Sunday the first day of the week if specified; otherwise it will be Monday.
    $date_first_day = (variable_get('date_first_day', 1) == 0) ? 0 : 1;
-   $wk_ts = strtotime('+' . ($link_data['week'] - $date_first_day) . ' weeks', strtotime($link_data['year'] .'-01-01'));
+   // First we need to create a date variable holding SOME day in the given week (the first day of the year, plus a number of weeks).
+   // the $date_first_day adjustment reflects the practical observation that starting the week with Monday gets you a lower week number
+   // for a given date.
+   $wk_ts = strtotime('+' . ($date_data['week'] - $date_first_day) . ' weeks', strtotime($date_data['year'] .'-01-01'));
+   // Now that we have a time stamp that falls somewhere in the week specified by the week number, we want a timestamp for the first day
+   // of the week. We get the day number of the date in this timestamp (0 = Sunday), subtract that number of days from the timestamp if
+   // the week starts with Sunday, or one less than the day number if the week starts with Monday
    $start_week_ts = strtotime('-' . (date('w', $wk_ts) - $date_first_day) . ' days', $wk_ts);
+   // The end of the week is six days later
    $end_week_ts = strtotime('+6 days', $start_week_ts);
-   $link_data['month'] = date('F', $start_week_ts);
+   $date_data['month'] = date('F', $start_week_ts);
-   $link_data['mon'] = date('M', $start_week_ts);
+   $date_data['mon'] = date('M', $start_week_ts);
-   $link_data['monthno'] = date('m', $start_week_ts);
+   $date_data['monthno'] = date('m', $start_week_ts);
-   $link_data['day'] = date('d', $start_week_ts);
+   $date_data['day'] = date('d', $start_week_ts);
-   $link_data['dayname'] = date('l', $start_week_ts);
+   $date_data['dayname'] = date('l', $start_week_ts);
-   $link_data['sdayname'] = date('D', $start_week_ts);
+   $date_data['sdayname'] = date('D', $start_week_ts);
-   $link_data['end_year'] = date('Y', $end_week_ts);
+   $date_data['end_year'] = date('Y', $end_week_ts);
-   $link_data['end_month'] = date('F', $end_week_ts);
+   $date_data['end_month'] = date('F', $end_week_ts);
-   $link_data['end_mon'] = date('M', $end_week_ts);
+   $date_data['end_mon'] = date('M', $end_week_ts);
-   $link_data['end_monthno'] = date('m', $end_week_ts);
+   $date_data['end_monthno'] = date('m', $end_week_ts);
-   $link_data['end_day'] = date('d', $end_week_ts);
+   $date_data['end_day'] = date('d', $end_week_ts);
-   $link_data['end_dayname'] = date('l', $end_week_ts);
+   $date_data['end_dayname'] = date('l', $end_week_ts);
-   $link_data['end_sdayname'] = date('D', $end_week_ts);
+   $date_data['end_sdayname'] = date('D', $end_week_ts);
-   $link_data['end_year'] = date('Y', $end_week_ts);
  }
+ /**
+  *
+  * @param $archive_type
+  * @return boolean
+  */
  function week_access_page($archive_type) {
    if (is_string($archive_type)) {
      $archive_types = variable_get('week_block_node_type', array());
      return user_access('access content') and ($archive_types[$archive_type]);
    }
-   elseif (is_null($archive_type)) {return TRUE;}
+   elseif (is_null($archive_type)) {return user_access('access content');}
  }
+ /**
+  *
+  * hook_block() implementation
+  */
  function week_block($op = 'list', $delta = 0, $edit = array()) {
    switch ($op) {
      // listing of blocks, such as on the admin/system/block page
-Line 75 
 function week_block($op = 'list', $delta
+Line 100 
 function week_block($op = 'list', $delta
        }
        if ($week_include_node_type) {
          $week_rev_chronsort = variable_get('week_rev_chronsort', 0);
-         $query = week_block_links_query($week_include_node_type, $week_rev_chronsort);
+         $query = week_links_query($week_include_node_type, $week_rev_chronsort);
          // plus one is the easiest way to find out if you need a "more" link
          $weeklist = db_query_range(db_rewrite_sql($query, 'n', 'nid'), $week_max_block_links + 1);
-Line 105 
 function week_block($op = 'list', $delta
+Line 130 
 function week_block($op = 'list', $delta
    }
  }
+ /**
+  *
+  * (Really weak) hook_help() implementation
+  */
  function week_help($section) {
    switch ($section) {
      case 'admin/settings/week' :
-Line 121 
 function week_help($section) {
+Line 150 
 function week_help($section) {
  }
  /**
-  * Create SQL for links query
+  * The archive link query builder
   *
   * @param array $node_types
   * @return string
   */
- function week_block_links_query($node_types) {
+ function week_links_query($node_types) {
    foreach ($node_types as $key => $value) {
      $node_types[$key] = "'" . db_escape_string($value) . "'";
    }
-Line 144 
 function week_block_links_query($node_ty
+Line 173 
 function week_block_links_query($node_ty
    $query .= ' AND status = 1 ';
    $query .= ' GROUP BY yearweek ORDER BY yearweek ';
    $query .= $week_rev_linksort ? ' ASC' : ' DESC ';
- //  drupal_set_message($query);
    return $query;
  }
-Line 160 
 function week_link_page($include_node_ty
+Line 188 
 function week_link_page($include_node_ty
    else {
      $week_include_node_type = variable_get('week_include_node_type', array_keys(node_get_types('names')));
    }
-   $query = week_block_links_query($week_include_node_type);
+   $query = week_links_query($week_include_node_type);
    $weeklist = db_query(db_rewrite_sql($query, 'n', 'nid'));
    $block_content = array();
    $listed_links = 0;
-Line 182 
 function week_link_page($include_node_ty
+Line 210 
 function week_link_page($include_node_ty
    return theme('item_list', $block_content);
  }
+ /**
+  * hook_menu() implementation
+  */
  function week_menu() {
    $archive_types = array_flip(variable_get('week_block_node_type', array()));
    $archive_types['all'] = NULL;
-Line 262 
 function week_menu() {
+Line 293 
 function week_menu() {
    return $items;
  }
+ /**
+  * hook_perm() implementation
+  */
  function week_perm() {
    return array(
-Line 269 
 function week_perm() {
+Line 303 
 function week_perm() {
    );
  }
+ /**
+  * Generate the archive page
+  * @param $year
+  * @param $week
+  * @param $include_node_types
+  * @return unknown_type
+  */
  function week_post_page($year, $week, $include_node_types = NULL) {
    if (is_numeric($year) and is_numeric($week)) {
      $default_nodes_main = variable_get('default_nodes_main', 20);
-Line 280 
 function week_post_page($year, $week, $i
+Line 321 
 function week_post_page($year, $week, $i
      $node_query_str = week_post_query($week_include_node_types, $year, $week);
-     //    $node_query_str = db_rewrite_sql(montharchive_post_query($montharchive_include_node_types, $year, $month), 'n', 'node');
      $node_query = $week_paginate ? pager_query($node_query_str, $default_nodes_main, 0) : db_query($node_query_str);
      while ($nid = db_fetch_array($node_query)) {
        $node = node_load($nid['nid']);
-Line 306 
 function week_post_page($year, $week, $i
+Line 346 
 function week_post_page($year, $week, $i
    return $page ? $page : '';
  }
+ /**
+  * the archive page query builder
+  * @param $week_include_node_types
+  * @param $year
+  * @param $week
+  * @return unknown_type
+  */
  function week_post_query($week_include_node_types, $year, $week) {
    if (is_string($week_include_node_types)) {
      $week_include_node_types[] = $week_include_node_types;
-Line 326 
 function week_post_query($week_include_n
+Line 373 
 function week_post_query($week_include_n
    return $query;
  }
+ /**
+  * Creates the form to enable node type blocks
+  * @return array
+  */
  function week_settings_form() {
    $output['week_all'] = array(
-Line 592 
 function week_settings_type_path_form()
+Line 643 
 function week_settings_type_path_form()
    return $output;
  }
+ /**
+  * week_settings_type_path_form reset function
+  */
  function week_settings_type_path_form_reset() {
    variable_del('week_link_text');
    variable_del('week_path');
-Line 607 
 function week_settings_type_path_form_re
+Line 661 
 function week_settings_type_path_form_re
    cache_clear_all();
  }
+ /**
+  * week_settings_type_path_form submit function
+  * @param $form
+  * @param $form_state
+  */
  function week_settings_type_path_submit($form, &$form_state) {
    if ($form_state['clicked_button']['#value'] == 'Reset to defaults') {
      week_settings_type_path_form_reset();
-Line 627 
 function week_settings_type_path_submit(
+Line 686 
 function week_settings_type_path_submit(
    menu_rebuild();
  }
+ /**
+  * week_settings_type_path_form validate function
+  * @param $form
+  * @param $form_state
+  */
  function week_settings_type_path_validate($form, &$form_state) {
    $found = preg_match('%^[a-z|0-9|_]+$%', $form_state['values']['week_path']);
    if (!$found) {

 Legend:



Removed from v.1.19.2.1.2.3
 


changed lines


 
Added in v.1.19.2.1.2.4
 Legend:



Removed from v.1.19.2.1.2.3
 


changed lines


 
Added in v.1.19.2.1.2.4
-Removed from v.1.19.2.1.2.3
+Added in v.1.19.2.1.2.4

	ViewVC Help
Powered by ViewVC 1.1.2