library/plugins/function.html_select_date.php

   1 <?php
   2 /**
   3  * Smarty plugin
   4  * @package Smarty
   5  * @subpackage plugins
   6  */
   7
   8 /**
   9  * Smarty {html_select_date} plugin
  10  *
  11  * Type:     function<br>
  12  * Name:     html_select_date<br>
  13  * Purpose:  Prints the dropdowns for date selection.
  14  *
  15  * ChangeLog:<br>
  16  *           - 1.0 initial release
  17  *           - 1.1 added support for +/- N syntax for begin
  18  *                and end year values. (Monte)
  19  *           - 1.2 added support for yyyy-mm-dd syntax for
  20  *                time value. (Jan Rosier)
  21  *           - 1.3 added support for choosing format for
  22  *                month values (Gary Loescher)
  23  *           - 1.3.1 added support for choosing format for
  24  *                day values (Marcus Bointon)
  25  * @link http://smarty.php.net/manual/en/language.function.html.select.date.php {html_select_date}
  26  *      (Smarty online manual)
  27  * @version 1.3.1
  28  * @author   Andrei Zmievski
  29  * @param array
  30  * @param Smarty
  31  * @return string
  32  */
  33 function smarty_function_html_select_date($params, &$smarty)
  34 {
  35     require_once $smarty->_get_plugin_filepath('shared','make_timestamp');
  36     require_once $smarty->_get_plugin_filepath('function','html_options');
  37     /* Default values. */
  38     $prefix          = "";
  39     $start_year      = strftime("%Y");
  40     $end_year        = $start_year;
  41     $display_days    = true;
  42     $display_months  = true;
  43     $display_years   = true;
  44     $month_format    = "%B";
  45     /* Write months as numbers by default  GL */
  46     $month_value_format = "%m";
  47     $day_format      = "%02d";
  48     /* Write day values using this format MB */
  49     $day_value_format = "%d";
  50     $year_as_text    = false;
  51     /* Display years in reverse order? Ie. 2000,1999,.... */
  52     $reverse_years   = true;
  53     /* Should the select boxes be part of an array when returned from PHP?
  54        e.g. setting it to "birthday", would create "birthday[Day]",
  55        "birthday[Month]" & "birthday[Year]". Can be combined with prefix */
  56     $field_array     = null;
  57     /* <select size>'s of the different <select> tags.
  58        If not set, uses default dropdown. */
  59     $day_size        = null;
  60     $month_size      = null;
  61     $year_size       = null;
  62     /* Unparsed attributes common to *ALL* the <select>/<input> tags.
  63        An example might be in the template: all_extra ='class ="foo"'. */
  64     $all_extra       = null;
  65     /* Separate attributes for the tags. */
  66     $day_extra       = null;
  67     $month_extra     = null;
  68     $year_extra      = null;
  69     /* Order in which to display the fields.
  70        "D" -> day, "M" -> month, "Y" -> year. */
  71     $field_order     = 'MDY';
  72     /* String printed between the different fields. */
  73     $field_separator = "\n";
  74     $time = time();
  75     $all_empty       = null;
  76     $day_empty       = null;
  77     $month_empty     = null;
  78     $year_empty      = null;
  79
  80     foreach ($params as $_key=>$_value) {
  81         switch ($_key) {
  82             case 'prefix':
  83             case 'time':
  84             case 'start_year':
  85             case 'end_year':
  86             case 'month_format':
  87             case 'day_format':
  88             case 'day_value_format':
  89             case 'field_array':
  90             case 'day_size':
  91             case 'month_size':
  92             case 'year_size':
  93             case 'all_extra':
  94             case 'day_extra':
  95             case 'month_extra':
  96             case 'year_extra':
  97             case 'field_order':
  98                 $$_key = (string)$_value;
  99                 break;
 100
 101             case 'field_separator':
 102             case 'month_value_format':
 103             case 'month_empty':
 104             case 'day_empty':
 105             case 'year_empty':
 106                 $$_key = (string)$_value;
 107                 break;
 108
 109             case 'all_empty':
 110                 $$_key = (string)$_value;
 111                 $day_empty = $month_empty = $year_empty = $all_empty;
 112                 break;
 113
 114             case 'display_days':
 115             case 'display_months':
 116             case 'display_years':
 117             case 'year_as_text':
 118             case 'reverse_years':
 119                 $$_key = (bool)$_value;
 120                 break;
 121
 122             default:
 123                 $smarty->trigger_error("[html_select_date] unknown parameter $_key", E_USER_WARNING);
 124
 125         }
 126     }
 127
 128     // If $time is not in format yyyy-mm-dd
 129     if (!preg_match('/^\d{0,4}-\d{0,2}-\d{0,2}$/', $time)) {
 130         // then $time is empty or unix timestamp or mysql timestamp
 131         // using smarty_make_timestamp to get an unix timestamp and
 132         // strftime to make yyyy-mm-dd
 133         $time = strftime('%Y-%m-%d', smarty_make_timestamp($time));
 134     }
 135     // Now split this in pieces, which later can be used to set the select
 136     $time = explode("-", $time);
 137     // make syntax "+N" or "-N" work with start_year and end_year
 138     if (preg_match('!^(\+|\-)\s*(\d+)$!', $end_year, $match)) {
 139         if ($match[1] == '+') {
 140             $end_year = strftime('%Y') + $match[2];
 141         } else {
 142             $end_year = strftime('%Y') - $match[2];
 143         }
 144     }
 145     if (preg_match('!^(\+|\-)\s*(\d+)$!', $start_year, $match)) {
 146         if ($match[1] == '+') {
 147             $start_year = strftime('%Y') + $match[2];
 148         } else {
 149             $start_year = strftime('%Y') - $match[2];
 150         }
 151     }
 152
 153     $field_order = strtoupper($field_order);
 154
 155     $html_result = $month_result = $day_result = $year_result = "";
 156
 157     if ($display_months) {
 158         $month_names = array();
 159         $month_values = array();
 160         if(isset($month_empty)) {
 161             $month_names[''] = $month_empty;
 162             $month_values[''] = '';
 163         }
 164         for ($i = 1; $i <= 12; $i++) {
 165             $month_names[$i] = xl( strftime($month_format, mktime(0, 0, 0, $i, 1, 2000)) );
 166             $month_values[$i] = strftime($month_value_format, mktime(0, 0, 0, $i, 1, 2000));
 167         }
 168
 169         $month_result .= '<select name=';
 170         if (null !== $field_array){
 171             $month_result .= '"' . $field_array . '[' . $prefix . 'Month]"';
 172         } else {
 173             $month_result .= '"' . $prefix . 'm"';
 174         }
 175         if (null !== $month_size){
 176             $month_result .= ' size="' . $month_size . '"';
 177         }
 178         if (null !== $month_extra){
 179             $month_result .= ' ' . $month_extra;
 180         }
 181         if (null !== $all_extra){
 182             $month_result .= ' ' . $all_extra;
 183         }
 184         $month_result .= '>'."\n";
 185
 186         $month_result .= smarty_function_html_options(array('output'     => $month_names,
 187                                                             'values'     => $month_values,
 188                                                             'selected'   => $month_values[(int)$time[1]],
 189                                                             'print_result' => false),
 190                                                       $smarty);
 191
 192         $month_result .= '</select>';
 193     }
 194
 195     if ($display_days) {
 196         $days = array();
 197         if (isset($day_empty)) {
 198             $days[''] = $day_empty;
 199             $day_values[''] = '';
 200         }
 201         for ($i = 1; $i <= 31; $i++) {
 202             $days[] = sprintf($day_format, $i);
 203             $day_values[] = sprintf($day_value_format, $i);
 204         }
 205
 206         $day_result .= '<select name=';
 207         if (null !== $field_array){
 208             $day_result .= '"' . $field_array . '[' . $prefix . 'Day]"';
 209         } else {
 210             $day_result .= '"' . $prefix . 'd"';
 211         }
 212         if (null !== $day_size){
 213             $day_result .= ' size="' . $day_size . '"';
 214         }
 215         if (null !== $all_extra){
 216             $day_result .= ' ' . $all_extra;
 217         }
 218         if (null !== $day_extra){
 219             $day_result .= ' ' . $day_extra;
 220         }
 221         $day_result .= '>'."\n";
 222         $day_result .= smarty_function_html_options(array('output'     => $days,
 223                                                           'values'     => $day_values,
 224                                                           'selected'   => $time[2],
 225                                                           'print_result' => false),
 226                                                     $smarty);
 227         $day_result .= '</select>';
 228     }
 229
 230     if ($display_years) {
 231         if (null !== $field_array){
 232             $year_name = $field_array . '[' . $prefix . 'Year]';
 233         } else {
 234             $year_name = $prefix . 'y';
 235         }
 236         if ($year_as_text) {
 237             $year_result .= '<input type="text" name="' . $year_name . '" value="' . $time[0] . '" size="4" maxlength="4"';
 238             if (null !== $all_extra){
 239                 $year_result .= ' ' . $all_extra;
 240             }
 241             if (null !== $year_extra){
 242                 $year_result .= ' ' . $year_extra;
 243             }
 244             $year_result .= '>';
 245         } else {
 246             $years = range((int)$start_year, (int)$end_year);
 247             if ($reverse_years) {
 248                 rsort($years, SORT_NUMERIC);
 249             }
 250             $yearvals = $years;
 251             if(isset($year_empty)) {
 252                 array_unshift($years, $year_empty);
 253                 array_unshift($yearvals, '');
 254             }
 255             $year_result .= '<select name="' . $year_name . '"';
 256             if (null !== $year_size){
 257                 $year_result .= ' size="' . $year_size . '"';
 258             }
 259             if (null !== $all_extra){
 260                 $year_result .= ' ' . $all_extra;
 261             }
 262             if (null !== $year_extra){
 263                 $year_result .= ' ' . $year_extra;
 264             }
 265             $year_result .= '>'."\n";
 266             $year_result .= smarty_function_html_options(array('output' => $years,
 267                                                                'values' => $yearvals,
 268                                                                'selected'   => $time[0],
 269                                                                'print_result' => false),
 270                                                          $smarty);
 271             $year_result .= '</select>';
 272         }
 273     }
 274
 275     // Loop thru the field_order field
 276     for ($i = 0; $i <= 2; $i++){
 277         $c = substr($field_order, $i, 1);
 278         switch ($c){
 279             case 'D':
 280                 $html_result .= $day_result;
 281                 break;
 282
 283             case 'M':
 284                 $html_result .= $month_result;
 285                 break;
 286
 287             case 'Y':
 288                 $html_result .= $year_result;
 289                 break;
 290         }
 291         // Add the field seperator
 292         if($i != 2) {
 293             $html_result .= $field_separator;
 294         }
 295     }
 296
 297     return $html_result;
 298 }
 299
 300 /* vim: set expandtab: */
 301
 302 ?>