Zend_Locale_Format
provides several methods for working with dates and times to help convert and
normalize between different formats for different locales. Use Zend_Date
for manipulating dates,
and working with date strings that already conform to
one of the many internationally recognized standard formats, or one of the localized date formats supported by Zend_Date
. Using an existing, pre-defined format offers advantages, including the use of well-tested code, and the
assurance of some degree of portability and interoperability (depending on the standard used). The examples
below do not follow these recommendations, since using non-standard date formats would needlessly increase the
difficulty of understanding these examples.
The getDate()
method parses strings containing dates in localized formats. The results are
returned in a structured array, with well-defined keys for each part of the date. In addition, the array
will contain a key 'date_format' showing the format string used to parse the input date string. Since a
localized date string may not contain all parts of a date/time, the key-value pairs are optional. For
example, if only the year, month, and day is given, then all time values are supressed from the returned
array, and vice-versa if only hour, minute, and second were given as input. If no date or time can be found
within the given input, an exception will be thrown.
If setOption('fix_date' => true)
is set the getDate()
method adds a key 'fixed'
with a whole number value indicating if the input date string required "fixing" by rearranging the day,
month, or year in the input to fit the format used.
جدول 18.4. Key values for getDate() with option 'fix_date'
value | meaning | ||
---|---|---|---|
0 | nothing to fix | ||
1 | fixed false month | ||
2 | swapped day and year | ||
3 | swapped month and year | ||
4 | swapped month and day |
For those needing to specify explicitly the format of the date string, the following format token specifiers are supported. If an invalid format specifier is used, such as the PHP 'i' specifier when in ISO format mode, then an error will be thrown by the methods in Zend_Locale_Format that support user-defined formats.
These specifiers (below) are a small subset of the full "ISO" set supported by Zend_Date's
toString()
. If you need to use PHP date()
compatible format specifiers, then first
call setOptions('format_type' => 'php')
. And if you want to convert only one special format
string from PHP date()
compatible format to "ISO" format use convertPhpToIsoFormat()
.
Currently, the only practical difference relates to the specifier for minutes ('m' using the ISO default,
and 'i' using the PHP date format).
جدول 18.5. Return values
getDate() format character | Array key | Returned value | Minimum | Maximum |
---|---|---|---|---|
d | day | integer | 1 | 31 |
M | month | integer | 1 | 12 |
y | year | integer | no limit | PHP integer's maximum |
h | hour | integer | 0 | PHP integer's maximum |
m | minute | integer | 0 | PHP integer's maximum |
s | second | integer | 0 | PHP integer's maximum |
مثال 18.32. Normalizing a date
<?php require_once 'Zend/Locale.php'; $dateString = Zend_Locale_Format::getDate('13.04.2006', array('date_format' => 'dd.MM.yyyy')); $dateObject = Zend_Date('13.04.2006', array('date_format' => 'dd.MM.yyyy')); // creates a Zend_Date object for this date print_r($dateString); // outputs: Array ( [format] => dd.MM.yyyy [day] => 13 [month] => 4 [year] => 2006 ) // alternatively, some types of problems with input data can be automatically corrected $date2 = Zend_Locale_Format::getDate('04.13.2006', array('date_format' => 'dd.MM.yyyy', 'fix_date' => true)); print_r($date); // outputs: Array ( [format] => dd.MM.yyyy [day] => 13 [month] => 4 [year] => 2006 [fixed] => 4 ) ?>
Since getDate()
is "locale-aware", specifying the $locale
is sufficient for date
strings adhering to that locale's format. The option 'fix_date
' uses simple tests to
determine if the day or month is not valid, and then applies heuristics to try and correct any detected
problems. Note the use of 'Zend_Locale_Format::STANDARD
' as the value for
'date_format
' to prevent the use of a class-wide default date format set using
setOptions()
. This forces getDate to use the default date format for $locale
.
مثال 18.33. Normalizing a date by locale
<?php require_once 'Zend/Locale.php'; $locale = new Zend_Locale('de_AT'); $date = Zend_Locale_Format::getDate('13.04.2006', array('date_format' => Zend_Locale_Format::STANDARD, 'locale' => $locale)); print_r ($date); ?>
A complete date and time is returned when the input contains both a date and time in the expected format.
مثال 18.34. Normalizing a date with time
<?php require_once 'Zend/Locale.php'; $locale = new Zend_Locale('de_AT'); $date = Zend_Locale_Format::getDate('13.04.2005 22:14:55', array('date_format' => Zend_Locale_Format::STANDARD, 'locale' => $locale); print_r ($date); ?>
If a specific format is desired, specify the $format
argument, without giving a
$locale
. Only single-letter codes (H, m, s, y, M, d), and MMMM and EEEE are supported in the
$format
.
مثال 18.35. Normalizing a userdefined date
<?php require_once 'Zend/Locale.php'; $date = Zend_Locale_Format::getDate('13200504T551422', array('date_format' => 'ddyyyyMM ssmmHH'); print_r ($date); ?>
The format can include the following signs :
جدول 18.6. Format definition
Format Letter | Description |
---|---|
d or dd | 1 or 2 digit day |
M or MM | 1 or 2 digit month |
y or yy | 1 or 2 digit year |
yyyy | 4 digit year |
h | 1 or 2 digit hour |
m | 1 or 2 digit minute |
s | 1 or 2 digit second |
Examples for proper formats are
جدول 18.7. Example formats
Formats | Input | Output |
---|---|---|
dd.MM.yy | 1.4.6 | ['day'] => 1, ['month'] => 4, ['year'] => 6 |
dd.MM.yy | 01.04.2006 | ['day'] => 1, ['month'] => 4, ['year'] => 2006 |
yyyyMMdd | 1.4.6 | ['day'] => 6, ['month'] => 4, ['year'] => 1 |
Database date format | |
---|---|
To parse a database date value (f.e. MySql or MsSql), use Zend_Date's ISO_8601 format instead of getDate(). |
The option 'fix_date
' uses simple tests to determine if the day or month is not
valid, and then applies heuristics to try and correct any detected problems. getDate()
automatically detects and corrects some kinds of problems with input, such as misplacing the year:
Use checkDateFormat($inputString, array('date_format' => $format, $locale))
to check if a given string
contains all expected date parts. The checkDateFormat()
method uses getDate()
, but without
the option 'fixdate'
to avoid returning true when the input fails to conform to the date
format. If errors are detected in the input, such as swapped values for months and days, the
option 'fixdate'
method will apply heuristics to "correct" dates before determining their
validity.
مثال 18.37. Date testing
<?php require_once 'Zend/Locale.php'; $locale = new Zend_Locale('de_AT'); // using the default date format for 'de_AT', is this a valid date? if (Zend_Locale_Format::checkDateFormat('13.Apr.2006', array('date_format' => Zend_Locale_Format::STANDARD, $locale)) { print "date"; } else { print "not a date"; } ?>
Normally, a time will be returned with a date, if the input contains both. If the proper format is not
known, but the locale relevant to the user input is known, then getTime()
should be used,
because it uses the default time format for the selected locale.
Use checkDateFormat()
to check if a given string contains a proper time.
The useage is exact the same as with checking Dates, only date_format
should contain the parts which you expect to have.