Skip to content

Commit c074b2a

Browse files
kocsismatekocsismate
committed
Document ext/uri
1 parent c8e3b2c commit c074b2a

71 files changed

Lines changed: 6429 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎appendices/extensions.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@
163163
<listitem><simpara><xref linkend="book.ui"/></simpara></listitem>
164164
<listitem><simpara><xref linkend="book.uodbc"/></simpara></listitem>
165165
<listitem><simpara><xref linkend="book.uopz"/></simpara></listitem>
166+
<listitem><simpara><xref linkend="book.uri"/></simpara></listitem>
166167
<listitem><simpara><xref linkend="book.url"/></simpara></listitem>
167168
<listitem><simpara><xref linkend="book.v8js"/></simpara></listitem>
168169
<listitem><simpara><xref linkend="book.var"/></simpara></listitem>
@@ -228,6 +229,7 @@
228229
<listitem><para><xref linkend="book.spl"/></para></listitem>
229230
<listitem><para><xref linkend="book.stream"/></para></listitem>
230231
<listitem><para><xref linkend="book.strings"/></para></listitem>
232+
<listitem><para><xref linkend="book.uri"/></para></listitem>
231233
<listitem><para><xref linkend="book.url"/></para></listitem>
232234
<listitem><para><xref linkend="book.var"/></para></listitem>
233235
</itemizedlist>

‎reference/uri/book.xml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<book xml:id="book.uri" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" annotations="interactive">
3+
<?phpdoc extension-membership="core" ?>
4+
<title>URI</title>
5+
<titleabbrev>URI</titleabbrev>
6+
7+
<preface xml:id="intro.uri">
8+
&reftitle.intro;
9+
<simpara>
10+
This chapter describes the functions that allow you to work with
11+
Uniform Resource Identifiers (URIs). A URI is a string of characters
12+
used to identify a resource. URIs are used in web technologies to
13+
identify resources on the Internet.
14+
</simpara>
15+
<simpara>
16+
URI implements RFC 3986, Uniform Resource Identifier (URI): Generic Syntax,
17+
which can be found at <link xlink:href="http://www.ietf.org/rfc/rfc3986.txt">http://www.ietf.org/rfc/rfc3986.txt</link>.
18+
And WHATWG URL Standard, which can be found at
19+
<link xlink:href="https://url.spec.whatwg.org/">https://url.spec.whatwg.org/</link>.
20+
</simpara>
21+
</preface>
22+
23+
&reference.uri.uri.invaliduriexception;
24+
&reference.uri.uri.urierror;
25+
&reference.uri.uri.uriexception;
26+
27+
&reference.uri.uri.rfc3986.uri;
28+
29+
&reference.uri.uri.whatwg.invalidurlexception;
30+
&reference.uri.uri.whatwg.url;
31+
&reference.uri.uri.whatwg.urlvalidationerror;
32+
</book>
33+
<!-- Keep this comment at the end of the file
34+
Local variables:
35+
mode: sgml
36+
sgml-omittag:t
37+
sgml-shorttag:t
38+
sgml-minimize-attributes:nil
39+
sgml-always-quote-attributes:t
40+
sgml-indent-step:1
41+
sgml-indent-data:t
42+
indent-tabs-mode:nil
43+
sgml-parent-document:nil
44+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
45+
sgml-exposed-tags:nil
46+
sgml-local-catalogs:nil
47+
sgml-local-ecat-files:nil
48+
End:
49+
vim600: syn=xml fen fdm=syntax fdl=2 si
50+
vim: et tw=78 syn=sgml
51+
vi: ts=1 sw=1
52+
-->

‎reference/uri/rfc3986/uri/construct.xml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="uri-rfc3986-uri.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
3+
<refnamediv>
4+
<refname>Uri\Rfc3986\Uri::__construct</refname>
5+
<refpurpose>Description</refpurpose>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<constructorsynopsis role="Uri\\Rfc3986\\Uri">
11+
<modifier>public</modifier> <methodname>Uri\Rfc3986\Uri::__construct</methodname>
12+
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
13+
<methodparam choice="opt"><type class="union"><type>Uri\Rfc3986\Uri</type><type>null</type></type><parameter>baseUrl</parameter><initializer>&null;</initializer></methodparam>
14+
</constructorsynopsis>
15+
&warn.undocumented.func;
16+
<simpara>
17+
Description.
18+
</simpara>
19+
</refsect1>
20+
21+
<refsect1 role="parameters">
22+
&reftitle.parameters;
23+
24+
<variablelist>
25+
<varlistentry>
26+
<term><parameter>uri</parameter></term>
27+
<listitem>
28+
<simpara>
29+
URI to parse.
30+
</simpara>
31+
</listitem>
32+
</varlistentry>
33+
<varlistentry>
34+
<term><parameter>baseUrl</parameter></term>
35+
<listitem>
36+
<simpara>
37+
Description.
38+
</simpara>
39+
</listitem>
40+
</varlistentry>
41+
</variablelist>
42+
43+
</refsect1>
44+
45+
<refsect1 role="errors">
46+
&reftitle.errors;
47+
<simpara>
48+
When does this function issue <constant>E_*</constant> level errors,
49+
and/or throw <exceptionname>Exception</exceptionname>s.
50+
</simpara>
51+
</refsect1>
52+
53+
<refsect1 role="seealso">
54+
&reftitle.seealso;
55+
<simplelist>
56+
<member><methodname>Uri\Rfc3986\Uri::parse</methodname></member>
57+
<member><methodname>Uri\WhatWg\Url::__construct</methodname></member>
58+
</simplelist>
59+
</refsect1>
60+
61+
</refentry>
62+
<!-- Keep this comment at the end of the file
63+
Local variables:
64+
mode: sgml
65+
sgml-omittag:t
66+
sgml-shorttag:t
67+
sgml-minimize-attributes:nil
68+
sgml-always-quote-attributes:t
69+
sgml-indent-step:1
70+
sgml-indent-data:t
71+
indent-tabs-mode:nil
72+
sgml-parent-document:nil
73+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
74+
sgml-exposed-tags:nil
75+
sgml-local-catalogs:nil
76+
sgml-local-ecat-files:nil
77+
End:
78+
vim600: syn=xml fen fdm=syntax fdl=2 si
79+
vim: et tw=78 syn=sgml
80+
vi: ts=1 sw=1
81+
-->

‎reference/uri/rfc3986/uri/debuginfo.xml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="uri-rfc3986-uri.debuginfo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
3+
<refnamediv>
4+
<refname>Uri\Rfc3986\Uri::__debugInfo</refname>
5+
<refpurpose>Description</refpurpose>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="Uri\\Rfc3986\\Uri">
11+
<modifier>public</modifier> <type>array</type><methodname>Uri\Rfc3986\Uri::__debugInfo</methodname>
12+
<void/>
13+
</methodsynopsis>
14+
&warn.undocumented.func;
15+
<simpara>
16+
Description.
17+
</simpara>
18+
</refsect1>
19+
20+
<refsect1 role="parameters">
21+
&reftitle.parameters;
22+
&no.function.parameters;</refsect1>
23+
24+
<refsect1 role="returnvalues">
25+
&reftitle.returnvalues;
26+
<simpara>
27+
Description.
28+
</simpara>
29+
</refsect1>
30+
31+
<refsect1 role="errors">
32+
&reftitle.errors;
33+
<simpara>
34+
When does this function issue <constant>E_*</constant> level errors,
35+
and/or throw <exceptionname>Exception</exceptionname>s.
36+
</simpara>
37+
</refsect1>
38+
39+
<refsect1 role="seealso">
40+
&reftitle.seealso;
41+
<simplelist>
42+
<member><methodname>Uri\WhatWg\Url::__debugInfo</methodname></member>
43+
</simplelist>
44+
</refsect1>
45+
46+
</refentry>
47+
<!-- Keep this comment at the end of the file
48+
Local variables:
49+
mode: sgml
50+
sgml-omittag:t
51+
sgml-shorttag:t
52+
sgml-minimize-attributes:nil
53+
sgml-always-quote-attributes:t
54+
sgml-indent-step:1
55+
sgml-indent-data:t
56+
indent-tabs-mode:nil
57+
sgml-parent-document:nil
58+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
59+
sgml-exposed-tags:nil
60+
sgml-local-catalogs:nil
61+
sgml-local-ecat-files:nil
62+
End:
63+
vim600: syn=xml fen fdm=syntax fdl=2 si
64+
vim: et tw=78 syn=sgml
65+
vi: ts=1 sw=1
66+
-->

‎reference/uri/rfc3986/uri/equals.xml‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="uri-rfc3986-uri.equals" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
3+
<refnamediv>
4+
<refname>Uri\Rfc3986\Uri::equals</refname>
5+
<refpurpose>Description</refpurpose>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="Uri\\Rfc3986\\Uri">
11+
<modifier>public</modifier> <type>bool</type><methodname>Uri\Rfc3986\Uri::equals</methodname>
12+
<methodparam><type>Uri\Rfc3986\Uri</type><parameter>uri</parameter></methodparam>
13+
<methodparam choice="opt"><type>Uri\UriComparisonMode</type><parameter>comparisonMode</parameter><initializer><constant>Uri\UriComparisonMode::ExcludeFragment</constant></initializer></methodparam>
14+
</methodsynopsis>
15+
&warn.undocumented.func;
16+
<simpara>
17+
Description.
18+
</simpara>
19+
</refsect1>
20+
21+
<refsect1 role="parameters">
22+
&reftitle.parameters;
23+
24+
<variablelist>
25+
<varlistentry>
26+
<term><parameter>uri</parameter></term>
27+
<listitem>
28+
<simpara>
29+
URI to compare the current URI against.
30+
</simpara>
31+
</listitem>
32+
</varlistentry>
33+
<varlistentry>
34+
<term><parameter>comparisonMode</parameter></term>
35+
<listitem>
36+
<simpara>
37+
Description.
38+
</simpara>
39+
</listitem>
40+
</varlistentry>
41+
</variablelist>
42+
43+
</refsect1>
44+
45+
<refsect1 role="returnvalues">
46+
&reftitle.returnvalues;
47+
<simpara>
48+
&return.success;
49+
</simpara>
50+
</refsect1>
51+
52+
<refsect1 role="errors">
53+
&reftitle.errors;
54+
<simpara>
55+
When does this function issue <constant>E_*</constant> level errors,
56+
and/or throw <exceptionname>Exception</exceptionname>s.
57+
</simpara>
58+
</refsect1>
59+
60+
<refsect1 role="examples">
61+
&reftitle.examples;
62+
<example xml:id="uri-rfc3986-uri.equals.example.basic">
63+
<title><methodname>Uri\Rfc3986\Uri::equals</methodname> example</title>
64+
<simpara>
65+
Description.
66+
</simpara>
67+
<programlisting role="php">
68+
<![CDATA[
69+
<?php
70+
$uri1 = new \Uri\Rfc3986\Uri("https://example.com");
71+
$uri2 = new \Uri\Rfc3986\Uri("HTTPS://example.com");
72+
73+
var_dump($uri1->equals($uri2));
74+
?>
75+
]]>
76+
</programlisting>
77+
&example.outputs;
78+
<screen>
79+
<![CDATA[
80+
bool(true)
81+
]]>
82+
</screen>
83+
</example>
84+
</refsect1>
85+
86+
<refsect1 role="seealso">
87+
&reftitle.seealso;
88+
<simplelist>
89+
<member><methodname>Uri\WhatWg\Url::equals</methodname></member>
90+
</simplelist>
91+
</refsect1>
92+
93+
</refentry>
94+
<!-- Keep this comment at the end of the file
95+
Local variables:
96+
mode: sgml
97+
sgml-omittag:t
98+
sgml-shorttag:t
99+
sgml-minimize-attributes:nil
100+
sgml-always-quote-attributes:t
101+
sgml-indent-step:1
102+
sgml-indent-data:t
103+
indent-tabs-mode:nil
104+
sgml-parent-document:nil
105+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
106+
sgml-exposed-tags:nil
107+
sgml-local-catalogs:nil
108+
sgml-local-ecat-files:nil
109+
End:
110+
vim600: syn=xml fen fdm=syntax fdl=2 si
111+
vim: et tw=78 syn=sgml
112+
vi: ts=1 sw=1
113+
-->

0 commit comments

Comments
 (0)