diff --git a/reference/intl/book.xml b/reference/intl/book.xml index 6560d892f6..f073e78830 100755 --- a/reference/intl/book.xml +++ b/reference/intl/book.xml @@ -1,5 +1,5 @@ - + Internationalization Functions @@ -229,6 +229,7 @@ echo $formatter->format(1234567); &reference.intl.locale; &reference.intl.normalizer; &reference.intl.messageformatter; + diff --git a/reference/intl/dateformatter-constants.xml b/reference/intl/dateformatter-constants.xml new file mode 100644 index 0000000000..3a3808a448 --- /dev/null +++ b/reference/intl/dateformatter-constants.xml @@ -0,0 +1,96 @@ + + +
+&reftitle.constants; + + +TODO + + + + DateFormatter::NONE + (string) + + + TODO + + + + + DateFormatter::FULL + (string) + + + TODO + + + + + DateFormatter::LONG + (string) + + + TODO + + + + + DateFormatter::MEDIUM + (string) + + + TODO + + + + + DateFormatter::SHORT + (string) + + + TODO + + + + + DateFormatter::TRADITIONAL + (string) + + + TODO + + + + + DateFormatter::GREGORIAN + (string) + + + TODO + + + + +
+ + + \ No newline at end of file diff --git a/reference/intl/dateformatter.xml b/reference/intl/dateformatter.xml new file mode 100644 index 0000000000..d01fd5a1f4 --- /dev/null +++ b/reference/intl/dateformatter.xml @@ -0,0 +1,63 @@ + + + + The DateFormatter class + DateFormatter + + + + +
+ &reftitle.intro; + + TODO + +
+ + +
+ Class synopsis + + + + + DateFormatter + + + Methods + + + + + +
+ + &reference.intl.dateformatter-constants; + + + &reference.intl.entities.dateformatter; + + + + \ No newline at end of file diff --git a/reference/intl/dateformatter/create.xml b/reference/intl/dateformatter/create.xml new file mode 100644 index 0000000000..cd0487da8b --- /dev/null +++ b/reference/intl/dateformatter/create.xml @@ -0,0 +1,164 @@ + + + + + DateFormatter::create + datefmt_create + Create a date formatter + + + &reftitle.description; + Object oriented style + + static + DateFormatterDateFormatter::create + stringlocale + integerdatetype + integertimetype + stringtimezone + integercalendar + stringpattern + + Object oriented style (constructor) + + DateFormatter + + __construct + stringlocale + integerdatetype + integertimetype + stringtimezone + integercalendar + stringpattern + + + Procedural style + + DateFormatterdatefmt_create + stringlocale + integerdatetype + integertimetype + stringtimezone + integercalendar + stringpattern + + + Create a date formatter +GREGORIAN + + + + &reftitle.parameters; + + + + locale + + + Locale to use when formatting or parsing + + + + datetype + + + Date type to use (none, short, medium, long, full) + + + + timetype + + + Time type to use (none, short, medium, long, full) + + + + timezone + + + Time zone ID ; default is system default + + + + calendar + + + Calendar to use for formatting or parsing; default is + + + + pattern + + + Optional pattern to use when formatting or parsing + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + <function>datefmt_create</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/format.xml b/reference/intl/dateformatter/format.xml new file mode 100644 index 0000000000..3c85805c3b --- /dev/null +++ b/reference/intl/dateformatter/format.xml @@ -0,0 +1,117 @@ + + + + + DateFormatter::format + datefmt_format + formats the time value as a string. + + + &reftitle.description; + Object oriented style + + DateFormatter + + stringformat + mixedvalue + + + Procedural style + + stringdatefmt_format + DateFormatterfmt + mixedvalue + + + formats the time value as a string. +integer: a unix timestamp value (seconds since epoch, UTC) +array: a localtime array + + + + &reftitle.parameters; + + + + fmt + + + The date formatter resource + + + + value + + + - value to format + + + + + + + + + &reftitle.returnvalues; + + a formatted string or, if an error occurred, 'null'. + + + + &reftitle.examples; + + <function>datefmt_format</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/get-calendar.xml b/reference/intl/dateformatter/get-calendar.xml new file mode 100644 index 0000000000..1674bfc367 --- /dev/null +++ b/reference/intl/dateformatter/get-calendar.xml @@ -0,0 +1,107 @@ + + + + + DateFormatter::getCalendar + datefmt_get_calendar + + + + &reftitle.description; + Object oriented style + + DateFormatter + + integergetCalendar + + + + Procedural style + + integerdatefmt_get_calendar + DateFormatterfmt + + + + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + + + + + + &reftitle.returnvalues; + + the calendar being used by the formatter + + + + &reftitle.examples; + + <function>datefmt_get_calendar</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/get-datetype.xml b/reference/intl/dateformatter/get-datetype.xml new file mode 100644 index 0000000000..8cb8c72a71 --- /dev/null +++ b/reference/intl/dateformatter/get-datetype.xml @@ -0,0 +1,107 @@ + + + + + DateFormatter::getDateType + datefmt_get_datetype + + + + &reftitle.description; + Object oriented style + + DateFormatter + + integergetDateType + + + + Procedural style + + integerdatefmt_get_datetype + DateFormatterfmt + + + + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + + + + + + &reftitle.returnvalues; + + the current 'datetype' value of the formatter + + + + &reftitle.examples; + + <function>datefmt_get_datetype</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/get-error-code.xml b/reference/intl/dateformatter/get-error-code.xml new file mode 100644 index 0000000000..3630abf55f --- /dev/null +++ b/reference/intl/dateformatter/get-error-code.xml @@ -0,0 +1,108 @@ + + + + + DateFormatter::getErrorCode + datefmt_get_error_code + Get the error code from last operation + + + &reftitle.description; + Object oriented style + + DateFormatter + + integergetErrorCode + + + + Procedural style + + integerdatefmt_get_error_code + DateFormatterfmt + + + Get the error code from last operation +Returns error code from the last number formatting operation. + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + + + + + + &reftitle.returnvalues; + + the error code, one of UErrorCode values. Initial value is U_ZERO_ERROR. + + + + &reftitle.examples; + + <function>datefmt_get_error_code</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/get-error-message.xml b/reference/intl/dateformatter/get-error-message.xml new file mode 100644 index 0000000000..00e05307af --- /dev/null +++ b/reference/intl/dateformatter/get-error-message.xml @@ -0,0 +1,107 @@ + + + + + DateFormatter::getErrorMessage + datefmt_get_error_message + Get the error text from the last operation. + + + &reftitle.description; + Object oriented style + + DateFormatter + + stringgetErrorMessage + + + + Procedural style + + stringdatefmt_get_error_message + DateFormatterfmt + + + Get the error text from the last operation. + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + + + + + + &reftitle.returnvalues; + + Description of the last error. + + + + &reftitle.examples; + + <function>datefmt_get_error_message</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/get-locale.xml b/reference/intl/dateformatter/get-locale.xml new file mode 100644 index 0000000000..aa92ab9a5d --- /dev/null +++ b/reference/intl/dateformatter/get-locale.xml @@ -0,0 +1,117 @@ + + + + + DateFormatter::getLocale + datefmt_get_locale + values may include ULOC_ACTUAL_LOCALE, + + + &reftitle.description; + Object oriented style + + DateFormatter + + stringgetLocale + integerhich + + + Procedural style + + stringdatefmt_get_locale + DateFormatterfmt + integerhich + + + values may include ULOC_ACTUAL_LOCALE, +ULOC_VALID_LOCALE. By default the actual +locale is returned. + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + hich + + + locale should be returned? + + + + + + + + + &reftitle.returnvalues; + + the locale of this formatter or 'false' if error + + + + &reftitle.examples; + + <function>datefmt_get_locale</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/get-pattern.xml b/reference/intl/dateformatter/get-pattern.xml new file mode 100644 index 0000000000..fb0b0cb6b9 --- /dev/null +++ b/reference/intl/dateformatter/get-pattern.xml @@ -0,0 +1,107 @@ + + + + + DateFormatter::getPattern + datefmt_get_pattern + + + + &reftitle.description; + Object oriented style + + DateFormatter + + stringgetPattern + + + + Procedural style + + stringdatefmt_get_pattern + DateFormatterfmt + + + + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + + + + + + &reftitle.returnvalues; + + the pattern string being used to format/parse + + + + &reftitle.examples; + + <function>datefmt_get_pattern</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/get-timetype.xml b/reference/intl/dateformatter/get-timetype.xml new file mode 100644 index 0000000000..4c492fd135 --- /dev/null +++ b/reference/intl/dateformatter/get-timetype.xml @@ -0,0 +1,107 @@ + + + + + DateFormatter::getTimeType + datefmt_get_timetype + + + + &reftitle.description; + Object oriented style + + DateFormatter + + integergetTimeType + + + + Procedural style + + integerdatefmt_get_timetype + DateFormatterfmt + + + + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + + + + + + &reftitle.returnvalues; + + the current 'timetype' value of the formatter + + + + &reftitle.examples; + + <function>datefmt_get_timetype</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/get-timezone-id.xml b/reference/intl/dateformatter/get-timezone-id.xml new file mode 100644 index 0000000000..8efd3b28ba --- /dev/null +++ b/reference/intl/dateformatter/get-timezone-id.xml @@ -0,0 +1,107 @@ + + + + + DateFormatter::getTimeZoneId + datefmt_get_timezone_id + + + + &reftitle.description; + Object oriented style + + DateFormatter + + stringgetTimeZoneId + + + + Procedural style + + stringdatefmt_get_timezone_id + DateFormatterfmt + + + + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + + + + + + &reftitle.returnvalues; + + ID string for the time zone used by this formatter + + + + &reftitle.examples; + + <function>datefmt_get_timezone_id</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/is-lenient.xml b/reference/intl/dateformatter/is-lenient.xml new file mode 100644 index 0000000000..fea89aff17 --- /dev/null +++ b/reference/intl/dateformatter/is-lenient.xml @@ -0,0 +1,107 @@ + + + + + DateFormatter::isLenient + datefmt_is_lenient + + + + &reftitle.description; + Object oriented style + + DateFormatter + + booleanisLenient + + + + Procedural style + + booleandatefmt_is_lenient + DateFormatterfmt + + + + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + + + + + + &reftitle.returnvalues; + + 'true' if parser is lenient, 'false' if parser is strictdefault value for parser is 'false'. + + + + &reftitle.examples; + + <function>datefmt_is_lenient</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/localtime.xml b/reference/intl/dateformatter/localtime.xml new file mode 100644 index 0000000000..13d535814a --- /dev/null +++ b/reference/intl/dateformatter/localtime.xml @@ -0,0 +1,150 @@ + + + + + DateFormatter::localtime + datefmt_localtime + converts string $value to a field-based time value, starting at + + + &reftitle.description; + Object oriented style + + DateFormatter + + arraylocaltime + stringvalue + arraylocaltime + integerparse_pos + integererror + + + Procedural style + + arraydatefmt_localtime + DateFormatterfmt + stringvalue + arraylocaltime + integerparse_pos + integererror + + + converts string $value to a field-based time value, starting at +$parse_pos and consuming as much of the input value as possible +If no error occurs before $value is consumed, $parse_pos will contain -1 +otherwise it will contain the position at which parsing ended (and the error +occurred). $error will contain the error code. Note that this function +does not change the value in get_error(). +be overwritten! +This variable will contain the end position if the parse fails +If $parse_pos > strlen($value), the parse fails immediately. + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + value + + + string to convert to a time + + + + localtime + + + the array to store the parsed value; values in this array will + + + + parse_pos + + + position at which to start the parsing in $value (zero-based) + + + + error + + + error value of any error that occurs during parsing + + + + + + + + + &reftitle.returnvalues; + + localtime compatible array of integers + + + + &reftitle.examples; + + <function>datefmt_localtime</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/parse-to-localtime.xml b/reference/intl/dateformatter/parse-to-localtime.xml new file mode 100644 index 0000000000..0b96d1777a --- /dev/null +++ b/reference/intl/dateformatter/parse-to-localtime.xml @@ -0,0 +1,115 @@ + + + + + DateFormatter::parseToLocaltime + datefmt_parse_to_localtime + Field-based equivalent of parse(). + + + &reftitle.description; + Object oriented style + + DateFormatter + + arrayparseToLocaltime + stringvalue + + + Procedural style + + arraydatefmt_parse_to_localtime + DateFormatterfmt + stringvalue + + + Field-based equivalent of parse(). + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + value + + + String value to parse into a date. + + + + + + + + + &reftitle.returnvalues; + + An array in the same format as localtime produces + + + + &reftitle.examples; + + <function>datefmt_parse_to_localtime</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/parse-to-timestamp.xml b/reference/intl/dateformatter/parse-to-timestamp.xml new file mode 100644 index 0000000000..0c9f0db0d3 --- /dev/null +++ b/reference/intl/dateformatter/parse-to-timestamp.xml @@ -0,0 +1,116 @@ + + + + + DateFormatter::parseToTimestamp + datefmt_parse_to_timestamp + converts the string $value to a Unix timestamp (a time_t integer + + + &reftitle.description; + Object oriented style + + DateFormatter + + integerparseToTimestamp + stringvalue + + + Procedural style + + integerdatefmt_parse_to_timestamp + DateFormatterfmt + stringvalue + + + converts the string $value to a Unix timestamp (a time_t integer +value, seconds since epoch). + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + value + + + string to convert to a time + + + + + + + + + &reftitle.returnvalues; + + timestamp value + + + + &reftitle.examples; + + <function>datefmt_parse_to_timestamp</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/parse.xml b/reference/intl/dateformatter/parse.xml new file mode 100644 index 0000000000..91651487f1 --- /dev/null +++ b/reference/intl/dateformatter/parse.xml @@ -0,0 +1,140 @@ + + + + + DateFormatter::parse + datefmt_parse + converts string $value to an incremental time value, starting at + + + &reftitle.description; + Object oriented style + + DateFormatter + + integerparse + stringvalue + integerparse_pos + integererror + + + Procedural style + + integerdatefmt_parse + DateFormatterfmt + stringvalue + integerparse_pos + integererror + + + converts string $value to an incremental time value, starting at +$parse_pos and consuming as much of the input value as possible +If no error occurs before $value is consumed, $parse_pos will contain -1 +otherwise it will contain the position at which parsing ended (and the error +occurred). $error will contain the error code. Note that this function +does not change the value in get_error(). +This variable will contain the end position if the parse fails +If $parse_pos > strlen($value), the parse fails immediately. + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + value + + + string to convert to a time + + + + parse_pos + + + position at which to start the parsing in $value (zero-based) + + + + error + + + error value of any error that occurs during parsing + + + + + + + + + &reftitle.returnvalues; + + timestamp parsed value + + + + &reftitle.examples; + + <function>datefmt_parse</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/set-calendar.xml b/reference/intl/dateformatter/set-calendar.xml new file mode 100644 index 0000000000..6e0708e443 --- /dev/null +++ b/reference/intl/dateformatter/set-calendar.xml @@ -0,0 +1,119 @@ + + + + + DateFormatter::setCalendar + datefmt_set_calendar + sets the calendar used to the appropriate calendar, which must be + + + &reftitle.description; + Object oriented style + + DateFormatter + + booleansetCalendar + integerwhich + + + Procedural style + + booleandatefmt_set_calendar + DateFormatterfmt + integerwhich + + + sets the calendar used to the appropriate calendar, which must be +one of the constants defined above. Some examples include: +- Gregorian calendar +- Traditional +Default value is GREGORIAN + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + which + + + the calendar (an enumerated constant) to use. + + + + + + + + + &reftitle.returnvalues; + + 'true' if successful, 'false' if an error occurred or if the calendar was not recognized + + + + &reftitle.examples; + + <function>datefmt_set_calendar</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/set-lenient.xml b/reference/intl/dateformatter/set-lenient.xml new file mode 100644 index 0000000000..e753c63229 --- /dev/null +++ b/reference/intl/dateformatter/set-lenient.xml @@ -0,0 +1,119 @@ + + + + + DateFormatter::setLenient + datefmt_set_lenient + 'true' sets the parser to accept otherwise flawed date or + + + &reftitle.description; + Object oriented style + + DateFormatter + + booleansetLenient + booleanlenient + + + Procedural style + + booleandatefmt_set_lenient + DateFormatterfmt + booleanlenient + + + 'true' sets the parser to accept otherwise flawed date or +time patterns, parsing as much as possible to obtain a value. +'false' sets the parser to strictly parse strings into dates. +Extra space, unrecognized tokens, or invalid values +("Feburary 30th") are not accepted. + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + lenient + + + sets whether the parser is lenient or not, default is 'false' + + + + + + + + + &reftitle.returnvalues; + + 'true' if successful; 'false' if an error occurred. + + + + &reftitle.examples; + + <function>datefmt_set_lenient</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/set-pattern.xml b/reference/intl/dateformatter/set-pattern.xml new file mode 100644 index 0000000000..41d0d760de --- /dev/null +++ b/reference/intl/dateformatter/set-pattern.xml @@ -0,0 +1,115 @@ + + + + + DateFormatter::setPattern + datefmt_set_pattern + + + + &reftitle.description; + Object oriented style + + DateFormatter + + booleansetPattern + stringpattern + + + Procedural style + + booleandatefmt_set_pattern + DateFormatterfmt + stringpattern + + + + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + pattern + + + new pattern string to use + + + + + + + + + &reftitle.returnvalues; + + 'true' if successful, 'false' if an error occured. Bad formatstrings are usually the cause of the latter. + + + + &reftitle.examples; + + <function>datefmt_set_pattern</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + + diff --git a/reference/intl/dateformatter/set-timezone-id.xml b/reference/intl/dateformatter/set-timezone-id.xml new file mode 100644 index 0000000000..77854b344c --- /dev/null +++ b/reference/intl/dateformatter/set-timezone-id.xml @@ -0,0 +1,117 @@ + + + + + DateFormatter::setTimeZoneId + datefmt_set_timezone_id + sets the time zone to use + + + &reftitle.description; + Object oriented style + + DateFormatter + + booleansetTimeZoneId + stringzone + + + Procedural style + + booleandatefmt_set_timezone_id + DateFormatterfmt + stringzone + + + sets the time zone to use +if null or the empty string, the default time zone for +the runtime is used. + + + + &reftitle.parameters; + + + + fmt + + + The formatter resource + + + + zone + + + zone ID string of the time zone to use. + + + + + + + + + &reftitle.returnvalues; + + 'true' on successful setting of the time zone, 'false'if an error occurred (such as the time zone wasn't recognized). + + + + &reftitle.examples; + + <function>datefmt_set_timezone_id</function> example + + +]]> + + + + OO example + + +]]> + + + &example.outputs; + + + + + + + &reftitle.seealso; + +TODO + + + + +