add DateFormatter skeletons

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@254341 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Stanislav Malyshev 2008-03-06 01:30:03 +00:00
parent a37f1785e6
commit 3a58e7474b
22 changed files with 2407 additions and 1 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<book xml:id="book.intl" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Internationalization Functions</title>
@ -229,6 +229,7 @@ echo $formatter->format(1234567);
&reference.intl.locale;
&reference.intl.normalizer;
&reference.intl.messageformatter;
<!-- &reference.intl.dateformatter; -->
</book>

View file

@ -0,0 +1,96 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<section xml:id="intl.dateformatter-constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
<para>
TODO
<variablelist>
<varlistentry>
<term>
<constant>DateFormatter::NONE</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>TODO</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>DateFormatter::FULL</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>TODO</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>DateFormatter::LONG</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>TODO</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>DateFormatter::MEDIUM</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>TODO</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>DateFormatter::SHORT</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>TODO</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>DateFormatter::TRADITIONAL</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>TODO</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>DateFormatter::GREGORIAN</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>TODO</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,63 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<reference xml:id="class.dateformatter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The DateFormatter class</title>
<titleabbrev>DateFormatter</titleabbrev>
<partintro>
<!-- {{{ DateFormatter intro -->
<section xml:id="dateformatter.intro">
&reftitle.intro;
<para>
TODO
</para>
</section>
<!-- }}} -->
<section xml:id="dateformatter.synopsis">
<title>Class synopsis</title>
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>DateFormatter</classname>
</ooclass>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateformatter')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
<xi:include
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateformatter')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
&reference.intl.dateformatter-constants;
</partintro>
&reference.intl.entities.dateformatter;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,164 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::create</refname>
<refname>datefmt_create</refname>
<refpurpose>Create a date formatter</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<methodsynopsis>
<modifier>static</modifier>
<type>DateFormatter</type><methodname>DateFormatter::create</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>integer</type><parameter>datetype</parameter></methodparam>
<methodparam><type>integer</type><parameter>timetype</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>timezone</parameter></methodparam>
<methodparam choice='opt'><type>integer</type><parameter>calendar</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>pattern</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (constructor)</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>integer</type><parameter>datetype</parameter></methodparam>
<methodparam><type>integer</type><parameter>timetype</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>timezone</parameter></methodparam>
<methodparam choice='opt'><type>integer</type><parameter>calendar</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>pattern</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>DateFormatter</type><methodname>datefmt_create</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>integer</type><parameter>datetype</parameter></methodparam>
<methodparam><type>integer</type><parameter>timetype</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>timezone</parameter></methodparam>
<methodparam choice='opt'><type>integer</type><parameter>calendar</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>pattern</parameter></methodparam>
</methodsynopsis>
<para>
Create a date formatter
GREGORIAN </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
<para>
Locale to use when formatting or parsing </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>datetype</parameter></term>
<listitem>
<para>
Date type to use (none, short, medium, long, full) </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timetype</parameter></term>
<listitem>
<para>
Time type to use (none, short, medium, long, full) </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timezone</parameter></term>
<listitem>
<para>
Time zone ID ; default is system default </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
Calendar to use for formatting or parsing; default is </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
Optional pattern to use when formatting or parsing </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_create</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,117 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::format</refname>
<refname>datefmt_format</refname>
<refpurpose>formats the time value as a string.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>format</methodname>
<methodparam choice='opt'><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>string</type><methodname>datefmt_format</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam choice='opt'><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
formats the time value as a string.
integer: a unix timestamp value (seconds since epoch, UTC)
array: a localtime array </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The date formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
- value to format </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
a formatted string or, if an error occurred, 'null'. </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_format</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,107 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.getcalendar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::getCalendar</refname>
<refname>datefmt_get_calendar</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>integer</type><methodname>getCalendar</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>integer</type><methodname>datefmt_get_calendar</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
the calendar being used by the formatter </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_get_calendar</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,107 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.getdatetype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::getDateType</refname>
<refname>datefmt_get_datetype</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>integer</type><methodname>getDateType</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>integer</type><methodname>datefmt_get_datetype</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
the current 'datetype' value of the formatter </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_get_datetype</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,108 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.geterrorcode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::getErrorCode</refname>
<refname>datefmt_get_error_code</refname>
<refpurpose>Get the error code from last operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>integer</type><methodname>getErrorCode</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>integer</type><methodname>datefmt_get_error_code</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
</methodsynopsis>
<para>
Get the error code from last operation
Returns error code from the last number formatting operation. </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
the error code, one of UErrorCode values. Initial value is U_ZERO_ERROR. </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_get_error_code</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,107 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.geterrormessage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::getErrorMessage</refname>
<refname>datefmt_get_error_message</refname>
<refpurpose>Get the error text from the last operation.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>getErrorMessage</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>string</type><methodname>datefmt_get_error_message</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
</methodsynopsis>
<para>
Get the error text from the last operation. </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description of the last error. </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_get_error_message</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,117 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.getlocale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::getLocale</refname>
<refname>datefmt_get_locale</refname>
<refpurpose>values may include ULOC_ACTUAL_LOCALE,</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>getLocale</methodname>
<methodparam choice='opt'><type>integer</type><parameter>hich</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>string</type><methodname>datefmt_get_locale</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam choice='opt'><type>integer</type><parameter>hich</parameter></methodparam>
</methodsynopsis>
<para>
values may include ULOC_ACTUAL_LOCALE,
ULOC_VALID_LOCALE. By default the actual
locale is returned. </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hich</parameter></term>
<listitem>
<para>
locale should be returned? </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
the locale of this formatter or 'false' if error </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_get_locale</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,107 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.getpattern" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::getPattern</refname>
<refname>datefmt_get_pattern</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>getPattern</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>string</type><methodname>datefmt_get_pattern</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
the pattern string being used to format/parse </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_get_pattern</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,107 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.gettimetype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::getTimeType</refname>
<refname>datefmt_get_timetype</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>integer</type><methodname>getTimeType</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>integer</type><methodname>datefmt_get_timetype</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
the current 'timetype' value of the formatter </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_get_timetype</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,107 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.gettimezoneid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::getTimeZoneId</refname>
<refname>datefmt_get_timezone_id</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>getTimeZoneId</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>string</type><methodname>datefmt_get_timezone_id</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
ID string for the time zone used by this formatter </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_get_timezone_id</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,107 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.islenient" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::isLenient</refname>
<refname>datefmt_is_lenient</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>boolean</type><methodname>isLenient</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>boolean</type><methodname>datefmt_is_lenient</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
'true' if parser is lenient, 'false' if parser is strictdefault value for parser is 'false'. </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_is_lenient</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,150 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.localtime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::localtime</refname>
<refname>datefmt_localtime</refname>
<refpurpose>converts string $value to a field-based time value, starting at</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>array</type><methodname>localtime</methodname>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam><type>array</type><parameter>localtime</parameter></methodparam>
<methodparam><type>integer</type><parameter>parse_pos</parameter></methodparam>
<methodparam><type>integer</type><parameter>error</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>array</type><methodname>datefmt_localtime</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam><type>array</type><parameter>localtime</parameter></methodparam>
<methodparam><type>integer</type><parameter>parse_pos</parameter></methodparam>
<methodparam><type>integer</type><parameter>error</parameter></methodparam>
</methodsynopsis>
<para>
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. </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
string to convert to a time </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>localtime</parameter></term>
<listitem>
<para>
the array to store the parsed value; values in this array will </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parse_pos</parameter></term>
<listitem>
<para>
position at which to start the parsing in $value (zero-based) </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error</parameter></term>
<listitem>
<para>
error value of any error that occurs during parsing </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
localtime compatible array of integers </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_localtime</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,115 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.parsetolocaltime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::parseToLocaltime</refname>
<refname>datefmt_parse_to_localtime</refname>
<refpurpose>Field-based equivalent of parse().</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>array</type><methodname>parseToLocaltime</methodname>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>array</type><methodname>datefmt_parse_to_localtime</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Field-based equivalent of parse(). </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
String value to parse into a date. </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An array in the same format as localtime produces </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_parse_to_localtime</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,116 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.parsetotimestamp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::parseToTimestamp</refname>
<refname>datefmt_parse_to_timestamp</refname>
<refpurpose>converts the string $value to a Unix timestamp (a time_t integer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>integer</type><methodname>parseToTimestamp</methodname>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>integer</type><methodname>datefmt_parse_to_timestamp</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
converts the string $value to a Unix timestamp (a time_t integer
value, seconds since epoch). </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
string to convert to a time </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
timestamp value </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_parse_to_timestamp</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,140 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.parse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::parse</refname>
<refname>datefmt_parse</refname>
<refpurpose>converts string $value to an incremental time value, starting at</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>integer</type><methodname>parse</methodname>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam><type>integer</type><parameter>parse_pos</parameter></methodparam>
<methodparam><type>integer</type><parameter>error</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>integer</type><methodname>datefmt_parse</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam><type>integer</type><parameter>parse_pos</parameter></methodparam>
<methodparam><type>integer</type><parameter>error</parameter></methodparam>
</methodsynopsis>
<para>
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. </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
string to convert to a time </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parse_pos</parameter></term>
<listitem>
<para>
position at which to start the parsing in $value (zero-based) </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error</parameter></term>
<listitem>
<para>
error value of any error that occurs during parsing </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
timestamp parsed value </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_parse</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,119 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.setcalendar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::setCalendar</refname>
<refname>datefmt_set_calendar</refname>
<refpurpose>sets the calendar used to the appropriate calendar, which must be</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>boolean</type><methodname>setCalendar</methodname>
<methodparam><type>integer</type><parameter>which</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>boolean</type><methodname>datefmt_set_calendar</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam><type>integer</type><parameter>which</parameter></methodparam>
</methodsynopsis>
<para>
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 </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>which</parameter></term>
<listitem>
<para>
the calendar (an enumerated constant) to use. </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
'true' if successful, 'false' if an error occurred or if the calendar was not recognized </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_set_calendar</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,119 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.setlenient" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::setLenient</refname>
<refname>datefmt_set_lenient</refname>
<refpurpose>'true' sets the parser to accept otherwise flawed date or</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>boolean</type><methodname>setLenient</methodname>
<methodparam><type>boolean</type><parameter>lenient</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>boolean</type><methodname>datefmt_set_lenient</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam><type>boolean</type><parameter>lenient</parameter></methodparam>
</methodsynopsis>
<para>
'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. </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lenient</parameter></term>
<listitem>
<para>
sets whether the parser is lenient or not, default is 'false' </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
'true' if successful; 'false' if an error occurred. </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_set_lenient</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,115 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.setpattern" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::setPattern</refname>
<refname>datefmt_set_pattern</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>boolean</type><methodname>setPattern</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>boolean</type><methodname>datefmt_set_pattern</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
new pattern string to use </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
'true' if successful, 'false' if an error occured. Bad formatstrings are usually the cause of the latter. </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_set_pattern</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,117 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="dateformatter.settimezoneid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateFormatter::setTimeZoneId</refname>
<refname>datefmt_set_timezone_id</refname>
<refpurpose>sets the time zone to use</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style</para>
<classsynopsis>
<ooclass><classname>DateFormatter</classname></ooclass>
<methodsynopsis>
<type>boolean</type><methodname>setTimeZoneId</methodname>
<methodparam><type>string</type><parameter>zone</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style</para>
<methodsynopsis>
<type>boolean</type><methodname>datefmt_set_timezone_id</methodname>
<methodparam><type>DateFormatter</type><parameter>fmt</parameter></methodparam>
<methodparam><type>string</type><parameter>zone</parameter></methodparam>
</methodsynopsis>
<para>
sets the time zone to use
if null or the empty string, the default time zone for
the runtime is used. </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fmt</parameter></term>
<listitem>
<para>
The formatter resource </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>zone</parameter></term>
<listitem>
<para>
zone ID string of the time zone to use. </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
'true' on successful setting of the time zone, 'false'if an error occurred (such as the time zone wasn't recognized). </para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>datefmt_set_timezone_id</function> example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
< ?php
TODO
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
TODO
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
TODO
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->