sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-17 01:18:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Namespace the pht extension

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344250 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Thomas Punt 2018-02-13 12:12:25 +00:00
parent efe705d94a
commit 93d68fe8a9
39 changed files with 155 additions and 155 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
reference/pht/atomicinteger/construct.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.atomicinteger.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AtomicInteger::__construct</refname>
<refname>pht\AtomicInteger::__construct</refname>
<refpurpose>AtomicInteger creation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>AtomicInteger</type><methodname>AtomicInteger::__construct</methodname>
<modifier>public</modifier> <type>AtomicInteger</type><methodname>pht\AtomicInteger::__construct</methodname>
<methodparam choice="opt"><type>int</type><parameter>value</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>

6
reference/pht/atomicinteger/dec.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.atomicinteger.dec" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AtomicInteger::dec</refname>
<refname>pht\AtomicInteger::dec</refname>
<refpurpose>Decrements the atomic integer's value by one</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AtomicInteger::dec</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\AtomicInteger::dec</methodname>
<void />
</methodsynopsis>
<para>
@ -18,7 +18,7 @@
the mutex lock of the atomic integer will be acquired, and so there is no
need to manually acquire it (unless this operation needs to be grouped with
other operations on the same atomic integer - see the example in
<methodname>AtomicInteger::lock</methodname> for a demonstration of this).
<methodname>pht\AtomicInteger::lock</methodname> for a demonstration of this).
</para>
</refsect1>

6
reference/pht/atomicinteger/get.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.atomicinteger.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AtomicInteger::get</refname>
<refname>pht\AtomicInteger::get</refname>
<refpurpose>Gets the atomic integer's value</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>AtomicInteger::get</methodname>
<modifier>public</modifier> <type>int</type><methodname>pht\AtomicInteger::get</methodname>
<void />
</methodsynopsis>
<para>
@ -18,7 +18,7 @@
the mutex lock of the atomic integer will be acquired, and so there is no
need to manually acquire it (unless this operation needs to be grouped with
other operations on the same atomic integer - see the example in
<methodname>AtomicInteger::lock</methodname> for a demonstration of this).
<methodname>pht\AtomicInteger::lock</methodname> for a demonstration of this).
</para>
</refsect1>

6
reference/pht/atomicinteger/inc.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.atomicinteger.inc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AtomicInteger::inc</refname>
<refname>pht\AtomicInteger::inc</refname>
<refpurpose>Increments the atomic integer's value by one</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AtomicInteger::inc</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\AtomicInteger::inc</methodname>
<void />
</methodsynopsis>
<para>
@ -18,7 +18,7 @@
the mutex lock of the atomic integer will be acquired, and so there is no
need to manually acquire it (unless this operation needs to be grouped with
other operations on the same atomic integer - see the example in
<methodname>AtomicInteger::lock</methodname> for a demonstration of this).
<methodname>pht\AtomicInteger::lock</methodname> for a demonstration of this).
</para>
</refsect1>

4
reference/pht/atomicinteger/lock.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.atomicinteger.lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AtomicInteger::lock</refname>
<refname>pht\AtomicInteger::lock</refname>
<refpurpose>Acquires the atomic integer's mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AtomicInteger::lock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\AtomicInteger::lock</methodname>
<void />
</methodsynopsis>
<para>

6
reference/pht/atomicinteger/set.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.atomicinteger.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AtomicInteger::set</refname>
<refname>pht\AtomicInteger::set</refname>
<refpurpose>Sets the atomic integer's value</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AtomicInteger::set</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\AtomicInteger::set</methodname>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
@ -18,7 +18,7 @@
lock of the atomic integer will be acquired, and so there is no need to
manually acquire it (unless this operation needs to be grouped with other
operations on the same atomic integer - see the example in
<methodname>AtomicInteger::lock</methodname> for a demonstration of this).
<methodname>pht\AtomicInteger::lock</methodname> for a demonstration of this).
</para>
</refsect1>

4
reference/pht/atomicinteger/unlock.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.atomicinteger.unlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AtomicInteger::unlock</refname>
<refname>pht\AtomicInteger::unlock</refname>
<refpurpose>Releases the atomic integer's mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AtomicInteger::unlock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\AtomicInteger::unlock</methodname>
<void />
</methodsynopsis>
<para>

24
reference/pht/book.xml
View file

@ -20,9 +20,9 @@
</warning>
<para>
The approach to threading that pht takes is to abstract away the thread
itself behind a dedicated object (<classname>Thread</classname>). Tasks are
itself behind a dedicated object (<classname>pht\Thread</classname>). Tasks are
then added to the thread's internal task queue, where they are processed
when the thread is started (via <methodname>Thread::start</methodname>).
when the thread is started (via <methodname>pht\Thread::start</methodname>).
</para>
<para>
All thread tasks will execute in isolation inside of the newly spawned
@ -35,8 +35,8 @@
<para>
The isolation of threading contexts makes the passing around of data
between them somewhat problematic. To solve this problem, threadable data
structures (<classname>HashTable</classname>, <classname>Vector</classname>,
and <classname>Queue</classname>) have been implemented to allow for a
structures (<classname>pht\HashTable</classname>, <classname>pht\Vector</classname>,
and <classname>pht\Queue</classname>) have been implemented to allow for a
two-way communication style between threads, where they expose mutex locks
to control their integrity. These data structures can be safely passed
around between threads, and manipulated by multiple threads using the mutex
@ -47,19 +47,19 @@
</para>
<para>
Atomic values are also supported by pht. Currently, only an
<classname>AtomicInteger</classname> class exists. Like the threaded data
<classname>pht\AtomicInteger</classname> class exists. Like the threaded data
structures, it too can safely be passed around between threads.
</para>
</preface>
&reference.pht.setup;
&reference.pht.thread;
&reference.pht.runnable;
&reference.pht.hashtable;
&reference.pht.vector;
&reference.pht.queue;
&reference.pht.atomicinteger;
&reference.pht.threaded;
&reference.pht.pht.thread;
&reference.pht.pht.runnable;
&reference.pht.pht.hashtable;
&reference.pht.pht.vector;
&reference.pht.pht.queue;
&reference.pht.pht.atomicinteger;
&reference.pht.pht.threaded;
</book>

4
reference/pht/hashtable/lock.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.hashtable.lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>HashTable::lock</refname>
<refname>pht\HashTable::lock</refname>
<refpurpose>Acquires the hash table's mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>HashTable::lock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\HashTable::lock</methodname>
<void />
</methodsynopsis>
<para>

6
reference/pht/hashtable/size.xml
View file

@ -3,19 +3,19 @@
<refentry xml:id="pht.hashtable.size" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>HashTable::size</refname>
<refname>pht\HashTable::size</refname>
<refpurpose>Gets the size of the hash table</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>HashTable::size</methodname>
<modifier>public</modifier> <type>int</type><methodname>pht\HashTable::size</methodname>
<void />
</methodsynopsis>
<para>
Returns the current size of the hash table. This operation requires a
<classname>HashTable</classname>'s mutex lock to be held if it is being used
<classname>pht\HashTable</classname>'s mutex lock to be held if it is being used
by multiple threads.
</para>
</refsect1>

4
reference/pht/hashtable/unlock.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.hashtable.unlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>HashTable::unlock</refname>
<refname>pht\HashTable::unlock</refname>
<refpurpose>Releases the hash table's mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>HashTable::unlock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\HashTable::unlock</methodname>
<void />
</methodsynopsis>
<para>

6
reference/pht/queue/front.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.queue.front" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Queue::front</refname>
<refname>pht\Queue::front</refname>
<refpurpose>Returns the first value from a queue</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Queue::front</methodname>
<modifier>public</modifier> <type>mixed</type><methodname>pht\Queue::front</methodname>
<void />
</methodsynopsis>
<para>
@ -21,7 +21,7 @@
<caution>
<para>
Due to the fact that all values in a <classname>Queue</classname> are
Due to the fact that all values in a <classname>pht\Queue</classname> are
serialised, extracting a value from the queue will require it to be
deserialised. This can incur a noticeable performance hit if the inspection
of the queue's front value is performed within a loop.

4
reference/pht/queue/lock.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.queue.lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Queue::lock</refname>
<refname>pht\Queue::lock</refname>
<refpurpose>Acquires the queue's mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Queue::lock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Queue::lock</methodname>
<void />
</methodsynopsis>
<para>

4
reference/pht/queue/pop.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.queue.pop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Queue::pop</refname>
<refname>pht\Queue::pop</refname>
<refpurpose>Pops a value off of the front of a queue</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Queue::pop</methodname>
<modifier>public</modifier> <type>mixed</type><methodname>pht\Queue::pop</methodname>
<void />
</methodsynopsis>
<para>

6
reference/pht/queue/push.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.queue.push" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Queue::push</refname>
<refname>pht\Queue::push</refname>
<refpurpose>Pushes a value to the end of a queue</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Queue::push</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Queue::push</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
@ -25,7 +25,7 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
The value to be added to a <classname>Queue</classname>. This value will
The value to be added to a <classname>pht\Queue</classname>. This value will
be serialised (since it may be passed around between threads).
</para>
</listitem>

6
reference/pht/queue/size.xml
View file

@ -3,19 +3,19 @@
<refentry xml:id="pht.queue.size" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Queue::size</refname>
<refname>pht\Queue::size</refname>
<refpurpose>Gets the size of the queue</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Queue::size</methodname>
<modifier>public</modifier> <type>int</type><methodname>pht\Queue::size</methodname>
<void />
</methodsynopsis>
<para>
Returns the current size of the queue. This operation requires a
<classname>Queue</classname>'s mutex lock to be held if it is being used by
<classname>pht\Queue</classname>'s mutex lock to be held if it is being used by
multiple threads.
</para>
</refsect1>

4
reference/pht/queue/unlock.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.queue.unlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Queue::unlock</refname>
<refname>pht\Queue::unlock</refname>
<refpurpose>Releases the queue's mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Queue::unlock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Queue::unlock</methodname>
<void />
</methodsynopsis>
<para>

4
reference/pht/runnable/run.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.runnable.run" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Runnable::run</refname>
<refname>pht\Runnable::run</refname>
<refpurpose>The entry point of a threaded class</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Runnable::run</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Runnable::run</methodname>
<void />
</methodsynopsis>
<para>

8
reference/pht/thread/addClassTask.xml
View file

@ -3,19 +3,19 @@
<refentry xml:id="pht.thread.addClassTask" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Thread::addClassTask</refname>
<refname>pht\Thread::addClassTask</refname>
<refpurpose>Class threading</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Thread::addClassTask</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Thread::addClassTask</methodname>
<methodparam><type>string</type><parameter>className</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>...ctorArgs</parameter></methodparam>
</methodsynopsis>
<para>
Adds a new class task to a <classname>Thread</classname>s internal task queue.
Adds a new class task to a <classname>pht\Thread</classname>s internal task queue.
</para>
</refsect1>
@ -27,7 +27,7 @@
<listitem>
<para>
The name of the class to be threaded. This class must implement the
<interfacename>Runnable</interfacename> interface.
<interfacename>pht\Runnable</interfacename> interface.
</para>
</listitem>
</varlistentry>

6
reference/pht/thread/addFileTask.xml
View file

@ -3,19 +3,19 @@
<refentry xml:id="pht.thread.addFileTask" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Thread::addFileTask</refname>
<refname>pht\Thread::addFileTask</refname>
<refpurpose>File threading</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Thread::addFileTask</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Thread::addFileTask</methodname>
<methodparam><type>string</type><parameter>fileName</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>...globals</parameter></methodparam>
</methodsynopsis>
<para>
Adds a new file task to a <classname>Thread</classname>s internal task queue.
Adds a new file task to a <classname>pht\Thread</classname>s internal task queue.
</para>
</refsect1>

6
reference/pht/thread/addFunctionTask.xml
View file

@ -3,19 +3,19 @@
<refentry xml:id="pht.thread.addFunctionTask" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Thread::addFunctionTask</refname>
<refname>pht\Thread::addFunctionTask</refname>
<refpurpose>Function threading</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Thread::addFunctionTask</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Thread::addFunctionTask</methodname>
<methodparam><type>callable</type><parameter>func</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>...funcArgs</parameter></methodparam>
</methodsynopsis>
<para>
Adds a new function task to a <classname>Thread</classname>s internal task queue.
Adds a new function task to a <classname>pht\Thread</classname>s internal task queue.
</para>
</refsect1>

4
reference/pht/thread/join.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.thread.join" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Thread::join</refname>
<refname>pht\Thread::join</refname>
<refpurpose>Joins a thread</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Thread::join</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Thread::join</methodname>
<void />
</methodsynopsis>
<para>

6
reference/pht/thread/start.xml
View file

@ -3,19 +3,19 @@
<refentry xml:id="pht.thread.start" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Thread::start</refname>
<refname>pht\Thread::start</refname>
<refpurpose>Starts the new thread</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Thread::start</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Thread::start</methodname>
<void />
</methodsynopsis>
<para>
This will cause a new thread to be spawned for the associated
<classname>Thread</classname> object, where its internal task queue will
<classname>pht\Thread</classname> object, where its internal task queue will
begin to be processed.
</para>
</refsect1>

6
reference/pht/thread/taskCount.xml
View file

@ -3,18 +3,18 @@
<refentry xml:id="pht.thread.taskCount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Thread::taskCount</refname>
<refname>pht\Thread::taskCount</refname>
<refpurpose>Gets a thread's task count</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Thread::taskCount</methodname>
<modifier>public</modifier> <type>int</type><methodname>pht\Thread::taskCount</methodname>
<void />
</methodsynopsis>
<para>
Retrieves the current task count of a <classname>Thread</classname>.
Retrieves the current task count of a <classname>pht\Thread</classname>.
</para>
</refsect1>

8
reference/pht/threaded/lock.xml
View file

@ -3,20 +3,20 @@
<refentry xml:id="pht.threaded.lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Threaded::lock</refname>
<refname>pht\Threaded::lock</refname>
<refpurpose>Acquires the mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Threaded::lock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Threaded::lock</methodname>
<void />
</methodsynopsis>
<para>
This method will acquire the mutex lock associated with the given class
(either a <classname>HashTable</classname>, <classname>Queue</classname>,
<classname>Vector</classname>, or <classname>AtomicInteger</classname>).
(either a <classname>pht\HashTable</classname>, <classname>pht\Queue</classname>,
<classname>pht\Vector</classname>, or <classname>pht\AtomicInteger</classname>).
</para>
</refsect1>

10
reference/pht/threaded/unlock.xml
View file

@ -3,20 +3,20 @@
<refentry xml:id="pht.threaded.unlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Threaded::unlock</refname>
<refpurpose>Unlocks a mutex lock</refpurpose>
<refname>pht\Threaded::unlock</refname>
<refpurpose>Releases the mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Threaded::unlock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Threaded::unlock</methodname>
<void />
</methodsynopsis>
<para>
This method will unlock the mutex lock associated with the given class
(either a <classname>HashTable</classname>, <classname>Queue</classname>,
<classname>Vector</classname>, or <classname>AtomicInteger</classname>).
(either a <classname>pht\HashTable</classname>, <classname>pht\Queue</classname>,
<classname>pht\Vector</classname>, or <classname>pht\AtomicInteger</classname>).
</para>
</refsect1>

4
reference/pht/vector/construct.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::__construct</refname>
<refname>pht\Vector::__construct</refname>
<refpurpose>Vector creation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Vector</type><methodname>Vector::__construct</methodname>
<modifier>public</modifier> <type>Vector</type><methodname>pht\Vector::__construct</methodname>
<methodparam choice="opt"><type>int</type><parameter>size</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>value</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>

6
reference/pht/vector/deleteAt.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.deleteAt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::deleteAt</refname>
<refname>pht\Vector::deleteAt</refname>
<refpurpose>Deletes a value in the vector</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Vector::deleteAt</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Vector::deleteAt</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
@ -18,7 +18,7 @@
time).
</para>
<para>
Since the <classname>Vector</classname> class supports array access,
Since the <classname>pht\Vector</classname> class supports array access,
deleting values can also be performed using the array subset notation
(<literal>[]</literal>) in combination with the <function>unset</function>
function.

8
reference/pht/vector/insertAt.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.insertAt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::insertAt</refname>
<refname>pht\Vector::insertAt</refname>
<refpurpose>Inserts a value into the vector</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Vector::insertAt</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Vector::insertAt</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
@ -40,8 +40,8 @@
The offset at which the value will be inserted at. This offset must be
within the 0..N range (inclusive), where N is the size of the vector.
Inserting at position N is the equivalent of using
<methodname>Vector::push</methodname>, and inserting at position 0 is the
equivalent of using <methodname>Vector::unshift</methodname>. Attempting
<methodname>pht\Vector::push</methodname>, and inserting at position 0 is the
equivalent of using <methodname>pht\Vector::unshift</methodname>. Attempting
to insert at offsets outside of this range will result in an
<classname>Error</classname> exception.
</para>

4
reference/pht/vector/lock.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::lock</refname>
<refname>pht\Vector::lock</refname>
<refpurpose>Acquires the vector's mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Vector::lock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Vector::lock</methodname>
<void />
</methodsynopsis>
<para>

4
reference/pht/vector/pop.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.pop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::pop</refname>
<refname>pht\Vector::pop</refname>
<refpurpose>Pops a value to the vector</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Vector::pop</methodname>
<modifier>public</modifier> <type>mixed</type><methodname>pht\Vector::pop</methodname>
<void />
</methodsynopsis>
<para>

6
reference/pht/vector/push.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.push" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::push</refname>
<refname>pht\Vector::push</refname>
<refpurpose>Pushes a value to the vector</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Vector::push</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Vector::push</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
@ -18,7 +18,7 @@
vector will automatically be resized if it is not large enough.
</para>
<para>
Since the <classname>Vector</classname> class supports array access, new
Since the <classname>pht\Vector</classname> class supports array access, new
values can also be pushed onto the vector using the empty subset notation
(<literal>[]</literal>).
</para>

4
reference/pht/vector/resize.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.resize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::resize</refname>
<refname>pht\Vector::resize</refname>
<refpurpose>Resizes a vector</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Vector::resize</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Vector::resize</methodname>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>value</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>

4
reference/pht/vector/shift.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.shift" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::shift</refname>
<refname>pht\Vector::shift</refname>
<refpurpose>Shifts a value from the vector</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Vector::shift</methodname>
<modifier>public</modifier> <type>mixed</type><methodname>pht\Vector::shift</methodname>
<void />
</methodsynopsis>
<para>

6
reference/pht/vector/size.xml
View file

@ -3,19 +3,19 @@
<refentry xml:id="pht.vector.size" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::size</refname>
<refname>pht\Vector::size</refname>
<refpurpose>Gets the size of the vector</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Vector::size</methodname>
<modifier>public</modifier> <type>int</type><methodname>pht\Vector::size</methodname>
<void />
</methodsynopsis>
<para>
Returns the current size of the vector. This operation requires a
<classname>Vector</classname>'s mutex lock to be held if it is being used by
<classname>pht\Vector</classname>'s mutex lock to be held if it is being used by
multiple threads.
</para>
</refsect1>

4
reference/pht/vector/unlock.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.unlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::unlock</refname>
<refname>pht\Vector::unlock</refname>
<refpurpose>Releases the vector's mutex lock</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Vector::unlock</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Vector::unlock</methodname>
<void />
</methodsynopsis>
<para>

4
reference/pht/vector/unshift.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.unshift" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::unshift</refname>
<refname>pht\Vector::unshift</refname>
<refpurpose>Unshifts a value to the vector front</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Vector::unshift</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Vector::unshift</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>

6
reference/pht/vector/updateAt.xml
View file

@ -3,14 +3,14 @@
<refentry xml:id="pht.vector.updateAt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Vector::updateAt</refname>
<refname>pht\Vector::updateAt</refname>
<refpurpose>Updates a value in the vector</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Vector::updateAt</methodname>
<modifier>public</modifier> <type>void</type><methodname>pht\Vector::updateAt</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
@ -19,7 +19,7 @@
time). The vector will automatically be resized if it is not large enough.
</para>
<para>
Since the <classname>Vector</classname> class supports array access,
Since the <classname>pht\Vector</classname> class supports array access,
updating values can also be performed using the array subset notation
(<literal>[]</literal>).
</para>

88
reference/pht/versions.xml
View file

@ -4,56 +4,56 @@
Do NOT translate this file
-->
<versions>
<function name='thread' from='PECL pht &gt;= 0.0.1'/>
<function name='thread::addClassTask' from='PECL pht &gt;= 0.0.1'/>
<function name='thread::addFunctionTask' from='PECL pht &gt;= 0.0.1'/>
<function name='thread::addFileTask' from='PECL pht &gt;= 0.0.1'/>
<function name='thread::taskCount' from='PECL pht &gt;= 0.0.1'/>
<function name='thread::start' from='PECL pht &gt;= 0.0.1'/>
<function name='thread::join' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\thread' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\thread::addClassTask' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\thread::addFunctionTask' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\thread::addFileTask' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\thread::taskCount' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\thread::start' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\thread::join' from='PECL pht &gt;= 0.0.1'/>
<function name='runnable' from='PECL pht &gt;= 0.0.1'/>
<function name='runnable::run' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\runnable' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\runnable::run' from='PECL pht &gt;= 0.0.1'/>
<function name='threaded' from='PECL pht &gt;= 0.0.1'/>
<function name='threaded::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='threaded::unlock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\threaded' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\threaded::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\threaded::unlock' from='PECL pht &gt;= 0.0.1'/>
<function name='queue' from='PECL pht &gt;= 0.0.1'/>
<function name='queue::push' from='PECL pht &gt;= 0.0.1'/>
<function name='queue::pop' from='PECL pht &gt;= 0.0.1'/>
<function name='queue::front' from='PECL pht &gt;= 0.0.1'/>
<function name='queue::size' from='PECL pht &gt;= 0.0.1'/>
<function name='queue::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='queue::unlock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\queue' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\queue::push' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\queue::pop' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\queue::front' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\queue::size' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\queue::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\queue::unlock' from='PECL pht &gt;= 0.0.1'/>
<function name='hashtable' from='PECL pht &gt;= 0.0.1'/>
<function name='hashtable::size' from='PECL pht &gt;= 0.0.1'/>
<function name='hashtable::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='hashtable::unlock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\hashtable' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\hashtable::size' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\hashtable::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\hashtable::unlock' from='PECL pht &gt;= 0.0.1'/>
<function name='vector' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::__construct' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::resize' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::push' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::pop' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::shift' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::unshift' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::insertAt' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::updateAt' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::deleteAt' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::size' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='vector::unlock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::__construct' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::resize' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::push' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::pop' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::shift' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::unshift' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::insertAt' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::updateAt' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::deleteAt' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::size' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\vector::unlock' from='PECL pht &gt;= 0.0.1'/>
<function name='atomicinteger' from='PECL pht &gt;= 0.0.1'/>
<function name='atomicinteger::__construct' from='PECL pht &gt;= 0.0.1'/>
<function name='atomicinteger::get' from='PECL pht &gt;= 0.0.1'/>
<function name='atomicinteger::set' from='PECL pht &gt;= 0.0.1'/>
<function name='atomicinteger::inc' from='PECL pht &gt;= 0.0.1'/>
<function name='atomicinteger::dec' from='PECL pht &gt;= 0.0.1'/>
<function name='atomicinteger::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='atomicinteger::unlock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\atomicinteger' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\atomicinteger::__construct' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\atomicinteger::get' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\atomicinteger::set' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\atomicinteger::inc' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\atomicinteger::dec' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\atomicinteger::lock' from='PECL pht &gt;= 0.0.1'/>
<function name='pht\atomicinteger::unlock' from='PECL pht &gt;= 0.0.1'/>
</versions>
<!-- Keep this comment at the end of the file