| [ Index ] |
|
Code source de Symfony 1.0.0 |
[Code source] [Imprimer] [Statistiques]
DateFormHelper.
| Author: | Fabien Potencier <fabien.potencier@symfony-project.com> |
| Version: | SVN: $Id: DateFormHelper.php 3294 2007-01-16 06:53:15Z fabien $ |
| Poids: | 955 lignes (40 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
| select_day_tag($name, $value = null, $options = array() X-Ref |
| Returns a <select> tag populated with all the days of the month (1 - 31). By default, the <i>$value</i> parameter is set to today's day. To override this, simply pass an integer (1 - 31) to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. For convenience, symfony also offers the select_date_tag helper function which combines the select_year_tag, select_month_tag, and select_day_tag functions into a single helper. <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value. - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value. <b>Examples:</b> <code> echo submit_day_tag('day', 14); </code> param: string field name param: integer selected value (1 - 31) param: array additional HTML compliant <select> tag parameters return: string <select> tag populated with all the days of the month (1 - 31). |
| select_month_tag($name, $value = null, $options = array() X-Ref |
| Returns a <select> tag populated with all the months of the year (1 - 12). By default, the <i>$value</i> parameter is set to today's month. To override this, simply pass an integer (1 - 12) to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. Also, the each month's display title is set to return its respective full month name, which can be easily overridden by passing the 'use_short_names' or 'use_month_numbers' options to the <i>$options</i> parameter. For convenience, Symfony also offers the select_date_tag helper function which combines the select_year_tag, select_month_tag, and select_day_tag functions into a single helper. <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value - use_month_numbers - If set to true, will show the month's numerical value (1 - 12) instead of the months full name. - use_short_month - If set to true, will show the month's short name (i.e. Jan, Feb, Mar) instead of its full name. <b>Examples:</b> <code> echo submit_month_tag('month', 5, array('use_short_month' => true)); </code> <code> echo submit_month_tag('month', null, array('use_month_numbers' => true, 'include_blank' => true)); </code> param: string field name param: integer selected value (1 - 12) param: array additional HTML compliant <select> tag parameters return: string <select> tag populated with all the months of the year (1 - 12). |
| select_year_tag($name, $value = null, $options = array() X-Ref |
| Returns a <select> tag populated with a range of years. By default, the <i>$value</i> parameter is set to today's year. To override this, simply pass a four-digit integer (YYYY) to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. Also, the default selectable range of years is set to show five years back and five years forward from today's year. For instance, if today's year is 2006, the default 'year_start' option will be set to 2001 and the 'year_end' option will be set to 2011. These start and end dates can easily be overwritten by setting the 'year_start' and 'year_end' options in the <i>$options</i> parameter. For convenience, Symfony also offers the select_date_tag helper function which combines the select_year_tag, select_month_tag, and select_day_tag functions into a single helper. <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value - year_start - If set, the range of years will begin at this four-digit date (i.e. 1979) - year_end - If set, the range of years will end at this four-digit date (i.e. 2025) <b>Examples:</b> <code> echo submit_year_tag('year'); </code> <code> $year_start = date('Y', strtotime('-10 years')); $year_end = date('Y', strtotime('+10 years')); echo submit_year_tag('year', null, array('year_start' => $year_start, 'year_end' => $year_end)); </code> param: string field name param: integer selected value within the range of years. param: array additional HTML compliant <select> tag parameters return: string <select> tag populated with a range of years. |
| select_date_tag($name, $value = null, $options = array() X-Ref |
| Returns three <select> tags populated with a range of months, days, and years. By default, the <i>$value</i> parameter is set to today's month, day and year. To override this, simply pass a valid date or a correctly formatted date array (see example) to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. Also, the default selectable range of years is set to show five years back and five years forward from today's year. For instance, if today's year is 2006, the default 'year_start' option will be set to 2001 and the 'year_end' option will be set to 2011. These start and end dates can easily be overwritten by setting the 'year_start' and 'year_end' options in the <i>$options</i> parameter. <b>Note:</b> The <i>$name</i> parameter will automatically converted to array names. For example, a <i>$name</i> of "date" becomes: <samp> <select name="date[month]">...</select> <select name="date[day]">...</select> <select name="date[year]">...</select> </samp> <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value. - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value. - discard_month - If set to true, will only return select tags for day and year. - discard_day - If set to true, will only return select tags for month and year. - discard_year - If set to true, will only return select tags for month and day. - use_month_numbers - If set to true, will show the month's numerical value (1 - 12) instead of the months full name. - use_short_month - If set to true, will show the month's short name (i.e. Jan, Feb, Mar) instead of its full name. - year_start - If set, the range of years will begin at this four-digit date (i.e. 1979) - year_end - If set, the range of years will end at this four-digit date (i.e. 2025) - date_seperator - Includes a string of defined text between each generated select tag <b>Examples:</b> <code> echo submit_date_tag('date'); </code> <code> echo select_date_tag('date', '2006-10-30'); </code> <code> $date = array('year' => '1979', 'month' => 10, 'day' => 30); echo select_date_tag('date', $date, array('year_start' => $date['year'] - 10, 'year_end' => $date['year'] + 10)); </code> param: string field name (automatically becomes an array of parts: name[year], name[month], year[day]) param: mixed accepts a valid date string or properly formatted date array param: array additional HTML compliant <select> tag parameters return: string three <select> tags populated with a months, days and years |
| select_second_tag($name, $value = null, $options = array() X-Ref |
| Returns a <select> tag populated with 60 seconds (0 - 59). By default, the <i>$value</i> parameter is set to the current second (right now). To override this, simply pass an integer (0 - 59) to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. In many cases, you have no need for all 60 seconds in a minute. the 'second_step' option in the <i>$options</i> parameter gives you the ability to define intervals to display. So for instance you could define 15 as your 'minute_step' interval and the select tag would return the values 0, 15, 30, and 45. For convenience, Symfony also offers the select_time_tag select_datetime_tag helper functions which combine other date and time helpers to easily build date and time select boxes. <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value. - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value. - second_step - If set, the seconds will be incremented in blocks of X, where X = 'second_step' <b>Examples:</b> <code> echo submit_second_tag('second'); </code> <code> echo submit_second_tag('second', 15, array('second_step' => 15)); </code> param: string field name param: integer selected value (0 - 59) param: array additional HTML compliant <select> tag parameters return: string <select> tag populated with 60 seconds (0 - 59). |
| select_minute_tag($name, $value = null, $options = array() X-Ref |
| Returns a <select> tag populated with 60 minutes (0 - 59). By default, the <i>$value</i> parameter is set to the current minute. To override this, simply pass an integer (0 - 59) to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. In many cases, you have no need for all 60 minutes in an hour. the 'minute_step' option in the <i>$options</i> parameter gives you the ability to define intervals to display. So for instance you could define 15 as your 'minute_step' interval and the select tag would return the values 0, 15, 30, and 45. For convenience, Symfony also offers the select_time_tag select_datetime_tag helper functions which combine other date and time helpers to easily build date and time select boxes. <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value. - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value. - minute_step - If set, the minutes will be incremented in blocks of X, where X = 'minute_step' <b>Examples:</b> <code> echo submit_minute_tag('minute'); </code> <code> echo submit_minute_tag('minute', 15, array('minute_step' => 15)); </code> param: string field name param: integer selected value (0 - 59) param: array additional HTML compliant <select> tag parameters return: string <select> tag populated with 60 minutes (0 - 59). |
| select_hour_tag($name, $value = null, $options = array() X-Ref |
| Returns a <select> tag populated with 24 hours (0 - 23), or optionally 12 hours (1 - 12). By default, the <i>$value</i> parameter is set to the current hour. To override this, simply pass an integer (0 - 23 or 1 - 12 if '12hour_time' = true) to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. For convenience, Symfony also offers the select_time_tag select_datetime_tag helper functions which combine other date and time helpers to easily build date and time select boxes. <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value. - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value. - 12hour_time - If set to true, will return integers 1 through 12 instead of the default 0 through 23 as well as an AM/PM select box. <b>Examples:</b> <code> echo submit_hour_tag('hour'); </code> <code> echo submit_hour_tag('hour', 6, array('12hour_time' => true)); </code> param: string field name param: integer selected value (0 - 23 or 1 - 12 if '12hour_time' = true) param: array additional HTML compliant <select> tag parameters return: string <select> tag populated with 24 hours (0 - 23), or optionally 12 hours (1 - 12). |
| select_ampm_tag($name, $value = null, $options = array() X-Ref |
| Returns a <select> tag populated with AM and PM options for use with 12-Hour time. By default, the <i>$value</i> parameter is set to the correct AM/PM setting based on the current time. To override this, simply pass either AM or PM to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. For convenience, Symfony also offers the select_time_tag select_datetime_tag helper functions which combine other date and time helpers to easily build date and time select boxes. <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value. - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value. <b>Examples:</b> <code> echo submit_ampm_tag('ampm'); </code> <code> echo submit_ampm_tag('ampm', 'PM', array('include_blank' => true)); </code> param: string field name param: integer selected value (AM or PM) param: array additional HTML compliant <select> tag parameters return: string <select> tag populated with AM and PM options for use with 12-Hour time. |
| select_time_tag($name, $value = null, $options = array() X-Ref |
| Returns three <select> tags populated with hours, minutes, and optionally seconds. By default, the <i>$value</i> parameter is set to the current hour and minute. To override this, simply pass a valid time or a correctly formatted time array (see example) to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. To include seconds to the result, use set the 'include_second' option in the <i>$options</i> parameter to true. <b>Note:</b> The <i>$name</i> parameter will automatically converted to array names. For example, a <i>$name</i> of "time" becomes: <samp> <select name="time[hour]">...</select> <select name="time[minute]">...</select> <select name="time[second]">...</select> </samp> <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value. - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value. - include_second - If set to true, includes the "seconds" select tag as part of the result. - second_step - If set, the seconds will be incremented in blocks of X, where X = 'second_step' - minute_step - If set, the minutes will be incremented in blocks of X, where X = 'minute_step' - 12hour_time - If set to true, will return integers 1 through 12 instead of the default 0 through 23 as well as an AM/PM select box. - time_seperator - Includes a string of defined text between each generated select tag - ampm_seperator - Includes a string of defined text between the minute/second select box and the AM/PM select box <b>Examples:</b> <code> echo submit_time_tag('time'); </code> <code> echo select_time_tag('date', '09:31'); </code> <code> $time = array('hour' => '15', 'minute' => 46, 'second' => 01); echo select_time_tag('time', $time, array('include_second' => true, '12hour_time' => true)); </code> param: string field name (automatically becomes an array of parts: name[hour], name[minute], year[second]) param: mixed accepts a valid time string or properly formatted time array param: array additional HTML compliant <select> tag parameters return: string three <select> tags populated with a hours, minutes and optionally seconds. |
| select_datetime_tag($name, $value = null, $options = array() X-Ref |
| Returns a variable number of <select> tags populated with date and time related select boxes. The select_datetime_tag is the culmination of both the select_date_tag and the select_time_tag. By default, the <i>$value</i> parameter is set to the current date and time. To override this, simply pass a valid date, time, datetime string or correctly formatted array (see example) to the <i>$value</i> parameter. You can also set the <i>$value</i> parameter to null which will disable the <i>$value</i>, however this will only be useful if you pass 'include_blank' or 'include_custom' to the <i>$options</i> parameter. To include seconds to the result, use set the 'include_second' option in the <i>$options</i> parameter to true. <b>Note:</b> The <i>$name</i> parameter will automatically converted to array names. For example, a <i>$name</i> of "datetime" becomes: <samp> <select name="datetime[month]">...</select> <select name="datetime[day]">...</select> <select name="datetime[year]">...</select> <select name="datetime[hour]">...</select> <select name="datetime[minute]">...</select> <select name="datetime[second]">...</select> </samp> <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value. - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value. - include_second - If set to true, includes the "seconds" select tag as part of the result. - discard_month - If set to true, will only return select tags for day and year. - discard_day - If set to true, will only return select tags for month and year. - discard_year - If set to true, will only return select tags for month and day. - use_month_numbers - If set to true, will show the month's numerical value (1 - 12) instead of the months full name. - use_short_month - If set to true, will show the month's short name (i.e. Jan, Feb, Mar) instead of its full name. - year_start - If set, the range of years will begin at this four-digit date (i.e. 1979) - year_end - If set, the range of years will end at this four-digit date (i.e. 2025) - second_step - If set, the seconds will be incremented in blocks of X, where X = 'second_step' - minute_step - If set, the minutes will be incremented in blocks of X, where X = 'minute_step' - 12hour_time - If set to true, will return integers 1 through 12 instead of the default 0 through 23. - date_seperator - Includes a string of defined text between each generated select tag - time_seperator - Includes a string of defined text between each generated select tag - ampm_seperator - Includes a string of defined text between the minute/second select box and the AM/PM select box <b>Examples:</b> <code> echo submit_datetime_tag('datetime'); </code> <code> echo select_datetime_tag('datetime', '1979-10-30'); </code> <code> $datetime = array('year' => '1979', 'month' => 10, 'day' => 30, 'hour' => '15', 'minute' => 46); echo select_datetime_tag('time', $datetime, array('use_short_month' => true, '12hour_time' => true)); </code> param: string field name (automatically becomes an array of date and time parts) param: mixed accepts a valid time string or properly formatted time array param: array additional HTML compliant <select> tag parameters return: string a variable number of <select> tags populated with date and time related select boxes |
| select_number_tag($name, $value, $options = array() X-Ref |
| Returns a <select> tag, populated with a range of numbers By default, the select_number_tag generates a list of numbers from 1 - 10, with an incremental value of 1. These values can be easily changed by passing one or several <i>$options</i>. Numbers can be either positive or negative, integers or decimals, and can be incremented by any number, decimal or integer. If you require the range of numbers to be listed in descending order, pass the 'reverse' option to easily display the list of numbers in the opposite direction. <b>Options:</b> - include_blank - Includes a blank <option> tag at the beginning of the string with an empty value. - include_custom - Includes an <option> tag with a custom display title at the beginning of the string with an empty value. - multiple - If set to true, the select tag will allow multiple numbers to be selected at once. - start - The first number in the list. If not specified, the default value is 1. - end - The last number in the list. If not specified, the default value is 10. - increment - The number by which to increase each number in the list by until the number is greater than or equal to the 'end' option. If not specified, the default value is 1. - reverse - Reverses the order of numbers so they are display in descending order <b>Examples:</b> <code> echo select_number_tag('rating', '', array('reverse' => true)); </code> <code> echo echo select_number_tag('tax_rate', '0.07', array('start' => '0.05', 'end' => '0.09', 'increment' => '0.01')); </code> <code> echo select_number_tag('limit', 5, array('start' => 5, 'end' => 120, 'increment' => 15)); </code> param: string field name param: string the selected option param: array <i>$options</i> to manipulate the output of the tag. param: array additional HTML compliant <select> tag parameters return: string <select> tag populated with a range of numbers. |
| select_timezone_tag($name, $selected = null, $options = array() X-Ref |
| Returns a <select> tag populated with all the timezones in the world. The select_timezone_tag builds off the traditional select_tag function, and is conveniently populated with all the timezones in the world (sorted alphabetically). Each option in the list has a unique timezone identifier for its value and the timezone's locale as its display title. The timezone data is retrieved via the sfCultureInfo class, which stores a wide variety of i18n and i10n settings for various countries and cultures throughout the world. Here's an example of an <option> tag generated by the select_timezone_tag: <b>Options:</b> - display - identifer - Display the PHP timezone identifier (e.g. America/Denver) timezone - Display the full timezone name (e.g. Mountain Standard Time) timezone_abbr - Display the timezone abbreviation (e.g. MST) timzone_dst - Display the full timezone name with daylight savings time (e.g. Mountain Daylight Time) timezone_dst_abbr - Display the timezone abbreviation with daylight savings time (e.g. MDT) city - Display the city/region that relates to the timezone (e.g. Denver) <samp> <option value="America/Denver">America/Denver</option> </samp> <b>Examples:</b> <code> echo select_timezone_tag('timezone', 'America/Denver'); </code> param: string field name param: string selected field value (timezone identifier) param: array additional HTML compliant <select> tag parameters return: string <select> tag populated with all the timezones in the world. |
| _parse_value_for_date($value, $key, $format_char) X-Ref |
| Converts date values (<i>$value</i>) into its correct date format (<i>$format_char</i>) This function is primarily used in select_date_tag, select_time_tag and select_datetime_tag. <b>Note:</b> If <i>$value</i> is empty, it will be populated with the current date and time. param: string date or date part param: string custom key for array values return: string properly formatted date part value. |
| _get_I18n_date_locales($culture = null) X-Ref |
| Retrieves the proper date format based on the specified <i>$culture</i> setting <b>Note:</b> If no <i>$culture</i> is defined, the user's culture setting will be used in its place. param: string two or three character culture setting variable return: string formatted date/time format based on the specified date/time setting |
| Généré le : Fri Mar 16 22:42:14 2007 | par Balluche grâce à PHPXref 0.7 |