php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

[skip-revcheck] Correct indentation (#4454)

Browse Source
This commit is contained in:
Marcos Porto Mariño
2025-04-24 16:27:51 +02:00
committed by GitHub
parent e908bfda98
commit c9490d424e
34 changed files with 299 additions and 286 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
reference/bc/functions/bcpow.xml
View File

@@ -151,7 +151,7 @@ echo bcpow('5', '2', 2); // prints "25", not "25.00"
<simplelist>
<member><function>bcpowmod</function></member>
<member><function>bcsqrt</function></member>
<member><methodname>BcMath\Number::pow</methodname></member>
<member><methodname>BcMath\Number::pow</methodname></member>
</simplelist>
</para>
</refsect1>

78
reference/datetime/datetime.xml
View File

@@ -64,45 +64,45 @@
<!-- }}} -->
</section>
<section role="changelog" xml:id="datetime.changelog"><!-- {{{ -->
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The class constants are now typed.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
The class constants of <classname>DateTime</classname> are now defined
on <classname>DateTimeInterface</classname>.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
The <classname>DateTime</classname> constructor now includes the
current microseconds in the constructed value. Before this, it would
always initialise the microseconds to <literal>0</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section><!-- }}} -->
<section role="changelog" xml:id="datetime.changelog"><!-- {{{ -->
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The class constants are now typed.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
The class constants of <classname>DateTime</classname> are now defined
on <classname>DateTimeInterface</classname>.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>
The <classname>DateTime</classname> constructor now includes the
current microseconds in the constructed value. Before this, it would
always initialise the microseconds to <literal>0</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section><!-- }}} -->
</partintro>

70
reference/datetime/datetimeinterface.xml
View File

@@ -353,41 +353,41 @@
</section>
<!-- }}} -->
<section role="changelog" xml:id="datetimeinterface.changelog"><!-- {{{ -->
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>The class constants are now typed.</entry>
</row>
<row>
<entry>8.2.0</entry>
<entry>
The constant <constant linkend="datetimeinterface.constants.iso8601-expanded">DateTimeInterface::ISO8601_EXPANDED</constant>
was added.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
The class constants of <classname>DateTime</classname> are now defined
on <interfacename>DateTimeInterface</interfacename>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section><!-- }}} -->
<section role="changelog" xml:id="datetimeinterface.changelog"><!-- {{{ -->
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>The class constants are now typed.</entry>
</row>
<row>
<entry>8.2.0</entry>
<entry>
The constant <constant linkend="datetimeinterface.constants.iso8601-expanded">DateTimeInterface::ISO8601_EXPANDED</constant>
was added.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
The class constants of <classname>DateTime</classname> are now defined
on <interfacename>DateTimeInterface</interfacename>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section><!-- }}} -->
</partintro>

88
reference/datetime/functions/strptime.xml
View File

@@ -150,9 +150,9 @@
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>strptime</function> example</title>
<programlisting role="php">
@@ -166,9 +166,9 @@ echo "$strf\n";
print_r(strptime($strf, $format));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
03/10/2004 15:54:19
@@ -185,46 +185,46 @@ Array
[unparsed] =>
)
]]>
</screen>
</example>
</para>
</refsect1>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.no-windows;
<note>
<para>
Internally, this function calls the <literal>strptime()</literal>
function provided by the system's C library. This function can exhibit
noticeably different behaviour across different operating systems. The
use of <function>date_parse_from_format</function>, which does not
suffer from these issues, is recommended.
</para>
</note>
<note>
<para>
<literal>"tm_sec"</literal> includes any leap seconds (currently upto 2
a year). For more information on leap seconds, see the <link
xlink:href="&url.wiki.leap-seconds;">Wikipedia article
on leap seconds</link>.
</para>
</note>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.no-windows;
<note>
<para>
Internally, this function calls the <literal>strptime()</literal>
function provided by the system's C library. This function can exhibit
noticeably different behaviour across different operating systems. The
use of <function>date_parse_from_format</function>, which does not
suffer from these issues, is recommended.
</para>
</note>
<note>
<para>
<literal>"tm_sec"</literal> includes any leap seconds (currently upto 2
a year). For more information on leap seconds, see the <link
xlink:href="&url.wiki.leap-seconds;">Wikipedia article
on leap seconds</link>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>IntlDateFormatter::parse</methodname></member>
<member><methodname>DateTime::createFromFormat</methodname></member>
<member><function>checkdate</function></member>
<member><function>strftime</function></member>
<member><function>date_parse_from_format</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>IntlDateFormatter::parse</methodname></member>
<member><methodname>DateTime::createFromFormat</methodname></member>
<member><function>checkdate</function></member>
<member><function>strftime</function></member>
<member><function>date_parse_from_format</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

32
reference/sync/book.xml
View File

@@ -9,29 +9,29 @@
<preface xml:id="intro.sync">
&reftitle.intro;
<para>
The <literal>sync</literal> extension introduces cross-platform synchonization objects into PHP.
Named and unnamed Mutex, Semaphore, Event, Reader-Writer, and named Shared Memory
objects provide OS-level synchronization on both POSIX (e.g. Linux) and Windows
platforms.
The <literal>sync</literal> extension introduces cross-platform synchonization objects into PHP.
Named and unnamed Mutex, Semaphore, Event, Reader-Writer, and named Shared Memory
objects provide OS-level synchronization on both POSIX (e.g. Linux) and Windows
platforms.
</para>
<para>
Automatic cleanup of acquired synchronization objects takes place during extension
teardown. This means that if PHP prematurely terminates a script (e.g. script
execution time is exceeded), objects will not be left in an unknown state. The
only exception to this is if PHP itself crashes (e.g. an internal buffer overflow).
Automatic cleanup of acquired synchronization objects takes place during extension
teardown. This means that if PHP prematurely terminates a script (e.g. script
execution time is exceeded), objects will not be left in an unknown state. The
only exception to this is if PHP itself crashes (e.g. an internal buffer overflow).
</para>
<para>
Unnamed synchronization objects don't have a lot of use outside of a multithreaded
scenario. Unnamed objects are more useful in conjunction with the pthreads PECL
extension.
Unnamed synchronization objects don't have a lot of use outside of a multithreaded
scenario. Unnamed objects are more useful in conjunction with the pthreads PECL
extension.
</para>
<note>
<para>
Named objects require additional care to be used on all systems.
If an object is instantiated with a specific set of parameters, it must always
be instantiated with those parameters or the object will probably end up in an
inconsistent state until the next reboot or a system administrator cleans up
the mess.
Named objects require additional care to be used on all systems.
If an object is instantiated with a specific set of parameters, it must always
be instantiated with those parameters or the object will probably end up in an
inconsistent state until the next reboot or a system administrator cleans up
the mess.
</para>
</note>
</preface>

2
reference/sync/configure.xml
View File

@@ -9,10 +9,8 @@
<link xlink:href="&url.pecl.package;sync">&url.pecl.package;sync</link>
</para>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

2
reference/sync/setup.xml
View File

@@ -7,7 +7,7 @@
<section xml:id="sync.requirements">
&reftitle.required;
<para>
A system with support for POSIX shared memory (shm_open()) or running Windows.
A system with support for POSIX shared memory (shm_open()) or running Windows.
</para>
</section>

13
reference/sync/syncevent.xml
View File

@@ -12,14 +12,15 @@
<section xml:id="syncevent.intro">
&reftitle.intro;
<para>
A cross-platform, native implementation of named and unnamed event objects. Both automatic and manual event objects are supported.
A cross-platform, native implementation of named and unnamed event objects.
Both automatic and manual event objects are supported.
</para>
<para>
An event object waits, without polling, for the object to be fired/set.
One instance waits on the event object while another instance fires/sets
the event. Event objects are useful wherever a long-running process would
otherwise poll a resource (e.g. checking to see if uploaded data needs to
be processed).
An event object waits, without polling, for the object to be fired/set.
One instance waits on the event object while another instance fires/sets
the event. Event objects are useful wherever a long-running process would
otherwise poll a resource (e.g. checking to see if uploaded data needs to
be processed).
</para>
</section>
<!-- }}} -->

8
reference/sync/syncmutex.xml
View File

@@ -12,12 +12,12 @@
<section xml:id="syncmutex.intro">
&reftitle.intro;
<para>
A cross-platform, native implementation of named and unnamed countable mutex objects.
A cross-platform, native implementation of named and unnamed countable mutex objects.
</para>
<para>
A mutex is a mutual exclusion object that restricts access to a shared resource (e.g. a file) to a single instance.
Countable mutexes acquire the mutex a single time and internally track the number of times the mutex is locked.
The mutex is unlocked as soon as it goes out of scope or is unlocked the same number of times that it was locked.
A mutex is a mutual exclusion object that restricts access to a shared resource (e.g. a file) to a single instance.
Countable mutexes acquire the mutex a single time and internally track the number of times the mutex is locked.
The mutex is unlocked as soon as it goes out of scope or is unlocked the same number of times that it was locked.
</para>
</section>
<!-- }}} -->

8
reference/sync/syncreaderwriter.xml
View File

@@ -12,12 +12,12 @@
<section xml:id="syncreaderwriter.intro">
&reftitle.intro;
<para>
A cross-platform, native implementation of named and unnamed reader-writer objects.
A cross-platform, native implementation of named and unnamed reader-writer objects.
</para>
<para>
A reader-writer object allows many readers or one writer to access a resource.
This is an efficient solution for managing resources where access will primarily be
read-only but exclusive write access is occasionally necessary.
A reader-writer object allows many readers or one writer to access a resource.
This is an efficient solution for managing resources where access will primarily be
read-only but exclusive write access is occasionally necessary.
</para>
</section>
<!-- }}} -->

8
reference/sync/syncsemaphore.xml
View File

@@ -12,12 +12,12 @@
<section xml:id="syncsemaphore.intro">
&reftitle.intro;
<para>
A cross-platform, native implementation of named and unnamed semaphore objects.
A cross-platform, native implementation of named and unnamed semaphore objects.
</para>
<para>
A semaphore restricts access to a limited resource to a limited number of instances.
Semaphores differ from mutexes in that they can allow more than one instance to
access a resource at one time while a mutex only allows one instance at a time.
A semaphore restricts access to a limited resource to a limited number of instances.
Semaphores differ from mutexes in that they can allow more than one instance to
access a resource at one time while a mutex only allows one instance at a time.
</para>
</section>
<!-- }}} -->

14
reference/sync/syncsharedmemory.xml
View File

@@ -12,17 +12,17 @@
<section xml:id="syncsharedmemory.intro">
&reftitle.intro;
<para>
A cross-platform, native, consistent implementation of named shared memory
objects.
A cross-platform, native, consistent implementation of named shared memory
objects.
</para>
<para>
Shared memory lets two separate processes communicate without the need for
complex pipes or sockets. There are several integer-based shared memory
implementations for PHP. Named shared memory is an alternative.
Shared memory lets two separate processes communicate without the need for
complex pipes or sockets. There are several integer-based shared memory
implementations for PHP. Named shared memory is an alternative.
</para>
<para>
Synchronization objects (e.g. SyncMutex) are still required to protect most
uses of shared memory.
Synchronization objects (e.g. SyncMutex) are still required to protect most
uses of shared memory.
</para>
</section>
<!-- }}} -->

18
reference/sync/syncsharedmemory/read.xml
View File

@@ -15,7 +15,7 @@
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Copies data from named shared memory.
Copies data from named shared memory.
</para>
</refsect1>
@@ -26,12 +26,12 @@
<term><parameter>start</parameter></term>
<listitem>
<para>
The start/offset, in bytes, to begin reading.
The start/offset, in bytes, to begin reading.
</para>
<note>
<para>
If the value is negative, the starting position will begin at the specified
number of bytes from the end of the shared memory segment.
If the value is negative, the starting position will begin at the specified
number of bytes from the end of the shared memory segment.
</para>
</note>
</listitem>
@@ -40,15 +40,15 @@
<term><parameter>length</parameter></term>
<listitem>
<para>
The number of bytes to read.
The number of bytes to read.
</para>
<note>
<para>
If unspecified, reading will stop at the end of the shared memory segment.
If unspecified, reading will stop at the end of the shared memory segment.
</para>
<para>
If the value is negative, reading will stop the specified number of bytes
from the end of the shared memory segment.
If the value is negative, reading will stop the specified number of bytes
from the end of the shared memory segment.
</para>
</note>
</listitem>
@@ -59,7 +59,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string containing the data read from shared memory.
A string containing the data read from shared memory.
</para>
</refsect1>

11
reference/uopz/book.xml
View File

@@ -9,11 +9,14 @@
<preface xml:id="intro.uopz">
&reftitle.intro;
<para>
The uopz - User Operations for Zend - extension exposes Zend Engine functionality normally used at compilation and execution time in order to
allow modification of the internal structures that represent PHP code, and for user code to interact with the VM.
The uopz - User Operations for Zend -
extension exposes Zend Engine functionality normally
used at compilation and execution time in order to
allow modification of the internal structures that represent PHP code,
and for user code to interact with the VM.
</para>
<para>
uopz supports the following activities:
uopz supports the following activities:
</para>
<simplelist>
<member>Overloading some opcodes including ZEND_EXIT and ZEND_NEW</member>
@@ -27,7 +30,7 @@
</simplelist>
<note>
<para>
All of the activities supported are compatible with opcache
All of the activities supported are compatible with opcache
</para>
</note>
<caution>

89
reference/uopz/constants.xml
View File

@@ -16,7 +16,8 @@
</term>
<listitem>
<simpara>
Invoked by exit() and die(), receives no arguments. Return boolean &true; to exit, &false; to continue
Invoked by exit() and die(), receives no arguments.
Return boolean &true; to exit, &false; to continue
</simpara>
</listitem>
</varlistentry>
@@ -27,7 +28,8 @@
</term>
<listitem>
<simpara>
Invoked by object construction, receives the class of object being created as the only argument
Invoked by object construction,
receives the class of object being created as the only argument
</simpara>
</listitem>
</varlistentry>
@@ -38,7 +40,8 @@
</term>
<listitem>
<simpara>
Invoked by the throw construct, receives the class of exception being thrown as the only argument
Invoked by the throw construct,
receives the class of exception being thrown as the only argument
</simpara>
</listitem>
</varlistentry>
@@ -49,7 +52,8 @@
</term>
<listitem>
<simpara>
Invoked upon composure, receives the class the name of the class being fetched as the only argument
Invoked upon composure,
receives the class the name of the class being fetched as the only argument
</simpara>
</listitem>
</varlistentry>
@@ -60,7 +64,9 @@
</term>
<listitem>
<simpara>
Invoked upon composure, receives the class the trait is being added to as the first argument, and the name of the trait as the second argument
Invoked upon composure,
receives the class the trait is being added to as the first argument,
and the name of the trait as the second argument
</simpara>
</listitem>
</varlistentry>
@@ -71,7 +77,9 @@
</term>
<listitem>
<simpara>
Invoked upon composure, receives the class the interface is being added to as the first argument, and the name of the interface as the second argument
Invoked upon composure,
receives the class the interface is being added to as the first argument,
and the name of the interface as the second argument
</simpara>
</listitem>
</varlistentry>
@@ -82,15 +90,18 @@
</term>
<listitem>
<simpara>
Invoked by instanceof operator, receives the object being verified as the first argument, and the name of the class which that object should be as the second argument
Invoked by instanceof operator,
receives the object being verified as the first argument,
and the name of the class which that object should be as the second argument
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The following constants control the VM's behaviour after a user handler is invoked, be extremely careful!
These constants are removed as of uopz 5.0.0.
The following constants control the VM's behaviour after a user handler is invoked,
be extremely careful!
These constants are removed as of uopz 5.0.0.
</para>
<para>
<variablelist>
@@ -101,7 +112,7 @@
</term>
<listitem>
<simpara>
Advance 1 opcode and continuue
Advance 1 opcode and continuue
</simpara>
</listitem>
</varlistentry>
@@ -112,7 +123,7 @@
</term>
<listitem>
<simpara>
Enter into new op_array without recursion
Enter into new op_array without recursion
</simpara>
</listitem>
</varlistentry>
@@ -123,7 +134,7 @@
</term>
<listitem>
<simpara>
Return to calling op_array within the same executor
Return to calling op_array within the same executor
</simpara>
</listitem>
</varlistentry>
@@ -134,7 +145,7 @@
</term>
<listitem>
<simpara>
Dispatch to original opcode handler
Dispatch to original opcode handler
</simpara>
</listitem>
</varlistentry>
@@ -145,7 +156,7 @@
</term>
<listitem>
<simpara>
Dispatch to a specific handler (OR'd with ZEND opcode constant)
Dispatch to a specific handler (OR'd with ZEND opcode constant)
</simpara>
</listitem>
</varlistentry>
@@ -156,14 +167,14 @@
</term>
<listitem>
<simpara>
Exit from executor (return from function)
Exit from executor (return from function)
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The following modifiers are registered as constants by uopz
The following modifiers are registered as constants by uopz
</para>
<para>
<variablelist>
@@ -174,7 +185,7 @@
</term>
<listitem>
<simpara>
Mark function as public, the default
Mark function as public, the default
</simpara>
</listitem>
</varlistentry>
@@ -185,7 +196,7 @@
</term>
<listitem>
<simpara>
Mark function as protected
Mark function as protected
</simpara>
</listitem>
</varlistentry>
@@ -193,10 +204,10 @@
<term>
<constant>ZEND_ACC_PRIVATE</constant>
(<type>int</type>)
</term>
</term>
<listitem>
<simpara>
Mark function as private
<simpara>
Mark function as private
</simpara>
</listitem>
</varlistentry>
@@ -204,10 +215,10 @@
<term>
<constant>ZEND_ACC_STATIC</constant>
(<type>int</type>)
</term>
</term>
<listitem>
<simpara>
Mark function as static
<simpara>
Mark function as static
</simpara>
</listitem>
</varlistentry>
@@ -217,20 +228,20 @@
(<type>int</type>)
</term>
<listitem>
<simpara>
Mark function as final
<simpara>
Mark function as final
</simpara>
</listitem>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.zend-acc-abstract">
<term>
<constant>ZEND_ACC_ABSTRACT</constant>
(<type>int</type>)
</term>
<listitem>
</term>
<listitem>
<simpara>
Mark function as abstract
</simpara>
Mark function as abstract
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.zend-acc-class">
@@ -240,7 +251,7 @@
</term>
<listitem>
<simpara>
Dummy registered for consistency, the default kind of class entry.
Dummy registered for consistency, the default kind of class entry.
Removed as of uopz 5.0.0.
</simpara>
</listitem>
@@ -251,11 +262,11 @@
(<type>int</type>)
</term>
<listitem>
<simpara>
Mark class as interface.
<simpara>
Mark class as interface.
Removed as of uopz 5.0.0.
</simpara>
</listitem>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.zend-acc-trait">
<term>
@@ -263,11 +274,11 @@
(<type>int</type>)
</term>
<listitem>
<simpara>
Mark class as trait.
<simpara>
Mark class as trait.
Removed as of uopz 5.0.0.
</simpara>
</listitem>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.zend-acc-fetch">
<term>
@@ -276,7 +287,7 @@
</term>
<listitem>
<simpara>
Used for getting flags only.
Used for getting flags only.
Removed as of uopz 5.0.0.
</simpara>
</listitem>

6
reference/uopz/functions/uopz-backup.xml
View File

@@ -23,7 +23,7 @@
<methodparam><type>string</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<para>
Backup a function at runtime, to be restored on shutdown
Backup a function at runtime, to be restored on shutdown
</para>
</refsect1>
@@ -35,7 +35,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing the function to backup
The name of the class containing the function to backup
</para>
</listitem>
</varlistentry>
@@ -43,7 +43,7 @@
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of the function
The name of the function
</para>
</listitem>
</varlistentry>

28
reference/uopz/functions/uopz-compose.xml
View File

@@ -22,7 +22,7 @@
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Creates a new class of the given name that implements, extends, or uses all of the provided classes
Creates a new class of the given name that implements, extends, or uses all of the provided classes
</para>
</refsect1>
@@ -33,7 +33,7 @@
<term><parameter>name</parameter></term>
<listitem>
<para>
A legal class name
A legal class name
</para>
</listitem>
</varlistentry>
@@ -41,7 +41,7 @@
<term><parameter>classes</parameter></term>
<listitem>
<para>
An array of class, interface and trait names
An array of class, interface and trait names
</para>
</listitem>
</varlistentry>
@@ -49,23 +49,23 @@
<term><parameter>methods</parameter></term>
<listitem>
<para>
An associative array of methods, values are either closures or [modifiers => closure]
</para>
</listitem>
An associative array of methods, values are either closures or [modifiers => closure]
</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><parameter>properties</parameter></term>
<listitem>
<para>
An associative array of properties, keys are names, values are modifiers
</para>
An associative array of properties, keys are names, values are modifiers
</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Entry type, by default ZEND_ACC_CLASS
Entry type, by default ZEND_ACC_CLASS
</para>
</listitem>
</varlistentry>
@@ -75,7 +75,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
@@ -92,8 +92,8 @@ interface myInterface {}
uopz_compose(
Composed::class, [
myClass::class,
myTrait::class,
myClass::class,
myTrait::class,
myInterface::class
], [
"__construct" => function() {

6
reference/uopz/functions/uopz-copy.xml
View File

@@ -23,7 +23,7 @@
<methodparam><type>string</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<para>
Copy a function by name
Copy a function by name
</para>
</refsect1>
@@ -35,7 +35,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing the function to copy
The name of the class containing the function to copy
</para>
</listitem>
</varlistentry>
@@ -43,7 +43,7 @@
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of the function
The name of the function
</para>
</listitem>
</varlistentry>

2
reference/uopz/functions/uopz-delete.xml
View File

@@ -23,7 +23,7 @@
<methodparam><type>string</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<para>
Deletes a function or method
Deletes a function or method
</para>
</refsect1>

6
reference/uopz/functions/uopz-extend.xml
View File

@@ -15,7 +15,7 @@
<methodparam><type>string</type><parameter>parent</parameter></methodparam>
</methodsynopsis>
<para>
Makes <parameter>class</parameter> extend <parameter>parent</parameter>
Makes <parameter>class</parameter> extend <parameter>parent</parameter>
</para>
</refsect1>
@@ -26,7 +26,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class to extend
The name of the class to extend
</para>
</listitem>
</varlistentry>
@@ -34,7 +34,7 @@
<term><parameter>parent</parameter></term>
<listitem>
<para>
The name of the class to inherit
The name of the class to inherit
</para>
</listitem>
</varlistentry>

8
reference/uopz/functions/uopz-flags.xml
View File

@@ -21,7 +21,7 @@
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>PHP_INT_MAX</initializer></methodparam>
</methodsynopsis>
<para>
Get or set the flags on a class or function entry at runtime
Get or set the flags on a class or function entry at runtime
</para>
</refsect1>
@@ -33,7 +33,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of a class
The name of a class
</para>
</listitem>
</varlistentry>
@@ -51,7 +51,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
A valid set of ZEND_ACC_ flags.
A valid set of ZEND_ACC_ flags.
If omitted, <function>uopz_flags</function> acts as getter.
</para>
</listitem>
@@ -62,7 +62,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If setting, returns old flags, else returns flags
If setting, returns old flags, else returns flags
</para>
</refsect1>

10
reference/uopz/functions/uopz-function.xml
View File

@@ -27,7 +27,7 @@
<methodparam choice="opt"><type>int</type><parameter>modifiers</parameter></methodparam>
</methodsynopsis>
<para>
Creates a function at runtime
Creates a function at runtime
</para>
</refsect1>
@@ -39,7 +39,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class to receive the new function
The name of the class to receive the new function
</para>
</listitem>
</varlistentry>
@@ -47,7 +47,7 @@
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of the function
The name of the function
</para>
</listitem>
</varlistentry>
@@ -55,7 +55,7 @@
<term><parameter>handler</parameter></term>
<listitem>
<para>
The Closure for the function
The Closure for the function
</para>
</listitem>
</varlistentry>
@@ -63,7 +63,7 @@
<term><parameter>modifiers</parameter></term>
<listitem>
<para>
The modifiers for the function, by default copied or ZEND_ACC_PUBLIC
The modifiers for the function, by default copied or ZEND_ACC_PUBLIC
</para>
</listitem>
</varlistentry>

12
reference/uopz/functions/uopz-get-mock.xml
View File

@@ -25,18 +25,18 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the mocked class.
The name of the mocked class.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Either a string containing the name of the mock, or an object,
or &null; if no mock has been set.
</para>
&reftitle.returnvalues;
<para>
Either a string containing the name of the mock, or an object,
or &null; if no mock has been set.
</para>
</refsect1>
<refsect1 role="examples">

6
reference/uopz/functions/uopz-get-return.xml
View File

@@ -30,7 +30,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing the function
The name of the class containing the function
</para>
</listitem>
</varlistentry>
@@ -38,7 +38,7 @@
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of the function
The name of the function
</para>
</listitem>
</varlistentry>
@@ -48,7 +48,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The return value or Closure previously set.
The return value or Closure previously set.
</para>
</refsect1>

2
reference/uopz/functions/uopz-implement.xml
View File

@@ -15,7 +15,7 @@
<methodparam><type>string</type><parameter>interface</parameter></methodparam>
</methodsynopsis>
<para>
Makes <parameter>class</parameter> implement <parameter>interface</parameter>
Makes <parameter>class</parameter> implement <parameter>interface</parameter>
</para>
</refsect1>

4
reference/uopz/functions/uopz-overload.xml
View File

@@ -19,7 +19,7 @@
<methodparam><type>Callable</type><parameter>callable</parameter></methodparam>
</methodsynopsis>
<para>
Overloads the specified <parameter>opcode</parameter> with the user defined function
Overloads the specified <parameter>opcode</parameter> with the user defined function
</para>
</refsect1>
@@ -31,7 +31,7 @@
<term><parameter>opcode</parameter></term>
<listitem>
<para>
A valid opcode, see constants for details of supported codes
A valid opcode, see constants for details of supported codes
</para>
</listitem>
</varlistentry>

8
reference/uopz/functions/uopz-redefine.xml
View File

@@ -21,7 +21,7 @@
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Redefines the given <parameter>constant</parameter> as <parameter>value</parameter>
Redefines the given <parameter>constant</parameter> as <parameter>value</parameter>
</para>
</refsect1>
@@ -32,7 +32,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing the constant
The name of the class containing the constant
</para>
</listitem>
</varlistentry>
@@ -40,7 +40,7 @@
<term><parameter>constant</parameter></term>
<listitem>
<para>
The name of the constant
The name of the constant
</para>
</listitem>
</varlistentry>
@@ -48,7 +48,7 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
The new value for the constant, must be a valid type for a constant variable
The new value for the constant, must be a valid type for a constant variable
</para>
</listitem>
</varlistentry>

10
reference/uopz/functions/uopz-rename.xml
View File

@@ -25,11 +25,11 @@
<methodparam><type>string</type><parameter>rename</parameter></methodparam>
</methodsynopsis>
<para>
Renames <parameter>function</parameter> to <parameter>rename</parameter>
Renames <parameter>function</parameter> to <parameter>rename</parameter>
</para>
<note>
<para>
If both functions exist, this effectively swaps their names
If both functions exist, this effectively swaps their names
</para>
</note>
</refsect1>
@@ -41,7 +41,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing the function
The name of the class containing the function
</para>
</listitem>
</varlistentry>
@@ -49,7 +49,7 @@
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of an existing function
The name of an existing function
</para>
</listitem>
</varlistentry>
@@ -57,7 +57,7 @@
<term><parameter>rename</parameter></term>
<listitem>
<para>
The new name for the function
The new name for the function
</para>
</listitem>
</varlistentry>

6
reference/uopz/functions/uopz-restore.xml
View File

@@ -23,7 +23,7 @@
<methodparam><type>string</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<para>
Restore a previously backed up function
Restore a previously backed up function
</para>
</refsect1>
@@ -35,7 +35,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing the function to restore
The name of the class containing the function to restore
</para>
</listitem>
</varlistentry>
@@ -43,7 +43,7 @@
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of the function
The name of the function
</para>
</listitem>
</varlistentry>

10
reference/uopz/functions/uopz-set-return.xml
View File

@@ -41,7 +41,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing the function
The name of the class containing the function
</para>
</listitem>
</varlistentry>
@@ -49,7 +49,7 @@
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of an existing function
The name of an existing function
</para>
</listitem>
</varlistentry>
@@ -57,7 +57,7 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
The value the function should return. If a Closure is provided and the execute flag is set, the Closure will be executed in place of the original function.
The value the function should return. If a Closure is provided and the execute flag is set, the Closure will be executed in place of the original function.
</para>
</listitem>
</varlistentry>
@@ -65,7 +65,7 @@
<term><parameter>execute</parameter></term>
<listitem>
<para>
If true, and a Closure was provided as the value, the Closure will be executed in place of the original function.
If true, and a Closure was provided as the value, the Closure will be executed in place of the original function.
</para>
</listitem>
</varlistentry>
@@ -75,7 +75,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
True if succeeded, false otherwise.
True if succeeded, false otherwise.
</para>
</refsect1>

6
reference/uopz/functions/uopz-undefine.xml
View File

@@ -19,7 +19,7 @@
<methodparam><type>string</type><parameter>constant</parameter></methodparam>
</methodsynopsis>
<para>
Removes the constant at runtime
Removes the constant at runtime
</para>
</refsect1>
@@ -30,7 +30,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing <parameter>constant</parameter>
The name of the class containing <parameter>constant</parameter>
</para>
</listitem>
</varlistentry>
@@ -38,7 +38,7 @@
<term><parameter>constant</parameter></term>
<listitem>
<para>
The name of an existing constant
The name of an existing constant
</para>
</listitem>
</varlistentry>

2
reference/uopz/functions/uopz-unset-mock.xml
View File

@@ -25,7 +25,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the mocked class.
The name of the mocked class.
</para>
</listitem>
</varlistentry>

6
reference/uopz/functions/uopz-unset-return.xml
View File

@@ -30,7 +30,7 @@
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class containing the function
The name of the class containing the function
</para>
</listitem>
</varlistentry>
@@ -38,7 +38,7 @@
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of the function
The name of the function
</para>
</listitem>
</varlistentry>
@@ -48,7 +48,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
True on success
True on success
</para>
</refsect1>

4
reference/uopz/setup.xml
View File

@@ -15,12 +15,12 @@
&reftitle.install;
<para>
uopz releases are hosted by PECL and the source code by
<link xlink:href="&url.git.hub;krakjoe/uopz">github</link>,
<link xlink:href="&url.git.hub;krakjoe/uopz">github</link>,
the easiest route to installation is the normal PECL route:
<link xlink:href="&url.pecl.package;uopz">&url.pecl.package;uopz</link>.
</para>
<para>
Windows users can download prebuilt release binaries from the <link xlink:href="&url.pecl.package;uopz">PECL</link> website.
Windows users can download prebuilt release binaries from the <link xlink:href="&url.pecl.package;uopz">PECL</link> website.
</para>
<para>
As of uopz 5.0.0 the extension must be loaded as