WIP: Add Uri extension documentation

appendices/extensions.xml

@@ -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>
@@ -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>

reference/uri/book.xml

@@ -0,0 +1,56 @@
+<?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>URIs</title>
+ <titleabbrev>URIs</titleabbrev>
+
+ <preface xml:id="intro.uri">
+  &reftitle.intro;
+  <para>
+   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.
+  </para>
+  <para>
+   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>. 
+  </para>
+ </preface>
+
+ &reference.uri.uri.uricomparisonmode;
+
+ &reference.uri.uri.rfc3986.uri;
+
+ &reference.uri.uri.whatwg.urlvalidationerrortype;
+ &reference.uri.uri.whatwg.url;
+
+ &reference.uri.uri.urierror;
+ &reference.uri.uri.uriexception;
+ &reference.uri.uri.invaliduriexception;
+</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
+-->
+
+
+

reference/uri/uri.invaliduriexception.xml

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<reference xml:id="class.uri-invaliduriexception" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <title>The Uri\InvalidUriException class</title>
+ <titleabbrev>Uri\InvalidUriException</titleabbrev>
+
+ <partintro>
+
+  <!-- {{{ Uri\InvalidUriException intro -->
+  <section xml:id="uri-invaliduriexception.intro">
+   &reftitle.intro;
+   <para>
+    The base class for <type>Exception</type>s that occur during generation or use of randomness.
+   </para>
+  </section>
+  <!-- }}} -->
+
+  <section xml:id="uri-invaliduriexception.synopsis">
+   &reftitle.classsynopsis;
+
+   <!-- {{{ Synopsis -->
+   <classsynopsis class="class">
+    <ooexception>
+     <exceptionname>Uri\InvalidUriException</exceptionname>
+    </ooexception>
+
+    <ooclass>
+     <modifier>extends</modifier>
+     <classname>Uri\UriException</classname>
+    </ooclass>
+
+    <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
+     <xi:fallback/>
+    </xi:include>
+
+    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='Exception'])">
+     <xi:fallback/>
+    </xi:include>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Exception'])">
+     <xi:fallback/>
+    </xi:include>
+   </classsynopsis>
+   <!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+</reference>
+<!-- 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
+ -->

reference/uri/uri.rfc3986.uri.xml

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="utf-8"?>
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.uri-rfc3986-uri" role="class">
+ <title>The Uri\Rfc3986\Uri class</title>
+ <titleabbrev>Uri\Rfc3986\Uri</titleabbrev>
+
+ <partintro>
+  <!-- {{{ Uri\Rfc3986\Uri intro -->
+  <section xml:id="uri-rfc3986-uri.intro">
+   &reftitle.intro;
+   <para>
+    Represents a Uniform Resource Identifier (URI) as defined in RFC 3986.
+   </para>
+  </section>
+  <!-- }}} -->
+
+  <section xml:id="uri-rfc3986-uri.synopsis">
+   &reftitle.classsynopsis;
+
+   <!-- {{{ Synopsis -->
+   <classsynopsis class="class">
+    <ooclass>
+     <modifier>final</modifier>
+     <modifier>readonly</modifier>
+     <classname>Uri\Rfc3986\Uri</classname>
+    </ooclass>
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.uri-rfc3986-uri')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='Uri\\Rfc3986\\Uri'])">
+     <xi:fallback/>
+    </xi:include>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.uri-rfc3986-uri')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Uri\\Rfc3986\\Uri'])">
+     <xi:fallback/>
+    </xi:include>
+   </classsynopsis>
+   <!-- }}} -->
+
+  </section>
+ </partintro>
+
+ &reference.uri.uri.rfc3986.entities.uri;
+
+</reference>
+<!-- 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
+ -->

reference/uri/uri.uricomparisonmode.xml

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="utf-8"?>
+<reference xml:id="enum.uri-uricomparisionmode" role="enum" xmlns="http://docbook.org/ns/docbook">
+ <title>The Uri\UriComparisonMode enum</title>
+ <titleabbrev>Uri\UriComparisonMode</titleabbrev>
+
+ <partintro>
+  <!-- {{{ Uri\UriComparisonMode intro -->
+  <section xml:id="uri-uricomparisionmode.intro">
+   &reftitle.intro;
+   <para>
+    Defines the modes for comparing two URIs.
+   </para>
+  </section>
+  <!-- }}} -->
+
+  <section xml:id="enum.uricomparisionmode.synopsis">
+   &reftitle.enumsynopsis;
+   <enumsynopsis>
+    <enumname>Uri\UriComparisonMode</enumname>
+
+    <enumitem>
+     <enumidentifier>IncludeFragment</enumidentifier>
+     <enumitemdescription>
+      Compare including fragment
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>ExcludeFragment</enumidentifier>
+     <enumitemdescription>
+      Compare excluding fragment
+     </enumitemdescription>
+    </enumitem>
+   </enumsynopsis>
+  </section>
+ </partintro>
+</reference>
+ <!-- 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
+ -->

reference/uri/uri.urierror.xml

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<reference xml:id="class.uri-urierror" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <title>The Uri\UriError class</title>
+ <titleabbrev>Uri\UriError</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ Uri\UriError intro -->
+  <section xml:id="uri-urierror.intro">
+   &reftitle.intro;
+   <para>
+    The base class for <type>Error</type>s that occur during generation or use of randomness.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="uri-urierror.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis class="class">
+    <ooexception>
+     <exceptionname>Uri\UriError</exceptionname>
+    </ooexception>
+
+    <ooclass>
+     <modifier>extends</modifier>
+     <classname>Error</classname>
+    </ooclass>
+
+    <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.error')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
+     <xi:fallback/>
+    </xi:include>
+
+    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.error')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='Error'])">
+     <xi:fallback/>
+    </xi:include>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.error')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Error'])">
+     <xi:fallback/>
+    </xi:include>
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+</reference>
+<!-- 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
+-->