nlopess Sat Aug 12 18:00:17 2006 UTC
Added files:
/phpdoc/en/reference/url constants.xml
Modified files:
/phpdoc/en/reference/url reference.xml
/phpdoc/en/reference/url/functions parse-url.xml
Log:
document the 2nd parameter of parse_url() and add its constants
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/url/reference.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/url/reference.xml
diff -u phpdoc/en/reference/url/reference.xml:1.5
phpdoc/en/reference/url/reference.xml:1.6
--- phpdoc/en/reference/url/reference.xml:1.5 Sun Sep 4 19:39:30 2005
+++ phpdoc/en/reference/url/reference.xml Sat Aug 12 18:00:17 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- Purpose: basic.other -->
<!-- Membership: core -->
@@ -35,10 +35,7 @@
&no.resource;
</section>
- <section id="url.constants">
- &reftitle.constants;
- &no.constants;
- </section>
+ &reference.url.constants;
</partintro>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/url/functions/parse-url.xml?r1=1.13&r2=1.14&diff_format=u
Index: phpdoc/en/reference/url/functions/parse-url.xml
diff -u phpdoc/en/reference/url/functions/parse-url.xml:1.13
phpdoc/en/reference/url/functions/parse-url.xml:1.14
--- phpdoc/en/reference/url/functions/parse-url.xml:1.13 Fri Oct 28
18:12:19 2005
+++ phpdoc/en/reference/url/functions/parse-url.xml Sat Aug 12 18:00:17 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.13 $ -->
+<!-- $Revision: 1.14 $ -->
<!-- splitted from ./en/functions/url.xml, last change in rev 1.2 -->
<refentry id="function.parse-url">
<refnamediv>
@@ -9,8 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>array</type><methodname>parse_url</methodname>
+ <type>mixed</type><methodname>parse_url</methodname>
<methodparam><type>string</type><parameter>url</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>component</parameter></methodparam>
</methodsynopsis>
<para>
This function parses a URL and returns an associative array containing any
@@ -37,6 +38,22 @@
</listitem>
</varlistentry>
</variablelist>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>component</parameter></term>
+ <listitem>
+ <para>
+ Specify one of <constant>PHP_URL_SCHEME</constant>,
+ <constant>PHP_URL_HOST</constant>, <constant>PHP_URL_PORT</constant>,
+ <constant>PHP_URL_USER</constant>, <constant>PHP_URL_PASS</constant>,
+ <constant>PHP_URL_PATH</constant>, <constant>PHP_URL_QUERY</constant>
+ or <constant>PHP_URL_FRAGMENT</constant> to retrieve just a specific
+ URL component as a <type>string</type>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
</para>
</refsect1>
@@ -89,6 +106,32 @@
</listitem>
</itemizedlist>
</para>
+ <para>
+ If the <parameter>component</parameter> parameter is specified a
+ <type>string</type> is returned instead of an <type>array</type>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>5.1.2</entry>
+ <entry>Added the <parameter>component</parameter> parameter</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
</refsect1>
<refsect1 role="examples">
@@ -102,6 +145,8 @@
$url = 'http://username:[EMAIL PROTECTED]/path?arg=value#anchor';
print_r(parse_url($url));
+
+echo parse_url($url, PHP_URL_PATH);
?>
]]>
</programlisting>
@@ -118,6 +163,7 @@
[query] => arg=value
[fragment] => anchor
)
+/path
]]>
</screen>
</example>
@@ -146,6 +192,7 @@
<simplelist>
<member><function>pathinfo</function></member>
<member><function>parse_str</function></member>
+ <member><function>http_build_query</function></member>
<member><function>dirname</function></member>
<member><function>basename</function></member>
</simplelist>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/url/constants.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/url/constants.xml
+++ phpdoc/en/reference/url/constants.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="url.constants">
&reftitle.constants;
&extension.constants;
<para>
The following constants are meant to be used with
<function>parse_url</function> and are available since PHP 5.1.2.
</para>
<variablelist>
<varlistentry>
<term>
<constant>PHP_URL_SCHEME</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>PHP_URL_HOST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>PHP_URL_PORT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>PHP_URL_USER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>PHP_URL_PASS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>PHP_URL_PATH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>PHP_URL_QUERY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>PHP_URL_FRAGMENT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
