Skip to content

Document ext/uri #5392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kocsismate wants to merge 1 commit into
base: master
Choose a base branch
from
+6,429 −0
Draft

Document ext/uri #5392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions appendices/extensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@
<listitem><simpara><xref linkend="book.ui"/></simpara></listitem>
<listitem><simpara><xref linkend="book.uodbc"/></simpara></listitem>
<listitem><simpara><xref linkend="book.uopz"/></simpara></listitem>
<listitem><simpara><xref linkend="book.uri"/></simpara></listitem>
<listitem><simpara><xref linkend="book.url"/></simpara></listitem>
<listitem><simpara><xref linkend="book.v8js"/></simpara></listitem>
<listitem><simpara><xref linkend="book.var"/></simpara></listitem>
Expand Down Expand Up @@ -228,6 +229,7 @@
<listitem><para><xref linkend="book.spl"/></para></listitem>
<listitem><para><xref linkend="book.stream"/></para></listitem>
<listitem><para><xref linkend="book.strings"/></para></listitem>
<listitem><para><xref linkend="book.uri"/></para></listitem>
<listitem><para><xref linkend="book.url"/></para></listitem>
<listitem><para><xref linkend="book.var"/></para></listitem>
</itemizedlist>
Expand Down
52 changes: 52 additions & 0 deletions reference/uri/book.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?xml version="1.0" encoding="utf-8"?>
<book xml:id="book.uri" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" annotations="interactive">
<?phpdoc extension-membership="core" ?>
<title>URI</title>
<titleabbrev>URI</titleabbrev>

<preface xml:id="intro.uri">
&reftitle.intro;
<simpara>
This chapter describes the functions that allow you to work with
Uniform Resource Identifiers (URIs). A URI is a string of characters
used to identify a resource. URIs are used in web technologies to
identify resources on the Internet.
</simpara>
<simpara>
URI implements RFC 3986, Uniform Resource Identifier (URI): Generic Syntax,
which can be found at <link xlink:href="http://www.ietf.org/rfc/rfc3986.txt">http://www.ietf.org/rfc/rfc3986.txt</link>.
And WHATWG URL Standard, which can be found at
<link xlink:href="https://url.spec.whatwg.org/">https://url.spec.whatwg.org/</link>.
</simpara>
</preface>

&reference.uri.uri.invaliduriexception;
&reference.uri.uri.urierror;
&reference.uri.uri.uriexception;

&reference.uri.uri.rfc3986.uri;

&reference.uri.uri.whatwg.invalidurlexception;
&reference.uri.uri.whatwg.url;
&reference.uri.uri.whatwg.urlvalidationerror;
</book>
<!-- 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:"~/.phpdoc/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
-->
81 changes: 81 additions & 0 deletions reference/uri/rfc3986/uri/construct.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="uri-rfc3986-uri.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Uri\Rfc3986\Uri::__construct</refname>
<refpurpose>Description</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="Uri\\Rfc3986\\Uri">
<modifier>public</modifier> <methodname>Uri\Rfc3986\Uri::__construct</methodname>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>Uri\Rfc3986\Uri</type><type>null</type></type><parameter>baseUrl</parameter><initializer>&null;</initializer></methodparam>
</constructorsynopsis>
&warn.undocumented.func;
<simpara>
Description.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;

<variablelist>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<simpara>
URI to parse.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>baseUrl</parameter></term>
<listitem>
<simpara>
Description.
</simpara>
</listitem>
</varlistentry>
</variablelist>

</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
When does this function issue <constant>E_*</constant> level errors,
and/or throw <exceptionname>Exception</exceptionname>s.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Uri\Rfc3986\Uri::parse</methodname></member>
<member><methodname>Uri\WhatWg\Url::__construct</methodname></member>
</simplelist>
</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:"~/.phpdoc/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
-->
66 changes: 66 additions & 0 deletions reference/uri/rfc3986/uri/debuginfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="uri-rfc3986-uri.debuginfo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Uri\Rfc3986\Uri::__debugInfo</refname>
<refpurpose>Description</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Uri\\Rfc3986\\Uri">
<modifier>public</modifier> <type>array</type><methodname>Uri\Rfc3986\Uri::__debugInfo</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
<simpara>
Description.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Description.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
When does this function issue <constant>E_*</constant> level errors,
and/or throw <exceptionname>Exception</exceptionname>s.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Uri\WhatWg\Url::__debugInfo</methodname></member>
</simplelist>
</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:"~/.phpdoc/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
-->
113 changes: 113 additions & 0 deletions reference/uri/rfc3986/uri/equals.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="uri-rfc3986-uri.equals" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Uri\Rfc3986\Uri::equals</refname>
<refpurpose>Description</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Uri\\Rfc3986\\Uri">
<modifier>public</modifier> <type>bool</type><methodname>Uri\Rfc3986\Uri::equals</methodname>
<methodparam><type>Uri\Rfc3986\Uri</type><parameter>uri</parameter></methodparam>
<methodparam choice="opt"><type>Uri\UriComparisonMode</type><parameter>comparisonMode</parameter><initializer><constant>Uri\UriComparisonMode::ExcludeFragment</constant></initializer></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<simpara>
Description.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;

<variablelist>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<simpara>
URI to compare the current URI against.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>comparisonMode</parameter></term>
<listitem>
<simpara>
Description.
</simpara>
</listitem>
</varlistentry>
</variablelist>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
When does this function issue <constant>E_*</constant> level errors,
and/or throw <exceptionname>Exception</exceptionname>s.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example xml:id="uri-rfc3986-uri.equals.example.basic">
<title><methodname>Uri\Rfc3986\Uri::equals</methodname> example</title>
<simpara>
Description.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
$uri1 = new \Uri\Rfc3986\Uri("https://example.com");
$uri2 = new \Uri\Rfc3986\Uri("HTTPS://example.com");

var_dump($uri1->equals($uri2));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Uri\WhatWg\Url::equals</methodname></member>
</simplelist>
</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:"~/.phpdoc/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
-->
Loading
Loading