cvs: phpdoc /en/reference/http/functions header.xml headers-list.xml headers-sent.xml setcookie.xml setrawcookie.xml
/en/reference/http/functions/caching http-cache-etag.xml http-cache-last-modified.xml /en/reference/http/functions/encodings http-chunked-decode.xml
http-deflate.xml http-inflate.xml /en/reference/http/functions/misc http-build-cookie.xml http-date.xml http-get-request-body-stream.xml
http-get-request-body.xml http-get-request-headers.xml http-match-etag.xml http-match-modified.xml http-match-request-header.xml http-support.xml
/en/reference/http/functions/negotiation http-negotiate-charset.xml http-negotiate-ctype.xml http-negotiate-language.xml
/en/reference/http/functions/outputhandlers ob-deflatehandler.xml ob-etaghandler.xml ob-inflatehandler.xml /en/reference/http/functions/parsers
http-parse-cookie.xml http-parse-headers.xml http-parse-message.xml http-parse-params.xml /en/reference/http/functions/requests http-get.xml
http-head.xml http! -post-data.xml http-post-fields.xml http-put-data.xml http-put-file.xml http-put-stream.xml http-request-body-encode.xml
http-request-method-exists.xml http-request-method-name.xml http-request-method-register.xml http-request-method-unregister.xml http-request.xml
/en/reference/http/functions/responses http-redirect.xml http-send-content-disposition.xml http-send-content-type.xml http-send-data.xml
http-send-file.xml http-send-last-modified.xml http-send-status.xml http-send-stream.xml http-throttle.xml /en/reference/http/functions/urls
http-build-str.xml http-build-url.xml

mike Mon Jul 24 11:35:01 2006 UTC Added files: /phpdoc/en/reference/http/functions/caching http-cache-etag.xml http-cache-last-modified.xml /phpdoc/en/reference/http/functions/encodings http-chunked-decode.xml http-deflate.xml http-inflate.xml /phpdoc/en/reference/http/functions/misc http-build-cookie.xml http-date.xml http-get-request-body-stream.xml http-get-request-body.xml http-get-request-headers.xml http-match-etag.xml http-match-modified.xml http-match-request-header.xml http-support.xml /phpdoc/en/reference/http/functions/negotiation http-negotiate-charset.xml http-negotiate-ctype.xml http-negotiate-language.xml /phpdoc/en/reference/http/functions/outputhandlers ob-deflatehandler.xml ob-etaghandler.xml ob-inflatehandler.xml /phpdoc/en/reference/http/functions/parsers http-parse-cookie.xml http-parse-headers.xml http-parse-message.xml http-parse-params.xml /phpdoc/en/reference/http/functions/requests http-get.xml http-head.xml http-post-data.xml http-post-fields.xml http-put-data.xml http-put-file.xml http-put-stream.xml http-request-body-encode.xml http-request-method-exists.xml http-request-method-name.xml http-request-method-register.xml http-request-method-unregister.xml http-request.xml /phpdoc/en/reference/http/functions/responses http-redirect.xml http-send-content-disposition.xml http-send-content-type.xml http-send-data.xml http-send-file.xml http-send-last-modified.xml http-send-status.xml http-send-stream.xml http-throttle.xml /phpdoc/en/reference/http/functions/urls http-build-str.xml http-build-url.xml Removed files: /phpdoc/en/reference/http/functions header.xml headers-list.xml headers-sent.xml setcookie.xml setrawcookie.xml Log: - duh, somehow that didn't get through the last time

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/caching/http-cache-etag.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/caching/http-cache-etag.xml +++ phpdoc/en/reference/http/functions/caching/http-cache-etag.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-cache-etag"> <refnamediv> <refname>http_cache_etag</refname> <refpurpose>Caching by ETag</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_cache_etag</methodname> <methodparam choice="opt"><type>string</type><parameter>etag</parameter></methodparam> </methodsynopsis> <para> Attempts to cache the sent entity by its ETag, either supplied or generated by the hash algorithm specified by the <link linkend="http.configuration">INI setting <literal>http.etag.mode</literal></link>. </para> <para> If the clients <literal>If-None-Match</literal> header matches the supplied/calculated ETag, the body is considered cached on the clients side and a <literal>304 Not Modified</literal> status code is issued. </para> <para> A log entry is written to the cache log if the <link linkend="http.configuration">INI entry <literal>http.log.cache</literal></link> is set and the cache attempt was successful. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>etag</parameter></term> <listitem> <para> Custom ETag </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns FALSE on failure, or <emphasis>exits</emphasis> with <literal>304 Not Modified</literal> if the entity is cached. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_cache_etag</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/caching/http-cache-last-modified.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/caching/http-cache-last-modified.xml +++ phpdoc/en/reference/http/functions/caching/http-cache-last-modified.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-cache-last-modified"> <refnamediv> <refname>http_cache_last_modified</refname> <refpurpose>Caching by last modification</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_cache_last_modified</methodname> <methodparam choice="opt"><type>int</type><parameter>timestamp_or_expires</parameter></methodparam> </methodsynopsis> <para> Attempts to cache the sent entity by its last modification date. </para> <para> If the supplied argument is greater than 0, it is handled as timestamp and will be sent as date of last modification. If it is 0 or omitted, the current time will be sent as Last-Modified date. If it's negative, it is handled as expiration time in seconds, which means that if the requested last modification date is not between the calculated timespan, the <literal>Last-Modified</literal> header is updated and the actual body will be sent. </para> <para> A log entry will be written to the cache log if the &link.http.configuration; <literal>http.log.cache</literal> is set and the cache attempt was successful. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>timestamp_or_expires</parameter></term> <listitem> <para> Unix timestamp </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns FALSE on failure, or <emphasis>exits</emphasis> with <literal>304 Not Modified</literal> if the entity is cached. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_cache_last_modified</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/encodings/http-chunked-decode.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/encodings/http-chunked-decode.xml +++ phpdoc/en/reference/http/functions/encodings/http-chunked-decode.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-chunked-decode"> <refnamediv> <refname>http_chunked_decode</refname> <refpurpose>Decode chunked-encoded data</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_chunked_decode</methodname> <methodparam><type>string</type><parameter>encoded</parameter></methodparam> </methodsynopsis> <para> Decodes a string which is HTTP-chunked encoded. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>encoded</parameter></term> <listitem> <para> Chunked encoded string </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the decoded string on success or FALSE on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_chunked_decode</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/encodings/http-deflate.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/encodings/http-deflate.xml +++ phpdoc/en/reference/http/functions/encodings/http-deflate.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-deflate"> <refnamediv> <refname>http_deflate</refname> <refpurpose>Deflate data</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_deflate</methodname> <methodparam choice="opt"><type>string</type><parameter>data</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags = 0</parameter></methodparam> </methodsynopsis> <para> Compress data with <literal>gzip</literal>, <literal>zlib</literal> AKA <literal>deflate</literal> or <literal>raw deflate</literal> encoding. </para> <para> See the <link linkend="http.constants.deflate">deflate constants table</link> for possible values for the <varname>flags</varname> parameter. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>data</parameter></term> <listitem> <para> String containing the data that should be encoded </para> </listitem> </varlistentry> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> Deflate options </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the encoded string on success, or NULL on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_deflate</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/encodings/http-inflate.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/encodings/http-inflate.xml +++ phpdoc/en/reference/http/functions/encodings/http-inflate.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-inflate"> <refnamediv> <refname>http_inflate</refname> <refpurpose>Inflate data</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_inflate</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> </methodsynopsis> <para> Decompress data compressed with either <literal>gzip</literal>, <literal>deflate</literal> AKA <literal>zlib</literal> or <literal>raw deflate</literal> encoding. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>data</parameter></term> <listitem> <para> String containing the compressed data </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the decoded string on success, or NULL on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_inflate</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-build-cookie.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/misc/http-build-cookie.xml +++ phpdoc/en/reference/http/functions/misc/http-build-cookie.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-build-cookie"> <refnamediv> <refname>http_build_cookie</refname> <refpurpose>Build cookie string</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_build_cookie</methodname> <methodparam><type>array</type><parameter>cookie</parameter></methodparam> </methodsynopsis> <para> Build a cookie string from an array/object like returned by <function>http_parse_cookie</function>. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>cookie</parameter></term> <listitem> <para> a cookie list like returned from <function>http_parse_cookie</function> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the cookie(s) as string. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_build_cookie</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-date.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/misc/http-date.xml +++ phpdoc/en/reference/http/functions/misc/http-date.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-date"> <refnamediv> <refname>http_date</refname> <refpurpose>Compose HTTP RFC compliant date</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_date</methodname> <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> </methodsynopsis> <para> Compose a valid HTTP date regarding RFC 1123 looking like: <literal>Wed, 22 Dec 2004 11:34:47 GMT</literal>. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>timestamp</parameter></term> <listitem> <para> Unix timestamp </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the HTTP date as string. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_date</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-get-request-body-stream.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/misc/http-get-request-body-stream.xml +++ phpdoc/en/reference/http/functions/misc/http-get-request-body-stream.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-get-request-body-stream"> <refnamediv> <refname>http_get_request_body_stream</refname> <refpurpose>Get request body as stream</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>resource</type><methodname>http_get_request_body_stream</methodname> <void/> </methodsynopsis> <para> Create a stream to read the raw request body (e.g. POST or PUT data). </para> <para> This function can only be used once if the request method was another than POST. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the raw request body as stream on success or NULL on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_get_request_body_stream</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-get-request-body.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/misc/http-get-request-body.xml +++ phpdoc/en/reference/http/functions/misc/http-get-request-body.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-get-request-body"> <refnamediv> <refname>http_get_request_body</refname> <refpurpose>Get request body as string</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_get_request_body</methodname> <void/> </methodsynopsis> <para> Get the raw request body (e.g. POST or PUT data). </para> <para> This function can not be used after <link linkend="function.http-get-request-body-stream"><function>http_get_request_body_stream</function></link> if the request method was another than POST. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the raw request body as string on success or NULL on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_get_request_body</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-get-request-headers.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/misc/http-get-request-headers.xml +++ phpdoc/en/reference/http/functions/misc/http-get-request-headers.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-get-request-headers"> <refnamediv> <refname>http_get_request_headers</refname> <refpurpose>Get request headers as array</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>http_get_request_headers</methodname> <void/> </methodsynopsis> <para> Get a list of incoming HTTP headers. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an associative array of incoming request headers. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_get_request_headers</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-match-etag.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/misc/http-match-etag.xml +++ phpdoc/en/reference/http/functions/misc/http-match-etag.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-match-etag"> <refnamediv> <refname>http_match_etag</refname> <refpurpose>Match ETag</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_match_etag</methodname> <methodparam choice="opt"><type>string</type><parameter>etag</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>for_range = FALSE</parameter></methodparam> </methodsynopsis> <para> Matches the given <emphasis>ETag</emphasis> against the clients <literal>If-Match</literal> resp. <literal>If-None-Match</literal> HTTP headers. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>etag</parameter></term> <listitem> <para> The ETag to match </para> </listitem> </varlistentry> <varlistentry> <term><parameter>for_range</parameter></term> <listitem> <para> If set to TRUE, the header usually used to validate HTTP ranges will be checked </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns TRUE if ETag matches or the header contained the asterisk (&quot;*&quot;), else FALSE. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_match_etag</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-match-modified.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/misc/http-match-modified.xml +++ phpdoc/en/reference/http/functions/misc/http-match-modified.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-match-modified"> <refnamediv> <refname>http_match_modified</refname> <refpurpose>Match last modification</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_match_modified</methodname> <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>for_range = FALSE</parameter></methodparam> </methodsynopsis> <para> Matches the given unix timestamp against the clients "If-Modified-Since" resp. "If-Unmodified-Since" HTTP headers. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>timestamp</parameter></term> <listitem> <para> Unix timestamp; current time, if omitted </para> </listitem> </varlistentry> <varlistentry> <term><parameter>for_range</parameter></term> <listitem> <para> If set to TRUE, the header usually used to validate HTTP ranges will be checked </para> </listitem> </varlistentry> <varlistentry> <term><parameter>false</parameter></term> <listitem> <para> Its description </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns TRUE if timestamp represents an earlier date than the header, else FALSE. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_match_modified</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-match-request-header.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/misc/http-match-request-header.xml +++ phpdoc/en/reference/http/functions/misc/http-match-request-header.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-match-request-header"> <refnamediv> <refname>http_match_request_header</refname> <refpurpose>Match any header</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_match_request_header</methodname> <methodparam><type>string</type><parameter>header</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>match_case = FALSE</parameter></methodparam> </methodsynopsis> <para> Match an incoming HTTP header. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>header</parameter></term> <listitem> <para> The header name (case-insensitive) </para> </listitem> </varlistentry> <varlistentry> <term><parameter>value</parameter></term> <listitem> <para> The header value that should be compared </para> </listitem> </varlistentry> <varlistentry> <term><parameter>match_case</parameter></term> <listitem> <para> Whether the value should be compared case sensitively </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns TRUE if header value matches, else FALSE. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_match_request_header</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-support.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/misc/http-support.xml +++ phpdoc/en/reference/http/functions/misc/http-support.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-support"> <refnamediv> <refname>http_support</refname> <refpurpose>Check builtin HTTP support</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>http_support</methodname> <methodparam choice="opt"><type>int</type><parameter>feature = 0</parameter></methodparam> </methodsynopsis> <para> Check for features that require external libraries. </para> <para> See the <link linkend="http.constants.support">feature support constants table</link> for possible values for the <varname>feature</varname> argument. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>feature</parameter></term> <listitem> <para> Feature to probe for; if the parameter is 0 or omitted, the return value contains a bitmask of all supported features that depend on external libraries </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns int, whether requested feature is supported, or a bitmask with all supported features. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_support</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/negotiation/http-negotiate-charset.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/negotiation/http-negotiate-charset.xml +++ phpdoc/en/reference/http/functions/negotiation/http-negotiate-charset.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-negotiate-charset"> <refnamediv> <refname>http_negotiate_charset</refname> <refpurpose>Negotiate clients preferred character set</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_negotiate_charset</methodname> <methodparam choice="opt"><type>array</type><parameter>supported</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">result</parameter></methodparam> </methodsynopsis> <para> This function negotiates the clients preferred charset based on its <literal>Accept-Charset</literal> HTTP header. The qualifier is recognized and charsets without qualifier are rated highest. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>supported</parameter></term> <listitem> <para> Array containing the supported charsets as values </para> </listitem> </varlistentry> <varlistentry> <term><parameter>result</parameter></term> <listitem> <para> Will be filled with an array containing the negotiation results </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the negotiated charset or the default charset (i.e. first array entry) if none match. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Using <function>http_negotiate_charset</function></title> <programlisting role="php"> <![CDATA[ <?php $charsets = array( 'iso-8859-1', // default 'iso-8859-2', 'iso-8859-15', 'utf-8' ); $pref = http_negotiate_charset($charsets, $result); if (strcmp($pref, 'iso-8859-1')) { iconv_set_encoding('internal_encoding', 'iso-8859-1'); iconv_set_encoding('output_encoding', $pref); ob_start('ob_iconv_handler'); } print_r($result); ?> ]]> </programlisting> </example> </para> </refsect1> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/negotiation/http-negotiate-ctype.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/negotiation/http-negotiate-ctype.xml +++ phpdoc/en/reference/http/functions/negotiation/http-negotiate-ctype.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-negotiate-ctype"> <refnamediv> <refname>http_negotiate_ctype</refname> <refpurpose>Negotiate clients preferred content type</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_negotiate_ctype</methodname> <methodparam choice="opt"><type>array</type><parameter>supported</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">result</parameter></methodparam> </methodsynopsis> <para> This function negotiates the clients preferred content type based on its <literal>Accept</literal> HTTP header. The qualifier is recognized and content types without qualifier are rated highest. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>supported</parameter></term> <listitem> <para> Array containing the supported content types as values </para> </listitem> </varlistentry> <varlistentry> <term><parameter>result</parameter></term> <listitem> <para> Will be filled with an array containing the negotiation results </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the negotiated content type or the default content type (i.e. first array entry) if none match. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Using <function>http_negotiate_ctype</function></title> <programlisting role="php"> <![CDATA[ <?php $ctypes = array('application/xhtml+xml', 'text/html'); http_send_content_type(http_negotiate_content_type($ctypes)); ?> ]]> </programlisting> </example> </para> </refsect1> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/negotiation/http-negotiate-language.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/negotiation/http-negotiate-language.xml +++ phpdoc/en/reference/http/functions/negotiation/http-negotiate-language.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-negotiate-language"> <refnamediv> <refname>http_negotiate_language</refname> <refpurpose>Negotiate clients preferred language</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_negotiate_language</methodname> <methodparam choice="opt"><type>array</type><parameter>supported</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">result</parameter></methodparam> </methodsynopsis> <para> This function negotiates the clients preferred language based on its <literal>Accept-Language</literal> HTTP header. The qualifier is recognized and languages without qualifier are rated highest. The qualifier will be decreased by 10% for partial matches (i.e. matching primary language). </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>supported</parameter></term> <listitem> <para> Array containing the supported languages as values </para> </listitem> </varlistentry> <varlistentry> <term><parameter>result</parameter></term> <listitem> <para> Will be filled with an array containing the negotiation results </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the negotiated language or the default language (i.e. first array entry) if none match. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Using <function>http_negotiate_language</function></title> <programlisting role="php"> <![CDATA[ <?php $langs = array( 'en-US',// default 'fr', 'fr-FR', 'de', 'de-DE', 'de-AT', 'de-CH', ); include './langs/'. http_negotiate_language($langs, $result) .'.php'; print_r($result); ?> ]]> </programlisting> </example> </para> </refsect1> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/outputhandlers/ob-deflatehandler.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/outputhandlers/ob-deflatehandler.xml +++ phpdoc/en/reference/http/functions/outputhandlers/ob-deflatehandler.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.ob-deflatehandler"> <refnamediv> <refname>ob_deflatehandler</refname> <refpurpose>Deflate output handler</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>ob_deflatehandler</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> For use with <link linkend="function.ob-start"><function>ob_start</function></link>. </para> <para> The deflate output buffer handler can only be used once. </para> <para> It conflicts with ob_gzhandler and zlib.output_compression as well and should not be used after ext/mbstrings mb_output_handler and ext/sessions URL-Rewriter (AKA session.use_trans_sid). </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>ob_deflatehandler</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/outputhandlers/ob-etaghandler.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/outputhandlers/ob-etaghandler.xml +++ phpdoc/en/reference/http/functions/outputhandlers/ob-etaghandler.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.ob-etaghandler"> <refnamediv> <refname>ob_etaghandler</refname> <refpurpose>ETag output handler</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>ob_etaghandler</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> For use with <link linkend="function.ob-start"><function>ob_start</function></link>. </para> <para> Output buffer handler generating an ETag with the hash algorithm specified with the &link.http.configuration; <literal>http.etag.mode</literal>. </para> <para> This output handler is used by <link linkend="function.http-cache-etag"><function>http_cache_etag</function></link>. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>ob_etaghandler</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/outputhandlers/ob-inflatehandler.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/outputhandlers/ob-inflatehandler.xml +++ phpdoc/en/reference/http/functions/outputhandlers/ob-inflatehandler.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.ob-inflatehandler"> <refnamediv> <refname>ob_inflatehandler</refname> <refpurpose>Inflate output handler</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>ob_inflatehandler</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> For use with <link linkend="function.ob-start"><function>ob_start</function></link>. </para> <para> Same restrictions as with <link linkend="function.ob-deflatehandler"><function>ob_deflatehandler</function></link> apply. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>ob_inflatehandler</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/parsers/http-parse-cookie.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/parsers/http-parse-cookie.xml +++ phpdoc/en/reference/http/functions/parsers/http-parse-cookie.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-parse-cookie"> <refnamediv> <refname>http_parse_cookie</refname> <refpurpose>Parse HTTP cookie</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>object</type><methodname>http_parse_cookie</methodname> <methodparam choice="opt"><type>string</type><parameter>cookie</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>allowed_extras</parameter></methodparam> </methodsynopsis> <para> Parses HTTP cookies like sent in a response into a struct. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>cookie</parameter></term> <listitem> <para> String containing the value of a <literal>Set-Cookie</literal> response header </para> </listitem> </varlistentry> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> Parse flags </para> </listitem> </varlistentry> <varlistentry> <term><parameter>allowed_extras</parameter></term> <listitem> <para> Array containing recognized <emphasis>extra</emphasis> keys. By default all unkown keys will be treated as cookie names. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an stdClass olike shown in the example on success or FALSE on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Using <function>http_parse_cookie</function></title> <programlisting role="php"> <![CDATA[ <?php print_r(http_parse_cookie("foo=bar; bar=baz; path=/; domain=example.com; comment=; secure", 0, array("comment"))); ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ stdClass Object ( [cookies] => Array ( [foo] => bar [bar] => baz ) [extras] => Array ( [comment] => ) [flags] => 16 [expires] => 0 [path] => / [domain] => example.com ) ]]> </screen> </example> </para> </refsect1> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/parsers/http-parse-headers.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/parsers/http-parse-headers.xml +++ phpdoc/en/reference/http/functions/parsers/http-parse-headers.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-parse-headers"> <refnamediv> <refname>http_parse_headers</refname> <refpurpose>Parse HTTP headers</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>http_parse_headers</methodname> <methodparam><type>string</type><parameter>header</parameter></methodparam> </methodsynopsis> <para> Parses HTTP headers into an associative array. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>header</parameter></term> <listitem> <para> String containing HTTP headers </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an array on success, or FALSE on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Using <function>http_parse_headers</function></title> <programlisting role="php"> <![CDATA[ <?php $headers = "content-type: text/html; charset=UTF-8\r\n". "Server: Funky/1.0\r\n". "Set-Cookie: foo=bar\r\n". "Set-Cookie: baz=quux\r\n". "Folded: works\r\n\ttoo\r\n"; print_r(http_parse_headers($headers)); ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Array ( [Content-Type] => text/html; chatset=UTF-8 [Server] => Funky/1.0 [Set-Cookie] => Array ( [0] => foo=bar [1] => baz=quux ) [Folded] => works too ) ]]> </screen> </example> </para> </refsect1> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/parsers/http-parse-message.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/parsers/http-parse-message.xml +++ phpdoc/en/reference/http/functions/parsers/http-parse-message.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-parse-message"> <refnamediv> <refname>http_parse_message</refname> <refpurpose>Parse HTTP message </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>object</type><methodname>http_parse_message</methodname> <methodparam><type>string</type><parameter>message</parameter></methodparam> </methodsynopsis> <para> Parses (a) http_message(s) into a simple recursive object structure. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>message</parameter></term> <listitem> <para> String containing a single HTTP message or several consecutive HTTP messages </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an hierarchical object structure of the parsed messages. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Using <function>http_parse_message</function> </title> <programlisting role="php"> <![CDATA[ <?php print_r(http_parse_message(http_get(URL, array('redirect' => 3))); ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ stdClass object ( [type] => 2 [httpVersion] => 1.1 [responseCode] => 200 [headers] => Array ( [Content-Length] => 3 [Server] => Apache ) [body] => Hi! [parentMessage] => stdClass object ( [type] => 2 [httpVersion] => 1.1 [responseCode] => 302 [headers] => Array ( [Content-Length] => 0 [Location] => ... ) [body] => [parentMessage] => ... ) ) ]]> </screen> </example> </para> </refsect1> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/parsers/http-parse-params.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/parsers/http-parse-params.xml +++ phpdoc/en/reference/http/functions/parsers/http-parse-params.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-parse-params"> <refnamediv> <refname>http_parse_params</refname> <refpurpose>Parse parameter list</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>object</type><methodname>http_parse_params</methodname> <methodparam choice="opt"><type>string</type><parameter>param</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags = HTTP_PARAMS_DEFAULT</parameter></methodparam> </methodsynopsis> <para> Parse parameter list. </para> <para> See the <link linkend="http.constants.params">params parsing constants table</link> for possible values of the <varname>flags</varname> argument. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>param</parameter></term> <listitem> <para> Parameters </para> </listitem> </varlistentry> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> Parse flags </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns parameter list. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_parse_params</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-get.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-get.xml +++ phpdoc/en/reference/http/functions/requests/http-get.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-get"> <refnamediv> <refname>http_get</refname> <refpurpose>Perform GET request</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_get</methodname> <methodparam choice="opt"><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter></methodparam> </methodsynopsis> <para> Performs an HTTP GET request on the supplied url. </para> <para> The second parameter, if set, is expected to be an associative array where the following options will be recognized: </para> <para id="http.request.options"> <table> <title>HTTP request options</title> <tgroup cols="3"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Description</entry> </row> </thead> <tbody> <row> <entry>redirect</entry><entry>int</entry><entry>whether and how many redirects to follow</entry> </row> <row> <entry>unrestrictedauth</entry><entry>bool</entry><entry>whether to continue sending credentials on redirects to a different host</entry> </row> <row> <entry>proxyhost</entry><entry>string</entry><entry>proxy host in &quot;host[:port]&quot; format</entry> </row> <row> <entry>proxyport</entry><entry>int</entry><entry>use another proxy port as specified in proxyhost</entry> </row> <row> <entry>proxytype</entry><entry>int</entry><entry><constant>HTTP_PROXY_HTTP</constant>, <constant>HTTP_PROXY_SOCKS4</constant> or <constant>HTTP_PROXY_SOCKS5</constant></entry> </row> <row> <entry>proxyauth</entry><entry>string</entry><entry>proxy credentials in &quot;user:pass&quot; format</entry> </row> <row> <entry>proxyauthtype</entry><entry>int</entry><entry><constant>HTTP_AUTH_BASIC</constant> and/or <constant>HTTP_AUTH_NTLM</constant></entry> </row> <row> <entry>httpauth</entry><entry>string</entry><entry>http credentials in &quot;user:pass&quot; format</entry> </row> <row> <entry>httpauthtype</entry><entry>int</entry><entry><constant>HTTP_AUTH_BASIC</constant>, <constant>HTTP_AUTH_DIGEST</constant> and/or <constant>HTTP_AUTH_NTLM</constant></entry> </row> <row> <entry>compress</entry><entry>bool</entry><entry>whether to allow gzip/deflate content encoding</entry> </row> <row> <entry>port</entry><entry>int</entry><entry>use another port as specified in the url</entry> </row> <row> <entry>referer</entry><entry>string</entry><entry>the referer to send</entry> </row> <row> <entry>useragent</entry><entry>string</entry><entry>the user agent to send (defaults to PECL::HTTP/version (PHP/version)))</entry> </row> <row> <entry>headers</entry><entry>array</entry><entry>list of custom headers as associative array like array(&quot;header&quot; => &quot;value&quot;)</entry> </row> <row> <entry>cookies</entry><entry>array</entry><entry>list of cookies as associative array like array(&quot;cookie&quot; => &quot;value&quot;)</entry> </row> <row> <entry>encodecookies</entry><entry>bool</entry><entry>whether to urlencode the cookies (default: true)</entry> </row> <row> <entry>cookiestore</entry><entry>string</entry><entry>path to a file where cookies are/will be stored</entry> </row> <row> <entry>cookiesession</entry><entry>bool</entry><entry>don't load session cookies from cookiestore if TRUE</entry> </row> <row> <entry>resume</entry><entry>int</entry><entry>byte offset to start the download from; if the server supports ranges</entry> </row> <row> <entry>range</entry><entry>array</entry><entry>array of arrays, each containing two integers, specifying the ranges to download if server support is given; only recognized if the resume option is empty</entry> </row> <row> <entry>maxfilesize</entry><entry>int</entry><entry>maximum file size that should be downloaded; has no effect, if the size of the requested entity is</entry> </row> <row> <entry>lastmodified</entry><entry>int</entry><entry>timestamp for If-(Un)Modified-Since header</entry> </row> <row> <entry>etag</entry><entry>string</entry><entry>quoted etag for If-(None-)Match header</entry> </row> <row> <entry>timeout</entry><entry>int</entry><entry>seconds the request may take</entry> </row> <row> <entry>connecttimeout</entry><entry>int</entry><entry>seconds the connect may take</entry> </row> <row> <entry>onprogress</entry><entry>mixed</entry><entry>progress callback</entry> </row> <row> <entry>interface</entry><entry>string</entry><entry>outgoing network interface (ifname, ip or hostname)</entry> </row> <row> <entry>portrange</entry><entry>array</entry><entry>2 integers specifying outgoing portrange to try</entry> </row> <row> <entry>ssl</entry><entry>array</entry> <entry> <para> <table id="http.request.options.ssl"> <title>with the following options:</title> <tgroup cols="3"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Description</entry> </row> </thead> <tbody> <row> <entry>cert</entry><entry>string</entry><entry>path to certificate</entry> </row> <row> <entry>certtype</entry><entry>string</entry><entry>type of certificate</entry> </row> <row> <entry>certpasswd</entry><entry>string</entry><entry>password for certificate</entry> </row> <row> <entry>key</entry><entry>string</entry><entry>path to key</entry> </row> <row> <entry>keytype</entry><entry>string</entry><entry>type of key</entry> </row> <row> <entry>keypasswd</entry><entry>string</entry><entry>pasword for key</entry> </row> <row> <entry>engine</entry><entry>string</entry><entry>ssl engine to use</entry> </row> <row> <entry>version</entry><entry>int</entry><entry>ssl version to use</entry> </row> <row> <entry>verifypeer</entry><entry>bool</entry><entry>whether to verify the peer</entry> </row> <row> <entry>verifyhost</entry><entry>bool whether to verify the host</entry> </row> <row> <entry>cipher_list</entry><entry>string</entry><entry>list of allowed ciphers</entry> </row> <row> <entry>cainfo</entry><entry>string</entry><entry></entry> </row> <row> <entry>capath</entry><entry>string</entry><entry></entry> </row> <row> <entry>random_file</entry><entry>string</entry><entry></entry> </row> <row> <entry>egdsocket</entry><entry>string</entry><entry></entry> </row> </tbody> </tgroup> </table> </para> </entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> URL </para> </listitem> </varlistentry> <varlistentry> <term><parameter>options</parameter></term> <listitem> <para> <link linkend="http.request.options">HTTP request options</link> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>info</parameter></term> <listitem id="http.request.info"> <para> Will be filled with request/response information </para> <para> <screen> <![CDATA[array ( 'effective_url' => 'http://www.example.com/', 'response_code' => 302, 'connect_code' => 0, 'filetime' => -1, 'total_time' => 0.212348, 'namelookup_time' => 0.038296, 'connect_time' => 0.104144, 'pretransfer_time' => 0.104307, 'starttransfer_time' => 0.212077, 'redirect_time' => 0, 'redirect_count' => 0, 'size_upload' => 0, 'size_download' => 218, 'speed_download' => 1026, 'speed_upload' => 0, 'header_size' => 307, 'request_size' => 103, 'ssl_verifyresult' => 0, 'ssl_engines' => array ( 0 => 'dynamic', 1 => 'cswift', 2 => 'chil', 3 => 'atalla', 4 => 'nuron', 5 => 'ubsec', 6 => 'aep', 7 => 'sureware', 8 => '4758cca', ), 'content_length_download' => 218, 'content_length_upload' => 0, 'content_type' => 'text/html', 'httpauth_avail' => 0, 'proxyauth_avail' => 0, 'num_connects' => 1, 'os_errno' => 0, 'error' => '', ) ]]> </screen> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &returns.http.response; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_get</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-head.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-head.xml +++ phpdoc/en/reference/http/functions/requests/http-head.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-head"> <refnamediv> <refname>http_head</refname> <refpurpose>Perform HEAD request</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_head</methodname> <methodparam choice="opt"><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter></methodparam> </methodsynopsis> <para> Performs an HTTP HEAD request on the supplied url. </para> &see.http.request.options; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> URL </para> </listitem> </varlistentry> <varlistentry> <term><parameter>options</parameter></term> <listitem> <para> &link.http.request.options; </para> </listitem> </varlistentry> <varlistentry> <term><parameter>info</parameter></term> <listitem> <para> &link.http.request.info; </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &returns.http.response; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_head</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-post-data.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-post-data.xml +++ phpdoc/en/reference/http/functions/requests/http-post-data.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-post-data"> <refnamediv> <refname>http_post_data</refname> <refpurpose>Perform POST request with pre-encoded data</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_post_data</methodname> <methodparam><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>data</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter></methodparam> </methodsynopsis> <para> Performs an HTTP POST request on the supplied url. </para> &see.http.request.options; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> URL </para> </listitem> </varlistentry> <varlistentry> <term><parameter>data</parameter></term> <listitem> <para> String containing the pre-encoded post data </para> </listitem> </varlistentry> <varlistentry> <term><parameter>options</parameter></term> <listitem> <para> &link.http.request.options; </para> </listitem> </varlistentry> <varlistentry> <term><parameter>info</parameter></term> <listitem> <para> &link.http.request.info; </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &returns.http.response; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_post_data</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-post-fields.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-post-fields.xml +++ phpdoc/en/reference/http/functions/requests/http-post-fields.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-post-fields"> <refnamediv> <refname>http_post_fields</refname> <refpurpose>Perform POST request with data to be encoded</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_post_fields</methodname> <methodparam><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>data</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>files</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter></methodparam> </methodsynopsis> <para> Performs an HTTP POST request on the supplied url. </para> &see.http.request.options; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> URL </para> </listitem> </varlistentry> <varlistentry> <term><parameter>data</parameter></term> <listitem> <para> Associative array of POST values </para> </listitem> </varlistentry> <varlistentry> <term><parameter>files</parameter></term> <listitem> <para> Array of files to post </para> </listitem> </varlistentry> <varlistentry> <term><parameter>options</parameter></term> <listitem> <para> &link.http.request.options; </para> </listitem> </varlistentry> <varlistentry> <term><parameter>info</parameter></term> <listitem> <para> &link.http.request.info; </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &returns.http.response; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_post_fields</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-put-data.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-put-data.xml +++ phpdoc/en/reference/http/functions/requests/http-put-data.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-put-data"> <refnamediv> <refname>http_put_data</refname> <refpurpose>Perform PUT request with data</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_put_data</methodname> <methodparam><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>data</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter></methodparam> </methodsynopsis> <para> Performs an HTTP PUT request on the supplied url. </para> &see.http.request.options; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> URL </para> </listitem> </varlistentry> <varlistentry> <term><parameter>data</parameter></term> <listitem> <para> PUT request body </para> </listitem> </varlistentry> <varlistentry> <term><parameter>options</parameter></term> <listitem> <para> &link.http.request.options; </para> </listitem> </varlistentry> <varlistentry> <term><parameter>info</parameter></term> <listitem> <para> &link.http.request.info; </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &returns.http.response; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_put_data</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-put-file.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-put-file.xml +++ phpdoc/en/reference/http/functions/requests/http-put-file.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-put-file"> <refnamediv> <refname>http_put_file</refname> <refpurpose>Perform PUT request with file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_put_file</methodname> <methodparam><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>file</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter></methodparam> </methodsynopsis> <para> Performs an HTTP PUT request on the supplied url. </para> &see.http.request.options; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> URL </para> </listitem> </varlistentry> <varlistentry> <term><parameter>file</parameter></term> <listitem> <para> The file to put </para> </listitem> </varlistentry> <varlistentry> <term><parameter>options</parameter></term> <listitem> <para> &link.http.request.options; </para> </listitem> </varlistentry> <varlistentry> <term><parameter>info</parameter></term> <listitem> <para> &link.http.request.info; </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &returns.http.response; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_put_file</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-put-stream.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-put-stream.xml +++ phpdoc/en/reference/http/functions/requests/http-put-stream.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-put-stream"> <refnamediv> <refname>http_put_stream</refname> <refpurpose>Perform PUT request with stream</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_put_stream</methodname> <methodparam><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>stream</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter></methodparam> </methodsynopsis> <para> Performs an HTTP PUT request on the supplied url. </para> &see.http.request.options; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> URL </para> </listitem> </varlistentry> <varlistentry> <term><parameter>stream</parameter></term> <listitem> <para> The stream to read the PUT request body from </para> </listitem> </varlistentry> <varlistentry> <term><parameter>options</parameter></term> <listitem> <para> &link.http.request.options; </para> </listitem> </varlistentry> <varlistentry> <term><parameter>info</parameter></term> <listitem> <para> &link.http.request.info; </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &returns.http.response; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_put_stream</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-request-body-encode.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-request-body-encode.xml +++ phpdoc/en/reference/http/functions/requests/http-request-body-encode.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-request-body-encode"> <refnamediv> <refname>http_request_body_encode</refname> <refpurpose>Encode request body</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_request_body_encode</methodname> <methodparam><type>array</type><parameter>fields</parameter></methodparam> <methodparam><type>array</type><parameter>files</parameter></methodparam> </methodsynopsis> <para> Generate x-www-form-urlencoded resp. form-data encoded request body. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>fields</parameter></term> <listitem> <para> POST fields </para> </listitem> </varlistentry> <varlistentry> <term><parameter>files</parameter></term> <listitem> <para> POST files </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns encoded string on success, or FALSE on failure </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_request_body_encode</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-request-method-exists.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-request-method-exists.xml +++ phpdoc/en/reference/http/functions/requests/http-request-method-exists.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-request-method-exists"> <refnamediv> <refname>http_request_method_exists</refname> <refpurpose>Check whether request method exists</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>http_request_method_exists</methodname> <methodparam><type>mixed</type><parameter>method</parameter></methodparam> </methodsynopsis> <para> Check if a request method is registered (or available by default). </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>method</parameter></term> <listitem> <para> request method name or ID </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &true; if the request method is known, else &false;. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_request_method_exists</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-request-method-name.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-request-method-name.xml +++ phpdoc/en/reference/http/functions/requests/http-request-method-name.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-request-method-name"> <refnamediv> <refname>http_request_method_name</refname> <refpurpose>Get request method name</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_request_method_name</methodname> <methodparam><type>int</type><parameter>method</parameter></methodparam> </methodsynopsis> <para> Get the literal string representation of a standard or registered request method. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>method</parameter></term> <listitem> <para> request method ID </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the request method name as string on success, or &false; on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_request_method_name</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-request-method-register.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-request-method-register.xml +++ phpdoc/en/reference/http/functions/requests/http-request-method-register.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-request-method-register"> <refnamediv> <refname>http_request_method_register</refname> <refpurpose>Register request method</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>http_request_method_register</methodname> <methodparam><type>string</type><parameter>method</parameter></methodparam> </methodsynopsis> <para> Register a custom request method. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>method</parameter></term> <listitem> <para> the request method name to register </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the ID of the request method on success, or FALSE on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_request_method_register</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-request-method-unregister.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-request-method-unregister.xml +++ phpdoc/en/reference/http/functions/requests/http-request-method-unregister.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-request-method-unregister"> <refnamediv> <refname>http_request_method_unregister</refname> <refpurpose>Unregister request method</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_request_method_unregister</methodname> <methodparam><type>mixed</type><parameter>method</parameter></methodparam> </methodsynopsis> <para> Unregister a previously registered custom request method. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>method</parameter></term> <listitem> <para> he request method name or ID </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_request_method_unregister</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/requests/http-request.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/requests/http-request.xml +++ phpdoc/en/reference/http/functions/requests/http-request.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-request"> <refnamediv> <refname>http_request</refname> <refpurpose>Perform custom request</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_request</methodname> <methodparam><type>int</type><parameter>method</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>body</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">info</parameter></methodparam> </methodsynopsis> <para> Performs a custom HTTP request on the supplied url. </para> &see.http.request.options; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>method</parameter></term> <listitem> <para> Request method </para> </listitem> </varlistentry> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> URL </para> </listitem> </varlistentry> <varlistentry> <term><parameter>body</parameter></term> <listitem> <para> Request body </para> </listitem> </varlistentry> <varlistentry> <term><parameter>options</parameter></term> <listitem> <para> &link.http.request.options; </para> </listitem> </varlistentry> <varlistentry> <term><parameter>info</parameter></term> <listitem> <para> &link.http.request.info; </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &returns.http.response; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_request</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-redirect.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/responses/http-redirect.xml +++ phpdoc/en/reference/http/functions/responses/http-redirect.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-redirect"> <refnamediv> <refname>http_redirect</refname> <refpurpose>Issue HTTP redirect</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>http_redirect</methodname> <methodparam choice="opt"><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>params</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>session = FALSE</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>status</parameter></methodparam> </methodsynopsis> <para> Redirect to the given url. </para> <para> The supplied url will be expanded with <function>http_build_url</function>, the params array will be treated with <function>http_build_str</function> and the session identification will be appended if session is true. </para> <para> The HTTP response code will be set according to status. </para> <para> You can use one of the <link linkend="http.constants.redirect">redirect constants</link> for convenience. </para> <para> Please see <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3">RFC 2616</ulink> for which redirect response code to use in which situation. </para> <para> By default PHP will decide which response status fits best. </para> <para> To be RFC compliant, &quot;Redirecting to &lt;a&gt;URL&lt;/a&gt;.&quot; will be displayed, if the client doesn't redirect immediately, and the request method was another one than HEAD. </para> <para> A log entry will be written to the redirect log, if the &link.http.configuration; <emphasis>http.log.redirect</emphasis> is set and the redirect attempt was successful. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> the URL to redirect to </para> </listitem> </varlistentry> <varlistentry> <term><parameter>params</parameter></term> <listitem> <para> associative array of query parameters </para> </listitem> </varlistentry> <varlistentry> <term><parameter>session</parameter></term> <listitem> <para> whether to append session information </para> </listitem> </varlistentry> <varlistentry> <term><parameter>false</parameter></term> <listitem> <para> Its description </para> </listitem> </varlistentry> <varlistentry> <term><parameter>status</parameter></term> <listitem> <para> custom response status code </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &false; on failure, or <emphasis>exits</emphasis> on success. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_redirect</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-send-content-disposition.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/responses/http-send-content-disposition.xml +++ phpdoc/en/reference/http/functions/responses/http-send-content-disposition.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-send-content-disposition"> <refnamediv> <refname>http_send_content_disposition</refname> <refpurpose>Send Content-Disposition</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_send_content_disposition</methodname> <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>inline = FALSE</parameter></methodparam> </methodsynopsis> <para> Send the Content-Disposition. The Content-Disposition header is very useful if the data actually sent came from a file or something similar, that should be &quot;saved&quot; by the client/user (i.e. by browsers &quot;Save as...&quot; popup window). </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>filename</parameter></term> <listitem> <para> the file name the &quot;Save as...&quot; dialog should display </para> </listitem> </varlistentry> <varlistentry> <term><parameter>inline</parameter></term> <listitem> <para> if set to true and the user agent knows how to handle the content type, it will probably not cause the popup window to be shown </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_send_content_disposition</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-send-content-type.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/responses/http-send-content-type.xml +++ phpdoc/en/reference/http/functions/responses/http-send-content-type.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-send-content-type"> <refnamediv> <refname>http_send_content_type</refname> <refpurpose>Send Content-Type</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_send_content_type</methodname> <methodparam choice="opt"><type>string</type><parameter>content_type = 'application/x-octetstream'</parameter></methodparam> </methodsynopsis> <para> Send the Content-Type of the sent entity. This is particularly important if you use the <function>http_send</function> API. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>content_type</parameter></term> <listitem> <para> the desired content type (primary/secondary) </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_send_content_type</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-send-data.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/responses/http-send-data.xml +++ phpdoc/en/reference/http/functions/responses/http-send-data.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-send-data"> <refnamediv> <refname>http_send_data</refname> <refpurpose>Send arbitrary data</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_send_data</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> </methodsynopsis> <para> Sends raw data with support for (multiple) range requests. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>data</parameter></term> <listitem> <para> data to send </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_send_data</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-send-file.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/responses/http-send-file.xml +++ phpdoc/en/reference/http/functions/responses/http-send-file.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-send-file"> <refnamediv> <refname>http_send_file</refname> <refpurpose>Send file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_send_file</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> </methodsynopsis> <para> Sends a file with support for (multiple) range requests. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>file</parameter></term> <listitem> <para> the file to send </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_send_file</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-send-last-modified.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/responses/http-send-last-modified.xml +++ phpdoc/en/reference/http/functions/responses/http-send-last-modified.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-send-last-modified"> <refnamediv> <refname>http_send_last_modified</refname> <refpurpose>Send Last-Modified</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_send_last_modified</methodname> <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> </methodsynopsis> <para> Send a <emphasis>Last-Modified</emphasis> header with a valid HTTP date. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>timestamp</parameter></term> <listitem> <para> a unix timestamp, converted it to a valid HTTP date; if omitted, the current time will be sent </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_send_last_modified</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-send-status.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/responses/http-send-status.xml +++ phpdoc/en/reference/http/functions/responses/http-send-status.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-send-status"> <refnamediv> <refname>http_send_status</refname> <refpurpose>Send status</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_send_status</methodname> <methodparam><type>int</type><parameter>status</parameter></methodparam> </methodsynopsis> <para> Send HTTP status code. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>status</parameter></term> <listitem> <para> HTTP status code </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_send_status</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-send-stream.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/responses/http-send-stream.xml +++ phpdoc/en/reference/http/functions/responses/http-send-stream.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-send-stream"> <refnamediv> <refname>http_send_stream</refname> <refpurpose>Send stream</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>http_send_stream</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> </methodsynopsis> <para> Sends an already opened stream with support for (multiple) range requests. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>stream</parameter></term> <listitem> <para> stream to read from (must be seekable) </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_send_stream</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-throttle.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/responses/http-throttle.xml +++ phpdoc/en/reference/http/functions/responses/http-throttle.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-throttle"> <refnamediv> <refname>http_throttle</refname> <refpurpose>HTTP throttling</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>http_throttle</methodname> <methodparam choice="opt"><type>double</type><parameter>sec</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>bytes = 40960</parameter></methodparam> </methodsynopsis> <para> Sets the throttle delay and send buffer size for use with http_send() API. Provides a basic throttling mechanism, which will yield the current process resp. thread until the entity has been completely sent, though. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>sec</parameter></term> <listitem> <para> seconds too sleep after each chunk sent </para> </listitem> </varlistentry> <varlistentry> <term><parameter>bytes</parameter></term> <listitem> <para> the chunk size in bytes </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_throttle</function> example</title> <para> Send file with approximately 20 kbyte/s. </para> <programlisting role="php"> <![CDATA[ <?php // ~ 20 kbyte/s # http_throttle(1, 20000); # http_throttle(0.5, 10000); # http_throttle(0.1, 2000); http_send_file('document.pdf'); ?> ?> ]]> </programlisting> </example> </para> </refsect1> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/urls/http-build-str.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/urls/http-build-str.xml +++ phpdoc/en/reference/http/functions/urls/http-build-str.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-build-str"> <refnamediv> <refname>http_build_str</refname> <refpurpose>Build query string</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_build_str</methodname> <methodparam><type>array</type><parameter>query</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>prefix</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>arg_separator</parameter></methodparam> </methodsynopsis> <para> Opponent to parse_str(). </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>query</parameter></term> <listitem> <para> associative array of query string parameters </para> </listitem> </varlistentry> <varlistentry> <term><parameter>prefix</parameter></term> <listitem> <para> top level prefix </para> </listitem> </varlistentry> <varlistentry> <term><parameter>arg_separator</parameter></term> <listitem> <para> argument separator to use (by default the INI setting arg_separator.output will be used, or &quot;&amp;&quot; if neither is set </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the built query as string on success or &false; on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_build_str</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/urls/http-build-url.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/functions/urls/http-build-url.xml +++ phpdoc/en/reference/http/functions/urls/http-build-url.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-build-url"> <refnamediv> <refname>http_build_url</refname> <refpurpose>Build an URL</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>http_build_url</methodname> <methodparam choice="opt"><type>mixed</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>parts</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags = HTTP_URL_REPLACE</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter role="reference">new_url</parameter></methodparam> </methodsynopsis> <para> Build an URL. </para> <para> The parts of the second URL will be merged into the first according to the flags argument. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>url</parameter></term> <listitem> <para> (part(s) of) an URL in form of a string or associative array like <function>parse_url</function> returns </para> </listitem> </varlistentry> <varlistentry> <term><parameter>parts</parameter></term> <listitem> <para> same as the first argument </para> </listitem> </varlistentry> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> a bitmask of binary or'ed <link linkend="http.constants.url">HTTP_URL constants</link>; <constant>HTTP_URL_REPLACE</constant> is the default </para> </listitem> </varlistentry> <varlistentry> <term><parameter>new_url</parameter></term> <listitem> <para> if set, it will be filled with the parts of the composed url like <function>parse_url</function> would return </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the new URL as string on success or &false; on failure. </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>http_build_url</function> example</title> <programlisting role="php"> <![CDATA[ <?php echo http_build_url("http://user@www.example.com/pub/index.php?a=b#files", array( "scheme" => "ftp", "host" => "ftp.example.com", "path" => "files/current/", "query" => "a=c" ), HTTP_URL_STRIP_AUTH | HTTP_URL_JOIN_PATH | HTTP_URL_JOIN_QUERY | HTTP_URL_STRIP_FRAGMENT ); ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ ftp://ftp.example.com/pub/files/current/?a=b&a=c ]]> </screen> </example> </para> </refsect1> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 -->