From 87503b01802756d371fcf53f070ab268de395916 Mon Sep 17 00:00:00 2001
From: Thomas Punt <tpunt@php.net>
Date: Tue, 13 Feb 2018 12:13:29 +0000
Subject: [PATCH] Add renamed pht files

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344251 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/pht/pht.atomicinteger.xml | 82 ++++++++++++++++++++++++++++
 reference/pht/pht.hashtable.xml     | 84 +++++++++++++++++++++++++++++
 reference/pht/pht.queue.xml         | 77 ++++++++++++++++++++++++++
 reference/pht/pht.runnable.xml      | 69 ++++++++++++++++++++++++
 reference/pht/pht.thread.xml        | 74 +++++++++++++++++++++++++
 reference/pht/pht.threaded.xml      | 75 ++++++++++++++++++++++++++
 reference/pht/pht.vector.xml        | 84 +++++++++++++++++++++++++++++
 7 files changed, 545 insertions(+)
 create mode 100644 reference/pht/pht.atomicinteger.xml
 create mode 100644 reference/pht/pht.hashtable.xml
 create mode 100644 reference/pht/pht.queue.xml
 create mode 100644 reference/pht/pht.runnable.xml
 create mode 100644 reference/pht/pht.thread.xml
 create mode 100644 reference/pht/pht.threaded.xml
 create mode 100644 reference/pht/pht.vector.xml

diff --git a/reference/pht/pht.atomicinteger.xml b/reference/pht/pht.atomicinteger.xml
new file mode 100644
index 0000000000..8ee601e471
--- /dev/null
+++ b/reference/pht/pht.atomicinteger.xml
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 344225 $ -->
+
+<phpdoc:classref xml:id="pht.class.atomicinteger" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The AtomicInteger class</title>
+ <titleabbrev>pht\AtomicInteger</titleabbrev>
+  
+ <partintro>
+
+<!-- {{{ AtomicInteger intro -->
+  <section xml:id="pht.atomicinteger.intro">
+   &reftitle.intro;
+   <para>
+    The <classname>pht\AtomicInteger</classname> class is currently the only
+    supported atomic value. It allows for an integer to be safely passed around
+    between, and manipulated, by multiple threads. The methods exposed by this
+    class do not need mutex locking, since they will acquire the internal mutex
+    lock implicitly. <methodname>pht\AtomicInteger::lock</methodname> and
+    <methodname>pht\AtomicInteger::unlock</methodname> are still exposed, however,
+    for when multiple operations involving the same
+    <classname>pht\AtomicInteger</classname> object need to be grouped together.
+   </para>
+   <para>
+    The mutex locks of the atomic values are reentrant safe.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="pht.atomicinteger.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>pht\AtomicInteger</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>pht\AtomicInteger</classname>
+     </ooclass>
+
+     <oointerface>
+      <interfacename>pht\Threaded</interfacename>
+     </oointerface>
+    </classsynopsisinfo>
+<!-- }}} -->
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pht.class.atomicinteger')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.pht.entities.atomicinteger;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
diff --git a/reference/pht/pht.hashtable.xml b/reference/pht/pht.hashtable.xml
new file mode 100644
index 0000000000..d67255c4a8
--- /dev/null
+++ b/reference/pht/pht.hashtable.xml
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 344225 $ -->
+
+<phpdoc:classref xml:id="pht.class.hashtable" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The HashTable class</title>
+ <titleabbrev>pht\HashTable</titleabbrev>
+  
+ <partintro>
+
+<!-- {{{ HashTable intro -->
+  <section xml:id="pht.hashtable.intro">
+   &reftitle.intro;
+   <para>
+    The <classname>pht\HashTable</classname> class is one of the Inter-Thread
+    Communication (ITC) data structures exposed by pht. It can be safely passed
+    around between threads, and manipulated by multiple threads using the mutex
+    locks that have been packed in with the data structure. It is
+    reference-counted across threads, and so it does not need to be explicitly
+    destroyed.
+   </para>
+   <para>
+    The <classname>pht\HashTable</classname> class enables for array access upon
+    its objects (along with the <function>isset</function> and
+    <function>unset</function> functions). The
+    <classname>ArrayAccess</classname> interface is not explicitly implemented,
+    however, because it is only needed for such abilities by userland classes.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="pht.hashtable.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>pht\HashTable</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>pht\HashTable</classname>
+     </ooclass>
+
+     <oointerface>
+      <interfacename>pht\Threaded</interfacename>
+     </oointerface>
+    </classsynopsisinfo>
+<!-- }}} -->
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pht.class.hashtable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.pht.entities.hashtable;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
diff --git a/reference/pht/pht.queue.xml b/reference/pht/pht.queue.xml
new file mode 100644
index 0000000000..9062d1aa3a
--- /dev/null
+++ b/reference/pht/pht.queue.xml
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 344225 $ -->
+
+<phpdoc:classref xml:id="pht.class.queue" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The Queue class</title>
+ <titleabbrev>pht\Queue</titleabbrev>
+  
+ <partintro>
+
+<!-- {{{ Queue intro -->
+  <section xml:id="pht.queue.intro">
+   &reftitle.intro;
+   <para>
+    The <classname>pht\Queue</classname> class is one of the Inter-Thread
+    Communication (ITC) data structures exposed by pht. It can be safely passed
+    around between threads, and manipulated by multiple threads using the mutex
+    locks that have been packed in with the data structure. It is
+    reference-counted across threads, and so it does not need to be explicitly
+    destroyed.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="pht.queue.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>pht\Queue</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>pht\Queue</classname>
+     </ooclass>
+
+     <oointerface>
+      <interfacename>pht\Threaded</interfacename>
+     </oointerface>
+    </classsynopsisinfo>
+<!-- }}} -->
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pht.class.queue')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.pht.entities.queue;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
diff --git a/reference/pht/pht.runnable.xml b/reference/pht/pht.runnable.xml
new file mode 100644
index 0000000000..1d21e62cea
--- /dev/null
+++ b/reference/pht/pht.runnable.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 344225 $ -->
+
+<phpdoc:classref xml:id="pht.class.runnable" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The Runnable interface</title>
+ <titleabbrev>pht\Runnable</titleabbrev>
+  
+ <partintro>
+
+<!-- {{{ Runnable intro -->
+  <section xml:id="pht.runnable.intro">
+   &reftitle.intro;
+   <para>
+    The <interfacename>pht\Runnable</interfacename> interface enforces the
+    implementation of a run() method on classes that should be threaded. This
+    method acts as the entry point of the threaded class.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="pht.runnable.synopsis">
+   &reftitle.interfacesynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>pht\Runnable</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>pht\Runnable</classname>
+     </ooclass>
+   </classsynopsisinfo>
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pht.class.runnable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.pht.entities.runnable;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
diff --git a/reference/pht/pht.thread.xml b/reference/pht/pht.thread.xml
new file mode 100644
index 0000000000..3d73863958
--- /dev/null
+++ b/reference/pht/pht.thread.xml
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 344225 $ -->
+
+<phpdoc:classref xml:id="pht.class.thread" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The Thread class</title>
+ <titleabbrev>pht\Thread</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ pht\Thread intro -->
+  <section xml:id="pht.thread.intro">
+   &reftitle.intro;
+   <para>
+    The <classname>pht\Thread</classname> class abstracts away a native thread. It
+    has an internal task queue, where the methods
+    <methodname>pht\Thread::addClassTask</methodname>,
+    <methodname>pht\Thread::addFunctionTask</methodname>, and
+    <methodname>pht\Thread::addFileTask</methodname> push new tasks onto this
+    queue. Invoking the <methodname>pht\Thread::start</methodname> method will
+    cause the new thread to be spawned, where it will then begin working
+    through the task queue. A thread may be reused for any number of tasks.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="pht.thread.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>pht\Thread</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>pht\Thread</classname>
+     </ooclass>
+    </classsynopsisinfo>
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pht.class.thread')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.pht.entities.thread;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
diff --git a/reference/pht/pht.threaded.xml b/reference/pht/pht.threaded.xml
new file mode 100644
index 0000000000..880b6afb58
--- /dev/null
+++ b/reference/pht/pht.threaded.xml
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 344225 $ -->
+
+<phpdoc:classref xml:id="pht.class.threaded" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The Threaded interface</title>
+ <titleabbrev>pht\Threaded</titleabbrev>
+  
+ <partintro>
+
+<!-- {{{ Threaded intro -->
+  <section xml:id="pht.threaded.intro">
+   &reftitle.intro;
+   <para>
+    The <interfacename>pht\Threaded</interfacename> interface is an internal interface used
+    by the Inter-Thread Communication (ITC) data structures
+    (<classname>pht\HashTable</classname>, <classname>pht\Queue</classname>, and
+    <classname>pht\Vector</classname>). It allows those data structures to be
+    threaded and ensures that the mutex locking API
+    (<methodname>pht\Threaded::lock</methodname> and
+    <methodname>pht\Threaded::unlock</methodname>) is implemented by each of the
+    ITC data structures. It is not implementable by userland classes (since
+    standalone mutex locks are not exposed).
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="pht.threaded.synopsis">
+   &reftitle.interfacesynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>pht\Threaded</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>pht\Threaded</classname>
+     </ooclass>
+   </classsynopsisinfo>
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pht.class.threaded')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.pht.entities.threaded;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
diff --git a/reference/pht/pht.vector.xml b/reference/pht/pht.vector.xml
new file mode 100644
index 0000000000..2375f254fa
--- /dev/null
+++ b/reference/pht/pht.vector.xml
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 344225 $ -->
+
+<phpdoc:classref xml:id="pht.class.vector" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The Vector class</title>
+ <titleabbrev>pht\Vector</titleabbrev>
+  
+ <partintro>
+
+<!-- {{{ Vector intro -->
+  <section xml:id="pht.vector.intro">
+   &reftitle.intro;
+   <para>
+    The <classname>pht\Vector</classname> class is one of the Inter-Thread
+    Communication (ITC) data structures exposed by pht. It can be safely passed
+    around between threads, and manipulated by multiple threads using the mutex
+    locks that have been packed in with the data structure. It is
+    reference-counted across threads, and so is does not need to be explicitly
+    destroyed.
+   </para>
+   <para>
+    The <classname>pht\Vector</classname> class enables for array access upon
+    its objects (along with the <function>isset</function> and
+    <function>unset</function> functions). The
+    <classname>ArrayAccess</classname> interface is not explicitly implemented,
+    however, because it is only needed for such abilities by userland classes.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="pht.vector.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>pht\Vector</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>pht\Vector</classname>
+     </ooclass>
+
+     <oointerface>
+      <interfacename>pht\Threaded</interfacename>
+     </oointerface>
+    </classsynopsisinfo>
+<!-- }}} -->
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pht.class.vector')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.pht.entities.vector;
+
+</phpdoc:classref>
+
+<!-- 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
+-->