cvs: phpdoc /en/reference/array/functions array-diff.xml /en/reference/cyrus/functions cyrus-authenticate.xml cyrus-bind.xml cyrus-close.xml
cyrus-connect.xml cyrus-query.xml cyrus-unbind.xml /en/reference/datetime/functions gmstrftime.xml strftime.xml /en/reference/imap/functions
imap-getacl.xml imap-setacl.xml imap-timeout.xml /en/reference/xml/functions xml-set-end-namespace-decl-handler.xml
xml-set-start-namespace-decl-handler.xml
| From: | Mehdi Achour | Date: | Sun, 30 Dec 2007 15:20:46 +0000 |
| Subject: | cvs: phpdoc /en/reference/array/functions array-diff.xml /en/reference/cyrus/functions cyrus-authenticate.xml cyrus-bind.xml cyrus-close.xml cyrus-connect.xml cyrus-query.xml cyrus-unbind.xml /en/reference/datetime/functions gmstrftime.xml strftime.xml /en/reference/imap/functions imap-getacl.xml imap-setacl.xml imap-timeout.xml /en/reference/xml/functions xml-set-end-namespace-decl-handler.xml xml-set-start-namespace-decl-handler.xml |
||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-943@lists.php.net to get a copy of this message | ||
didou Sun Dec 30 15:20:46 2007 UTC
Modified files:
/phpdoc/en/reference/array/functions array-diff.xml
/phpdoc/en/reference/cyrus/functions cyrus-authenticate.xml
cyrus-bind.xml cyrus-close.xml
cyrus-connect.xml
cyrus-query.xml
cyrus-unbind.xml
/phpdoc/en/reference/datetime/functions gmstrftime.xml strftime.xml
/phpdoc/en/reference/imap/functions imap-getacl.xml imap-setacl.xml
imap-timeout.xml
/phpdoc/en/reference/xml/functions
xml-set-end-namespace-decl-handler.xml
xml-set-start-namespace-decl-handler.xml
Log:
Integrate user notes
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/array-diff.xml?r1=1.15&r2=1.16&diff_format=u Index: phpdoc/en/reference/array/functions/array-diff.xml diff -u phpdoc/en/reference/array/functions/array-diff.xml:1.15 phpdoc/en/reference/array/functions/array-diff.xml:1.16 --- phpdoc/en/reference/array/functions/array-diff.xml:1.15 Wed Jun 20 22:24:14 2007 +++ phpdoc/en/reference/array/functions/array-diff.xml Sun Dec 30 15:20:45 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> <refentry xml:id="function.array-diff" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>array_diff</refname> <refpurpose>Computes the difference of arrays</refpurpose> </refnamediv> - + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -19,14 +19,47 @@ returns the difference. </para> </refsect1> - - <!-- - <refsect1 role="errors"> - &reftitle.errors; - &errors.no.unusual.errors; + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array1</parameter></term> + <listitem> + <para> + The array to compare from + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>array2</parameter></term> + <listitem> + <para> + An array to compare against + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>...</parameter></term> + <listitem> + <para> + More arrays to compare against + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> ---> - + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an <type>array</type> containing all the entries from + <parameter>array1</parameter> that are not present in any of the other arrays. + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml:1.7 phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml:1.8 --- phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml:1.7 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry xml:id="function.cyrus-authenticate" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_authenticate</refname> @@ -18,7 +18,13 @@ <methodparam choice="opt"><type>string</type><parameter>authname</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-bind.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-bind.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-bind.xml:1.4 phpdoc/en/reference/cyrus/functions/cyrus-bind.xml:1.5 --- phpdoc/en/reference/cyrus/functions/cyrus-bind.xml:1.4 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-bind.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.cyrus-bind" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_bind</refname> @@ -12,7 +12,38 @@ <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>array</type><parameter>callbacks</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Binds callbacks to a Cyrus IMAP connection. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>callbacks</parameter></term> + <listitem> + <para> + An array of callbacks. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-close.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-close.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-close.xml:1.5 phpdoc/en/reference/cyrus/functions/cyrus-close.xml:1.6 --- phpdoc/en/reference/cyrus/functions/cyrus-close.xml:1.5 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-close.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.cyrus-close" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_close</refname> @@ -11,7 +11,30 @@ <type>bool</type><methodname>cyrus_close</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Closes the connection to a Cyrus IMAP server. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-connect.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-connect.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-connect.xml:1.4 phpdoc/en/reference/cyrus/functions/cyrus-connect.xml:1.5 --- phpdoc/en/reference/cyrus/functions/cyrus-connect.xml:1.4 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-connect.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.cyrus-connect" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_connect</refname> @@ -13,7 +13,45 @@ <methodparam choice="opt"><type>string</type><parameter>port</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Connects to a Cyrus IMAP server. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>host</parameter></term> + <listitem> + <para> + The Cyrus IMAP host name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + The port number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a connection handler on success, or &false; on failure. + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-query.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-query.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-query.xml:1.5 phpdoc/en/reference/cyrus/functions/cyrus-query.xml:1.6 --- phpdoc/en/reference/cyrus/functions/cyrus-query.xml:1.5 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-query.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.cyrus-query" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_query</refname> @@ -12,7 +12,40 @@ <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Sends a query to a Cyrus IMAP server. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The query string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array with the following keys: + <literal>text</literal>, <literal>msgno</literal>, + and <literal>keyword</literal>. + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml:1.4 phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml:1.5 --- phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml:1.4 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.cyrus-unbind" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_unbind</refname> @@ -12,7 +12,36 @@ <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>trigger_name</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>trigger_name</parameter></term> + <listitem> + <para> + The trigger name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/datetime/functions/gmstrftime.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/datetime/functions/gmstrftime.xml diff -u phpdoc/en/reference/datetime/functions/gmstrftime.xml:1.10 phpdoc/en/reference/datetime/functions/gmstrftime.xml:1.11 --- phpdoc/en/reference/datetime/functions/gmstrftime.xml:1.10 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/datetime/functions/gmstrftime.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry xml:id="function.gmstrftime" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>gmstrftime</refname> @@ -21,13 +21,41 @@ 01:00:00". </para> </refsect1> - + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>format</parameter></term> + <listitem> + <para> + See description in <function>strftime</function>. + </para> + </listitem> + </varlistentry> + &date.timestamp.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string formatted according to the given format string + using the given <parameter>timestamp</parameter> or the current + local time if no timestamp is given. Month and weekday names and + other language dependent strings respect the current locale set + with <function>setlocale</function>. + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>gmstrftime</function> example</title> - <programlisting role="php"> + <programlisting role="php"> <![CDATA[ <?php setlocale(LC_TIME, 'en_US'); http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/datetime/functions/strftime.xml?r1=1.20&r2=1.21&diff_format=u Index: phpdoc/en/reference/datetime/functions/strftime.xml diff -u phpdoc/en/reference/datetime/functions/strftime.xml:1.20 phpdoc/en/reference/datetime/functions/strftime.xml:1.21 --- phpdoc/en/reference/datetime/functions/strftime.xml:1.20 Wed Nov 21 15:49:07 2007 +++ phpdoc/en/reference/datetime/functions/strftime.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <refentry xml:id="function.strftime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>strftime</refname> @@ -14,18 +14,15 @@ <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> </methodsynopsis> <para> - Returns a string formatted according to the given format string - using the given <parameter>timestamp</parameter> or the current - local time if no timestamp is given. Month and weekday names and - other language dependent strings respect the current locale set + Format a local time/date according to locale settings. Month and weekday + names and other language dependent strings respect the current locale set with <function>setlocale</function>. </para> <para> - Not all conversion specifiers may be supported by your C - library, in which case they will not be supported by PHP's - <function>strftime</function>. Additionally, not all platforms - support negative timestamps, therefore your date range may - be limited to no earlier than the Unix epoch. This means that + Not all conversion specifiers may be supported by your C library, in which + case they will not be supported by PHP's <function>strftime</function>. + Additionally, not all platforms support negative timestamps, therefore your + date range may be limited to no earlier than the Unix epoch. This means that e.g. %e, %T, %R and %D (there might be more) and dates prior to <literal>Jan 1, 1970</literal> will not work on Windows, some Linux distributions, and a few other operating systems. For Windows systems a @@ -249,25 +246,34 @@ %% - a literal `%' character </simpara> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Maximum length of this parameter is 1023 characters. </para> </listitem> </varlistentry> - + &date.timestamp.description; - + </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string formatted according to the given format string + using the given <parameter>timestamp</parameter> or the current + local time if no timestamp is given. Month and weekday names and + other language dependent strings respect the current locale set + with <function>setlocale</function>. + </para> + </refsect1> + <refsect1 role="errors"> &reftitle.errors; - - &date.timezone.errors.description; - + &date.timezone.errors.description; </refsect1> <refsect1 role="changelog"> @@ -282,9 +288,9 @@ </row> </thead> <tbody> - + &date.timezone.errors.changelog; - + </tbody> </tgroup> </informaltable> @@ -387,6 +393,7 @@ <member><function>setlocale</function></member> <member><function>mktime</function></member> <member><function>strptime</function></member> + <member><function>gmtstrftime</function></member> <member><link xlink:href="&spec.strftime;">Open Group specification of <function>strftime</function></link></member> </simplelist> </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-getacl.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-getacl.xml diff -u phpdoc/en/reference/imap/functions/imap-getacl.xml:1.6 phpdoc/en/reference/imap/functions/imap-getacl.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-getacl.xml:1.6 Wed Jun 20 22:24:47 2007 +++ phpdoc/en/reference/imap/functions/imap-getacl.xml Sun Dec 30 15:20:46 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.imap-getacl" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>imap_getacl</refname> @@ -12,7 +12,9 @@ <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Gets the ACL for a given mailbox. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -31,6 +33,39 @@ </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array of "folder" => "acl" pairs. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>imap_getacl</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +print_r(imap_getacl($conn_id, 'user.joecool')); + +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +Array +( + [asubfolder] => lrswipcda + [anothersubfolder] => lrswipcda +) +]]> + </screen> + </example> + </para> + </refsect1> <refsect1 role="notes"> &reftitle.notes; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-setacl.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-setacl.xml diff -u phpdoc/en/reference/imap/functions/imap-setacl.xml:1.8 phpdoc/en/reference/imap/functions/imap-setacl.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-setacl.xml:1.8 Wed Jun 20 22:24:47 2007 +++ phpdoc/en/reference/imap/functions/imap-setacl.xml Sun Dec 30 15:20:46 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry xml:id='function.imap-setacl' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>imap_setacl</refname> @@ -15,7 +15,7 @@ <methodparam><type>string</type><parameter>rights</parameter></methodparam> </methodsynopsis> <para> - &warn.undocumented.func; + Sets the ACL for a giving mailbox. </para> </refsect1> <refsect1 role="parameters"> @@ -36,6 +36,7 @@ <term><parameter>id</parameter></term> <listitem> <para> + The user to give the rights to. </para> </listitem> </varlistentry> @@ -43,6 +44,8 @@ <term><parameter>rights</parameter></term> <listitem> <para> + The rights to give to the user. Passing an empty string will delete + acl. </para> </listitem> </varlistentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-timeout.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-timeout.xml diff -u phpdoc/en/reference/imap/functions/imap-timeout.xml:1.4 phpdoc/en/reference/imap/functions/imap-timeout.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-timeout.xml:1.4 Wed Jun 20 22:24:47 2007 +++ phpdoc/en/reference/imap/functions/imap-timeout.xml Sun Dec 30 15:20:46 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.imap-timeout" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>imap_timeout</refname> @@ -12,7 +12,65 @@ <methodparam><type>int</type><parameter>timeout_type</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Sets or fetchs the imap timeout. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>timeout_type</parameter></term> + <listitem> + <para> + One of the following: + <constant>IMAP_OPENTIMEOUT</constant>, + <constant>IMAP_READTIMEOUT</constant>, + <constant>IMAP_WRITETIMEOUT</constant>, or + <constant>IMAP_CLOSETIMEOUT</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + The timeout, in seconds. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + If the <parameter>timeout</parameter> parameter is set, this function + returns &true; on success and &false; on failure. + </para> + <para> + If <parameter>timeout</parameter> is not provided or evaluates to -1, + the current timeout value of <parameter>timeout_type</parameter> is + returned as an integer. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>imap_timeout</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +echo "The current read timeout is " . imap_timeout(IMAP_READTIMEOUT) . "\n"; + +?> +]]> + </programlisting> + </example> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml diff -u phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.8 phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.9 --- phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.8 Wed Jun 20 22:25:36 2007 +++ phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml Sun Dec 30 15:20:46 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.xml-set-end-namespace-decl-handler'> <refnamediv> <refname>xml_set_end_namespace_decl_handler</refname> <refpurpose>Set up end namespace declaration handler</refpurpose> </refnamediv> - + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,8 +13,82 @@ <methodparam><type>resource</type><parameter>parser</parameter></methodparam> <methodparam><type>callback</type><parameter>handler</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; - ¬e.func-callback; + <para> + Set a handler to be called when leaving the scope of a namespace + declaration. This will be called, for each namespace declaration, after + the handler for the end tag of the element in which the namespace was + declared. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <para> + A reference to the XML parser. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handler</parameter></term> + <listitem> + <para> + <parameter>handler</parameter> is a string containing the name of a + function that must exist when <function>xml_parse</function> is called + for <parameter>parser</parameter>. + </para> + <para> + The function named by <parameter>handler</parameter> must accept + three parameters, and should return an integer value. If the + value returned from the handler is &false; (which it will be if no + value is returned), the XML parser will stop parsing and + <function>xml_get_error_code</function> will return + <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>. + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>user_data</parameter></methodparam> + <methodparam><type>string</type><parameter>prefix</parameter></methodparam> + </methodsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + The first parameter, <replaceable>parser</replaceable>, is a + reference to the XML parser calling the handler. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>user_data</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>prefix</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + </para> + ¬e.func-callback; + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> @@ -24,6 +98,15 @@ </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xml_set_start_namespace_decl_handler</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml diff -u phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.8 phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.9 --- phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.8 Wed Jun 20 22:25:37 2007 +++ phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml Sun Dec 30 15:20:46 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.xml-set-start-namespace-decl-handler'> <refnamediv> <refname>xml_set_start_namespace_decl_handler</refname> @@ -7,7 +7,7 @@ Set up start namespace declaration handler </refpurpose> </refnamediv> - + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -15,8 +15,90 @@ <methodparam><type>resource</type><parameter>parser</parameter></methodparam> <methodparam><type>callback</type><parameter>handler</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; - ¬e.func-callback; + <para> + Set a handler to be called when a namespace is declared. Namespace + declarations occur inside start tags. But the namespace declaration start + handler is called before the start tag handler for each namespace declared + in that start tag. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <para> + A reference to the XML parser. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handler</parameter></term> + <listitem> + <para> + <parameter>handler</parameter> is a string containing the name of a + function that must exist when <function>xml_parse</function> is called + for <parameter>parser</parameter>. + </para> + <para> + The function named by <parameter>handler</parameter> must accept + four parameters, and should return an integer value. If the + value returned from the handler is &false; (which it will be if no + value is returned), the XML parser will stop parsing and + <function>xml_get_error_code</function> will return + <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>. + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>user_data</parameter></methodparam> + <methodparam><type>string</type><parameter>prefix</parameter></methodparam> + <methodparam><type>string</type><parameter>uri</parameter></methodparam> + </methodsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + The first parameter, <replaceable>parser</replaceable>, is a + reference to the XML parser calling the handler. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>user_data</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>prefix</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>uri</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + </para> + ¬e.func-callback; + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> @@ -26,6 +108,15 @@ </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xml_set_end_namespace_decl_handler</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/array-diff.xml?r1=1.15&r2=1.16&diff_format=u Index: phpdoc/en/reference/array/functions/array-diff.xml diff -u phpdoc/en/reference/array/functions/array-diff.xml:1.15 phpdoc/en/reference/array/functions/array-diff.xml:1.16 --- phpdoc/en/reference/array/functions/array-diff.xml:1.15 Wed Jun 20 22:24:14 2007 +++ phpdoc/en/reference/array/functions/array-diff.xml Sun Dec 30 15:20:45 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> <refentry xml:id="function.array-diff" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>array_diff</refname> <refpurpose>Computes the difference of arrays</refpurpose> </refnamediv> - + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -19,14 +19,47 @@ returns the difference. </para> </refsect1> - - <!-- - <refsect1 role="errors"> - &reftitle.errors; - &errors.no.unusual.errors; + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array1</parameter></term> + <listitem> + <para> + The array to compare from + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>array2</parameter></term> + <listitem> + <para> + An array to compare against + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>...</parameter></term> + <listitem> + <para> + More arrays to compare against + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> ---> - + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an <type>array</type> containing all the entries from + <parameter>array1</parameter> that are not present in any of the other arrays. + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml:1.7 phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml:1.8 --- phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml:1.7 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-authenticate.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry xml:id="function.cyrus-authenticate" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_authenticate</refname> @@ -18,7 +18,13 @@ <methodparam choice="opt"><type>string</type><parameter>authname</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-bind.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-bind.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-bind.xml:1.4 phpdoc/en/reference/cyrus/functions/cyrus-bind.xml:1.5 --- phpdoc/en/reference/cyrus/functions/cyrus-bind.xml:1.4 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-bind.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.cyrus-bind" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_bind</refname> @@ -12,7 +12,38 @@ <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>array</type><parameter>callbacks</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Binds callbacks to a Cyrus IMAP connection. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>callbacks</parameter></term> + <listitem> + <para> + An array of callbacks. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-close.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-close.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-close.xml:1.5 phpdoc/en/reference/cyrus/functions/cyrus-close.xml:1.6 --- phpdoc/en/reference/cyrus/functions/cyrus-close.xml:1.5 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-close.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.cyrus-close" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_close</refname> @@ -11,7 +11,30 @@ <type>bool</type><methodname>cyrus_close</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Closes the connection to a Cyrus IMAP server. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection handle. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-connect.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-connect.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-connect.xml:1.4 phpdoc/en/reference/cyrus/functions/cyrus-connect.xml:1.5 --- phpdoc/en/reference/cyrus/functions/cyrus-connect.xml:1.4 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-connect.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.cyrus-connect" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_connect</refname> @@ -13,7 +13,45 @@ <methodparam choice="opt"><type>string</type><parameter>port</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Connects to a Cyrus IMAP server. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>host</parameter></term> + <listitem> + <para> + The Cyrus IMAP host name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + The port number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a connection handler on success, or &false; on failure. + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-query.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-query.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-query.xml:1.5 phpdoc/en/reference/cyrus/functions/cyrus-query.xml:1.6 --- phpdoc/en/reference/cyrus/functions/cyrus-query.xml:1.5 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-query.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.cyrus-query" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_query</refname> @@ -12,7 +12,40 @@ <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Sends a query to a Cyrus IMAP server. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The query string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array with the following keys: + <literal>text</literal>, <literal>msgno</literal>, + and <literal>keyword</literal>. + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml diff -u phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml:1.4 phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml:1.5 --- phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml:1.4 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/cyrus/functions/cyrus-unbind.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.cyrus-unbind" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>cyrus_unbind</refname> @@ -12,7 +12,36 @@ <methodparam><type>resource</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>trigger_name</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection handle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>trigger_name</parameter></term> + <listitem> + <para> + The trigger name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/datetime/functions/gmstrftime.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/datetime/functions/gmstrftime.xml diff -u phpdoc/en/reference/datetime/functions/gmstrftime.xml:1.10 phpdoc/en/reference/datetime/functions/gmstrftime.xml:1.11 --- phpdoc/en/reference/datetime/functions/gmstrftime.xml:1.10 Wed Jun 20 22:24:18 2007 +++ phpdoc/en/reference/datetime/functions/gmstrftime.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry xml:id="function.gmstrftime" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>gmstrftime</refname> @@ -21,13 +21,41 @@ 01:00:00". </para> </refsect1> - + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>format</parameter></term> + <listitem> + <para> + See description in <function>strftime</function>. + </para> + </listitem> + </varlistentry> + &date.timestamp.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string formatted according to the given format string + using the given <parameter>timestamp</parameter> or the current + local time if no timestamp is given. Month and weekday names and + other language dependent strings respect the current locale set + with <function>setlocale</function>. + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>gmstrftime</function> example</title> - <programlisting role="php"> + <programlisting role="php"> <![CDATA[ <?php setlocale(LC_TIME, 'en_US'); http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/datetime/functions/strftime.xml?r1=1.20&r2=1.21&diff_format=u Index: phpdoc/en/reference/datetime/functions/strftime.xml diff -u phpdoc/en/reference/datetime/functions/strftime.xml:1.20 phpdoc/en/reference/datetime/functions/strftime.xml:1.21 --- phpdoc/en/reference/datetime/functions/strftime.xml:1.20 Wed Nov 21 15:49:07 2007 +++ phpdoc/en/reference/datetime/functions/strftime.xml Sun Dec 30 15:20:45 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <refentry xml:id="function.strftime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>strftime</refname> @@ -14,18 +14,15 @@ <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> </methodsynopsis> <para> - Returns a string formatted according to the given format string - using the given <parameter>timestamp</parameter> or the current - local time if no timestamp is given. Month and weekday names and - other language dependent strings respect the current locale set + Format a local time/date according to locale settings. Month and weekday + names and other language dependent strings respect the current locale set with <function>setlocale</function>. </para> <para> - Not all conversion specifiers may be supported by your C - library, in which case they will not be supported by PHP's - <function>strftime</function>. Additionally, not all platforms - support negative timestamps, therefore your date range may - be limited to no earlier than the Unix epoch. This means that + Not all conversion specifiers may be supported by your C library, in which + case they will not be supported by PHP's <function>strftime</function>. + Additionally, not all platforms support negative timestamps, therefore your + date range may be limited to no earlier than the Unix epoch. This means that e.g. %e, %T, %R and %D (there might be more) and dates prior to <literal>Jan 1, 1970</literal> will not work on Windows, some Linux distributions, and a few other operating systems. For Windows systems a @@ -249,25 +246,34 @@ %% - a literal `%' character </simpara> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Maximum length of this parameter is 1023 characters. </para> </listitem> </varlistentry> - + &date.timestamp.description; - + </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string formatted according to the given format string + using the given <parameter>timestamp</parameter> or the current + local time if no timestamp is given. Month and weekday names and + other language dependent strings respect the current locale set + with <function>setlocale</function>. + </para> + </refsect1> + <refsect1 role="errors"> &reftitle.errors; - - &date.timezone.errors.description; - + &date.timezone.errors.description; </refsect1> <refsect1 role="changelog"> @@ -282,9 +288,9 @@ </row> </thead> <tbody> - + &date.timezone.errors.changelog; - + </tbody> </tgroup> </informaltable> @@ -387,6 +393,7 @@ <member><function>setlocale</function></member> <member><function>mktime</function></member> <member><function>strptime</function></member> + <member><function>gmtstrftime</function></member> <member><link xlink:href="&spec.strftime;">Open Group specification of <function>strftime</function></link></member> </simplelist> </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-getacl.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-getacl.xml diff -u phpdoc/en/reference/imap/functions/imap-getacl.xml:1.6 phpdoc/en/reference/imap/functions/imap-getacl.xml:1.7 --- phpdoc/en/reference/imap/functions/imap-getacl.xml:1.6 Wed Jun 20 22:24:47 2007 +++ phpdoc/en/reference/imap/functions/imap-getacl.xml Sun Dec 30 15:20:46 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.imap-getacl" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>imap_getacl</refname> @@ -12,7 +12,9 @@ <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam> <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Gets the ACL for a given mailbox. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -31,6 +33,39 @@ </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array of "folder" => "acl" pairs. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>imap_getacl</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +print_r(imap_getacl($conn_id, 'user.joecool')); + +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +Array +( + [asubfolder] => lrswipcda + [anothersubfolder] => lrswipcda +) +]]> + </screen> + </example> + </para> + </refsect1> <refsect1 role="notes"> &reftitle.notes; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-setacl.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-setacl.xml diff -u phpdoc/en/reference/imap/functions/imap-setacl.xml:1.8 phpdoc/en/reference/imap/functions/imap-setacl.xml:1.9 --- phpdoc/en/reference/imap/functions/imap-setacl.xml:1.8 Wed Jun 20 22:24:47 2007 +++ phpdoc/en/reference/imap/functions/imap-setacl.xml Sun Dec 30 15:20:46 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry xml:id='function.imap-setacl' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>imap_setacl</refname> @@ -15,7 +15,7 @@ <methodparam><type>string</type><parameter>rights</parameter></methodparam> </methodsynopsis> <para> - &warn.undocumented.func; + Sets the ACL for a giving mailbox. </para> </refsect1> <refsect1 role="parameters"> @@ -36,6 +36,7 @@ <term><parameter>id</parameter></term> <listitem> <para> + The user to give the rights to. </para> </listitem> </varlistentry> @@ -43,6 +44,8 @@ <term><parameter>rights</parameter></term> <listitem> <para> + The rights to give to the user. Passing an empty string will delete + acl. </para> </listitem> </varlistentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-timeout.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/imap/functions/imap-timeout.xml diff -u phpdoc/en/reference/imap/functions/imap-timeout.xml:1.4 phpdoc/en/reference/imap/functions/imap-timeout.xml:1.5 --- phpdoc/en/reference/imap/functions/imap-timeout.xml:1.4 Wed Jun 20 22:24:47 2007 +++ phpdoc/en/reference/imap/functions/imap-timeout.xml Sun Dec 30 15:20:46 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry xml:id="function.imap-timeout" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>imap_timeout</refname> @@ -12,7 +12,65 @@ <methodparam><type>int</type><parameter>timeout_type</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Sets or fetchs the imap timeout. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>timeout_type</parameter></term> + <listitem> + <para> + One of the following: + <constant>IMAP_OPENTIMEOUT</constant>, + <constant>IMAP_READTIMEOUT</constant>, + <constant>IMAP_WRITETIMEOUT</constant>, or + <constant>IMAP_CLOSETIMEOUT</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + The timeout, in seconds. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + If the <parameter>timeout</parameter> parameter is set, this function + returns &true; on success and &false; on failure. + </para> + <para> + If <parameter>timeout</parameter> is not provided or evaluates to -1, + the current timeout value of <parameter>timeout_type</parameter> is + returned as an integer. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>imap_timeout</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +echo "The current read timeout is " . imap_timeout(IMAP_READTIMEOUT) . "\n"; + +?> +]]> + </programlisting> + </example> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml diff -u phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.8 phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.9 --- phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml:1.8 Wed Jun 20 22:25:36 2007 +++ phpdoc/en/reference/xml/functions/xml-set-end-namespace-decl-handler.xml Sun Dec 30 15:20:46 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.xml-set-end-namespace-decl-handler'> <refnamediv> <refname>xml_set_end_namespace_decl_handler</refname> <refpurpose>Set up end namespace declaration handler</refpurpose> </refnamediv> - + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -13,8 +13,82 @@ <methodparam><type>resource</type><parameter>parser</parameter></methodparam> <methodparam><type>callback</type><parameter>handler</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; - ¬e.func-callback; + <para> + Set a handler to be called when leaving the scope of a namespace + declaration. This will be called, for each namespace declaration, after + the handler for the end tag of the element in which the namespace was + declared. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <para> + A reference to the XML parser. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handler</parameter></term> + <listitem> + <para> + <parameter>handler</parameter> is a string containing the name of a + function that must exist when <function>xml_parse</function> is called + for <parameter>parser</parameter>. + </para> + <para> + The function named by <parameter>handler</parameter> must accept + three parameters, and should return an integer value. If the + value returned from the handler is &false; (which it will be if no + value is returned), the XML parser will stop parsing and + <function>xml_get_error_code</function> will return + <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>. + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>user_data</parameter></methodparam> + <methodparam><type>string</type><parameter>prefix</parameter></methodparam> + </methodsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + The first parameter, <replaceable>parser</replaceable>, is a + reference to the XML parser calling the handler. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>user_data</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>prefix</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + </para> + ¬e.func-callback; + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> @@ -24,6 +98,15 @@ </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xml_set_start_namespace_decl_handler</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml diff -u phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.8 phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.9 --- phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml:1.8 Wed Jun 20 22:25:37 2007 +++ phpdoc/en/reference/xml/functions/xml-set-start-namespace-decl-handler.xml Sun Dec 30 15:20:46 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.xml-set-start-namespace-decl-handler'> <refnamediv> <refname>xml_set_start_namespace_decl_handler</refname> @@ -7,7 +7,7 @@ Set up start namespace declaration handler </refpurpose> </refnamediv> - + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -15,8 +15,90 @@ <methodparam><type>resource</type><parameter>parser</parameter></methodparam> <methodparam><type>callback</type><parameter>handler</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; - ¬e.func-callback; + <para> + Set a handler to be called when a namespace is declared. Namespace + declarations occur inside start tags. But the namespace declaration start + handler is called before the start tag handler for each namespace declared + in that start tag. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <para> + A reference to the XML parser. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handler</parameter></term> + <listitem> + <para> + <parameter>handler</parameter> is a string containing the name of a + function that must exist when <function>xml_parse</function> is called + for <parameter>parser</parameter>. + </para> + <para> + The function named by <parameter>handler</parameter> must accept + four parameters, and should return an integer value. If the + value returned from the handler is &false; (which it will be if no + value is returned), the XML parser will stop parsing and + <function>xml_get_error_code</function> will return + <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>. + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>resource</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>user_data</parameter></methodparam> + <methodparam><type>string</type><parameter>prefix</parameter></methodparam> + <methodparam><type>string</type><parameter>uri</parameter></methodparam> + </methodsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + The first parameter, <replaceable>parser</replaceable>, is a + reference to the XML parser calling the handler. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>user_data</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>prefix</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>uri</parameter></term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + </para> + ¬e.func-callback; + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> <refsect1 role="returnvalues"> @@ -26,6 +108,15 @@ </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xml_set_end_namespace_decl_handler</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file