language-snippets.ent

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<!ENTITY installation.enabled.disable 'This extension is enabled by default. It may be disabled by using the following option at compile time: '>

<!-- Not used in EN anymore -->
<!ENTITY changelog.randomseed '<row xmlns="http://docbook.org/ns/docbook"><entry>4.2.0</entry><entry>The random
number generator is seeded automatically.</entry></row>'>

<!ENTITY warn.deprecated.feature-5-3-0.removed-6-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 5.3.0. Relying on this feature is
highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-5-3-0.removed-6-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 5.3.0. Relying on this feature is
highly discouraged.</simpara></warning>'>

<!-- Cautions -->
<!ENTITY caution.cryptographically-insecure '<caution xmlns="http://docbook.org/ns/docbook"><para>This function does not
generate cryptographically secure values, and should not be used for cryptographic purposes. If you need a
cryptographically secure value, consider using <function>random_int</function>, <function>random_bytes</function>, or
<function>openssl_random_pseudo_bytes</function> instead.</para></caution>'>

<!-- Notes -->

<!ENTITY note.bin-safe '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function is
binary-safe.</simpara></note>'>

<!ENTITY note.locale-single-byte '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function is locale-aware
and will handle input according to the currently set locale.  However, it only works on single-byte character sets.
If you need to use multibyte characters (most non-western-European languages) look at the
<link linkend="book.mbstring">multibyte</link> or <link linkend="book.intl">intl</link> extensions instead.</simpara></note>'>

<!ENTITY note.clearstatcache '<note xmlns="http://docbook.org/ns/docbook"><simpara>The results of this
function are cached. See <function>clearstatcache</function> for
more details.</simpara></note>'>

<!ENTITY note.context-support '<para xmlns="http://docbook.org/ns/docbook">A <link linkend="stream.contexts">context stream</link>
<type>resource</type>.</para>'>

<!ENTITY note.exec-bg '<note xmlns="http://docbook.org/ns/docbook"><para>If a program is started with this function,
in order for it to continue running in the background, the output of the
program must be redirected to a file or another output stream. Failing to do so
will cause PHP to hang until the execution of the program ends.</para></note>'>

<!ENTITY note.exec-bypass-shell '<note xmlns="http://docbook.org/ns/docbook"><para>On Windows <function>exec</function>
will first start cmd.exe to launch the command. If you want to start an external program without starting cmd.exe
use <function>proc_open</function> with the <parameter>bypass_shell</parameter> option set.</para></note>'>

<!ENTITY note.extractto-windows '<note xmlns="http://docbook.org/ns/docbook"><para>Windows NTFS file systems
do not support some characters in filenames, namely <literal>&lt;|&gt;*?":</literal>. Filenames with a trailing dot
are not supported either. Contrary to some extraction tools, this method does not replace these characters with
an underscore, but instead fails to extract such files.</para></note>'>

<!ENTITY note.func-callback '<note xmlns="http://docbook.org/ns/docbook"><simpara>Instead of a function name, an
array containing an object reference and a method name can also be
supplied.</simpara></note>'>

<!ENTITY note.func-callback-exceptions '<note xmlns="http://docbook.org/ns/docbook"><para>Callbacks registered
with functions such as <function>call_user_func</function> and <function>call_user_func_array</function> will not be
called if there is an uncaught exception thrown in a previous callback.</para></note>'>

<!ENTITY note.funcbyref '<note xmlns="http://docbook.org/ns/docbook"><para>If the arguments are passed by reference,
any changes to the arguments will be reflected in the values returned by this function. As of PHP 7
the current values will also be returned if the arguments are passed by value.</para></note>'>

<!ENTITY note.funcnoparam '<note xmlns="http://docbook.org/ns/docbook"><para>Because this function depends on the
current scope to determine parameter details, it cannot be used as a
function parameter in versions prior to 5.3.0. If this value must be passed, the results should be assigned
to a variable, and that variable should be passed.</para></note>'>

<!ENTITY note.line-endings '<note xmlns="http://docbook.org/ns/docbook"><simpara>If PHP is not properly recognizing
the line endings when reading files either on or created by a Macintosh
computer, enabling the
<link linkend="ini.auto-detect-line-endings">auto_detect_line_endings</link>
run-time configuration option may help resolve the problem.</simpara></note>'>

<!ENTITY note.no-remote '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function will not work on
<link linkend="features.remote-files">remote files</link> as the file to
be examined must be accessible via the server&apos;s filesystem.</simpara></note>'>

<!ENTITY note.not-bin-safe '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This function
is not (yet) binary safe!</simpara></warning>'>

<!ENTITY note.no-key-association '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function
assigns new keys to the elements in <parameter>array</parameter>.
It will remove any existing keys that may have been assigned, rather
than just reordering the keys.</simpara></note>'>

<!ENTITY note.no-windows '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function is not
implemented on Windows platforms.</simpara></note>'>

<!ENTITY note.no-windows.extension '<note xmlns="http://docbook.org/ns/docbook"><simpara>This extension is not
available on Windows platforms.</simpara></note>'>

<!ENTITY note.no-zts '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function is not
available in PHP interpreters built with ZTS (Zend Thread Safety) enabled. To check whether your copy of PHP was built with ZTS enabled, use <command>php -i</command> or test the built-in constant <constant>PHP_ZTS</constant>.</simpara></note>'>

<!ENTITY note.randomseed '<note xmlns="http://docbook.org/ns/docbook"><simpara>There is no need
to seed the random number generator with <function>srand</function> or
<function>mt_srand</function> as this is done automatically.
</simpara></note>'>

<!ENTITY note.is-superglobal "<note xmlns='http://docbook.org/ns/docbook'><para>This is a 'superglobal', or
automatic global, variable. This simply means that it is available in
all scopes throughout a script. There is no need to do
<command>global $variable;</command> to access it within functions or methods.
</para></note>">

<!ENTITY note.uses-ob '<note xmlns="http://docbook.org/ns/docbook"><para>When the <parameter>return</parameter> parameter
is used, this function uses internal output buffering so it cannot be used inside an
<function>ob_start</function> callback function.</para></note>'>

<!ENTITY note.uses-ob-php70 '<note xmlns="http://docbook.org/ns/docbook"><para>When the <parameter>return</parameter> parameter
is used, this function uses internal output buffering prior to PHP 7.1.0, so it cannot be used inside an
<function>ob_start</function> callback function.</para></note>'>

<!ENTITY note.filesystem-time-res '<note xmlns="http://docbook.org/ns/docbook"><para>Note that time resolution may differ
from one file system to another.</para></note>'>

<!ENTITY note.uses-autoload '<note xmlns="http://docbook.org/ns/docbook">
<para>Using this function will use any registered
<link linkend="language.oop5.autoload">autoloaders</link> if the class is not already known.</para></note>'>

<!ENTITY note.network.header.sapi '<note xmlns="http://docbook.org/ns/docbook">
   <para>
    Headers will only be accessible and output when a SAPI that supports them
    is in use.
   </para>
  </note>
'>

<!ENTITY note.sigchild '<note xmlns="http://docbook.org/ns/docbook">
 <para>
  If PHP has been compiled with --enable-sigchild, the return value of this function is undefined.
 </para>
</note>
'>

<!ENTITY note.sort-unstable '<note xmlns="http://docbook.org/ns/docbook">
 <para>
  If two members compare as equal, they retain their original order.
  Prior to PHP 8.0.0, their relative order in the sorted array was undefined.
 </para>
</note>
'>

<!ENTITY note.resource-migration-8.0-dead-function '<note xmlns="http://docbook.org/ns/docbook">
 <para>
  This function has no effect. Prior to PHP 8.0.0, this function was used to close the resource.
 </para>
</note>
'>

<!-- Tips -->

<!ENTITY tip.fopen-wrapper '<tip xmlns="http://docbook.org/ns/docbook"><simpara>A URL can be used as a
filename with this function if the <link linkend="ini.allow-url-fopen"
>fopen wrappers</link> have been enabled.
See <function>fopen</function> for more details on how to specify the
filename. See the <xref linkend="wrappers"/> for links to information
about what abilities the various wrappers have, notes on their usage,
and information on any predefined variables they may
provide.</simpara></tip>'>

<!ENTITY tip.fopen-wrapper.stat '<tip xmlns="http://docbook.org/ns/docbook"><simpara>As of PHP 5.0.0, this function
can also be used with <emphasis>some</emphasis> URL wrappers.  Refer to
<xref linkend="wrappers"/> to determine which wrappers support
<function>stat</function> family of functionality.</simpara></tip>'>

<!ENTITY tip.ob-capture '<tip xmlns="http://docbook.org/ns/docbook"><simpara>As with anything that outputs
its result directly to the browser, the <link
linkend="book.outcontrol">output-control functions</link> can be used to capture
the output of this function, and save it in a
<type>string</type> (for example).</simpara></tip>'>

<!ENTITY tip.userlandnaming '<tip xmlns="http://docbook.org/ns/docbook"><simpara>See also the
<xref linkend="userlandnaming" />.</simpara></tip>'>


<!-- Warnings -->

<!ENTITY warn.escapeshell '<warning xmlns="http://docbook.org/ns/docbook"><para>When allowing user-supplied data to be
passed to this function, use
<function>escapeshellarg</function> or <function>escapeshellcmd</function>
to ensure that users cannot trick the system into executing arbitrary
commands.</para></warning>'>

<!ENTITY warn.experimental '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This extension is
<emphasis>EXPERIMENTAL</emphasis>. The behaviour of this extension including
the names of its functions and any other documentation surrounding this
extension may change without notice in a future release of PHP.
This extension should be used at your own risk.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-5-3-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 5.3.0. Relying on this feature
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-5-3-0.removed-5-4-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 5.3.0 and <emphasis>REMOVED</emphasis>
as of PHP 5.4.0.</simpara></warning>'>

<!ENTITY warn.deprecated.function-5-3-0.removed-5-4-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 5.3.0 and <emphasis>REMOVED</emphasis> as of PHP 5.4.0.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-5-5-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 5.5.0. Relying on this feature
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-5-6-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 5.6.0. Relying on this feature
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-7-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.0.0. Relying on this feature
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-7-1-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.1.0. Relying on this feature
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-1-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.1.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-0-0.removed-8-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.0.0 and
<emphasis>REMOVED</emphasis> as of PHP 8.0.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-1-0.removed-7-2-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.1.0 and
<emphasis>REMOVED</emphasis> as of PHP 7.2.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-7-2-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.2.0. Relying on this feature
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-7-2-0.removed-8-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.2.0, and <emphasis>REMOVED</emphasis> as of PHP 8.0.0. Relying on this feature
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-2-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.2.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-2-0.removed-8-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.2.0, and <emphasis>REMOVED</emphasis> as of PHP 8.0.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-7-3-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.3.0. Relying on this feature
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-3-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.3.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-3-0.removed-8-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.3.0, and <emphasis>REMOVED</emphasis> as of PHP 8.0.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-7-4-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.4.0. Relying on this feature
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-4-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.4.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-4-0.removed-8-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 7.4.0, and <emphasis>REMOVED</emphasis> as of PHP 8.0.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-8-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 8.0.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.function-8-1-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> as of PHP 8.1.0. Relying on this function
is highly discouraged.</simpara></warning>'>

<!ENTITY removed.php.future 'This deprecated feature <emphasis xmlns="http://docbook.org/ns/docbook">will</emphasis>
certainly be <emphasis xmlns="http://docbook.org/ns/docbook">removed</emphasis> in the future.'>

<!ENTITY warn.deprecated.function.removed-5-3-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> and <emphasis>REMOVED</emphasis> as of PHP 5.3.0.</simpara></warning>'>

<!ENTITY warn.deprecated.function.removed-5-5-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>DEPRECATED</emphasis> and <emphasis>REMOVED</emphasis> as of PHP 5.5.0.</simpara></warning>'>

<!ENTITY warn.deprecated.alias-5-3-0 '<warning xmlns="http://docbook.org/ns/docbook">
<simpara>This alias has been <emphasis>DEPRECATED</emphasis> as of PHP 5.3.0.  Relying
on this alias is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.func-5-4-0 '<warning xmlns="http://docbook.org/ns/docbook">
<simpara>This function has been <emphasis>DEPRECATED</emphasis> as of PHP 5.4.0.  Relying
on this function is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.alias-5-4-0 '<warning xmlns="http://docbook.org/ns/docbook">
<simpara>This alias has been <emphasis>DEPRECATED</emphasis> as of PHP 5.4.0.  Relying
on this alias is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.func-5-5-0 '<warning xmlns="http://docbook.org/ns/docbook">
<simpara>This function has been <emphasis>DEPRECATED</emphasis> as of PHP 5.5.0.  Relying
on this function is highly discouraged.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-5-5-0.removed-7-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature was
<emphasis>DEPRECATED</emphasis> in PHP 5.5.0, and <emphasis>REMOVED</emphasis> as of PHP 7.0.0.</simpara></warning>'>

<!ENTITY warn.deprecated.function-5-5-0.removed-7-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function was
<emphasis>DEPRECATED</emphasis> in PHP 5.5.0, and <emphasis>REMOVED</emphasis> as of PHP 7.0.0.</simpara></warning>'>

<!ENTITY warn.deprecated.function-4-1-0.removed-7-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function was
<emphasis>DEPRECATED</emphasis> in PHP 4.1.0, and <emphasis>REMOVED</emphasis> as of PHP 7.0.0.</simpara></warning>'>

<!ENTITY warn.deprecated.function-5-3-0.removed-7-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function was
<emphasis>DEPRECATED</emphasis> in PHP 5.3.0, and <emphasis>REMOVED</emphasis> as of PHP 7.0.0.</simpara></warning>'>

<!ENTITY warn.deprecated.alias-5-3-0.removed-7-0-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This alias was
<emphasis>DEPRECATED</emphasis> in PHP 5.3.0, and <emphasis>REMOVED</emphasis> as of PHP 7.0.0.</simpara></warning>'>

<!ENTITY warn.deprecated.feature-5-6-0.removed-7-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This feature was
<emphasis>DEPRECATED</emphasis> in PHP 5.6.0, and
<emphasis>REMOVED</emphasis> as of PHP 7.0.0.</simpara></warning>'>

<!ENTITY warn.removed.function-7-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function was
<emphasis>REMOVED</emphasis> in PHP 7.0.0.</simpara></warning>'>

<!ENTITY warn.removed.function-7-4-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function was
<emphasis>REMOVED</emphasis> in PHP 7.4.0.</simpara></warning>'>

<!ENTITY warn.deprecated.alias-7-2-0.removed-8-0-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This alias was
<emphasis>DEPRECATED</emphasis> in PHP 7.2.0, and <emphasis>REMOVED</emphasis> as of PHP 8.0.0.</simpara></warning>'>

<!ENTITY warn.deprecated.alias-7-4-0.removed-8-0-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This alias was
<emphasis>DEPRECATED</emphasis> in PHP 7.4.0, and <emphasis>REMOVED</emphasis> as of PHP 8.0.0.</simpara></warning>'>

<!ENTITY warn.deprecated.alias-8-0-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This alias is
<emphasis>DEPRECATED</emphasis> as of PHP 8.0.0.</simpara></warning>'>

<!ENTITY warn.removed.alias-8-0-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This alias is
<emphasis>REMOVED</emphasis> as of PHP 8.0.0.</simpara></warning>'>

<!ENTITY warn.experimental.func '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This function is
<emphasis>EXPERIMENTAL</emphasis>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</simpara></warning>'>

<!ENTITY warn.imaprecodeyaz '<warning xmlns="http://docbook.org/ns/docbook"><simpara>The <link
linkend="book.imap">IMAP</link>, <link linkend="book.recode">recode</link> and
<link linkend="book.yaz">YAZ</link>
extensions cannot be used in conjunction, because they
share the same internal symbols. Note: Yaz 2.0 and above does not suffer from this problem.</simpara></warning>'>

<!ENTITY warn.install.cgi '<warning xmlns="http://docbook.org/ns/docbook"><para>A server deployed in CGI mode is open
to several possible vulnerabilities. Please read our
<link linkend="security.cgi-bin">CGI security section</link> to learn how to
defend yourself from such attacks.</para></warning>'>

<!ENTITY warn.passwordhashing '
<warning xmlns="http://docbook.org/ns/docbook">
 <para>
  It is not recommended to use this function to secure passwords,
  due to the fast nature of this hashing algorithm. See the
  <link linkend="faq.passwords.fasthash">Password Hashing FAQ</link>
  for details and best practices.
 </para>
</warning>
'>

<!ENTITY warn.ssl-non-standard '<warning xmlns="http://docbook.org/ns/docbook"><para>When using SSL, Microsoft IIS
will violate the protocol by closing the connection without sending a
<literal>close_notify</literal> indicator. PHP will report this as "SSL: Fatal
Protocol Error" when you reach the end of the data. To work around this, the
value of <link linkend="ini.error-reporting">error_reporting</link> should be
lowered to a level that does not include warnings.
PHP can detect buggy IIS server software when you open
the stream using the <literal>https://</literal> wrapper and will suppress the
warning. When using <function>fsockopen</function> to create an
<literal>ssl://</literal> socket, the developer is responsible for detecting
and suppressing this warning.</para></warning>'>

<!ENTITY warn.undocumented.class '
<warning xmlns="http://docbook.org/ns/docbook">
 <simpara>
  This class is currently undocumented; only a list of its properties and
  methods is available.
 </simpara>
</warning>
'>

<!ENTITY warn.undocumented.func '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This function is
currently not documented; only its argument list is available.
</simpara></warning>'>


<!-- Deprecation and removal warnings designed for use with a list of
     alternatives. See en/reference/regex/functions/ereg.xml and
     en/reference/regex/reference.xml for examples of these in action. -->

<!ENTITY warn.deprecated.function.4-1-0.removed.7-0-0.alternatives '
<para xmlns="http://docbook.org/ns/docbook">
 This function was <emphasis>DEPRECATED</emphasis> in PHP 4.1.0, and
 <emphasis>REMOVED</emphasis> in PHP 7.0.0.
</para>
<para xmlns="http://docbook.org/ns/docbook">
 Alternatives to this function include:
</para>
'>

<!ENTITY warn.deprecated.feature.5-3-0.removed.7-0-0.alternatives '
<para xmlns="http://docbook.org/ns/docbook">
 This feature was <emphasis>DEPRECATED</emphasis> in PHP 5.3.0, and
 <emphasis>REMOVED</emphasis> in PHP 7.0.0.
</para>
<para xmlns="http://docbook.org/ns/docbook">
 Alternatives to this feature include:
</para>
'>

<!ENTITY warn.deprecated.function.5-3-0.removed.7-0-0.alternatives '
<para xmlns="http://docbook.org/ns/docbook">
 This function was <emphasis>DEPRECATED</emphasis> in PHP 5.3.0, and
 <emphasis>REMOVED</emphasis> in PHP 7.0.0.
</para>
<para xmlns="http://docbook.org/ns/docbook">
 Alternatives to this function include:
</para>
'>

<!ENTITY warn.deprecated.function.5-5-0.removed.7-0-0.alternatives '
<para xmlns="http://docbook.org/ns/docbook">
 This function was <emphasis>DEPRECATED</emphasis> in PHP 5.5.0, and
 <emphasis>REMOVED</emphasis> in PHP 7.0.0.
</para>
<para xmlns="http://docbook.org/ns/docbook">
 Alternatives to this function include:
</para>
'>

<!ENTITY warn.removed.feature.7-0-0.alternatives '
<para xmlns="http://docbook.org/ns/docbook">
 This feature was <emphasis>REMOVED</emphasis> in PHP 7.0.0.
</para>
<para xmlns="http://docbook.org/ns/docbook">
 Alternatives to this feature include:
</para>
'>

<!ENTITY warn.removed.function.7-0-0.alternatives '
<para xmlns="http://docbook.org/ns/docbook">
 This function was <emphasis>REMOVED</emphasis> in PHP 7.0.0.
</para>
<para xmlns="http://docbook.org/ns/docbook">
 Alternatives to this function include:
</para>
'>

<!ENTITY warn.deprecated.feature.7-1-0.removed.7-2-0.alternatives '
<para xmlns="http://docbook.org/ns/docbook">
 This feature was <emphasis>DEPRECATED</emphasis> in PHP 7.1.0, and
 <emphasis>REMOVED</emphasis> in PHP 7.2.0.
</para>
<para xmlns="http://docbook.org/ns/docbook">
 Alternatives to this feature include:
</para>
'>

<!ENTITY warn.deprecated.function.7-1-0.removed.7-2-0.alternatives '
<para xmlns="http://docbook.org/ns/docbook">
 This function was <emphasis>DEPRECATED</emphasis> in PHP 7.1.0, and
 <emphasis>REMOVED</emphasis> in PHP 7.2.0.
</para>
<para xmlns="http://docbook.org/ns/docbook">
 Alternatives to this function include:
</para>
'>

<!-- Misc -->

<!ENTITY version.exists.asof 'This exists as of PHP '>

<!ENTITY version.trunk.changelog 'Future'>

<!ENTITY no.function.parameters '<para xmlns="http://docbook.org/ns/docbook">This function has no parameters.</para>'>

<!ENTITY example.outputs '<para xmlns="http://docbook.org/ns/docbook">The above example will output:</para>'>

<!ENTITY example.outputs.5 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 5:</para>'>

<!ENTITY example.outputs.53 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 5.3:</para>'>

<!ENTITY example.outputs.54 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 5.4:</para>'>

<!ENTITY example.outputs.55 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 5.5:</para>'>

<!ENTITY example.outputs.56 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 5.6:</para>'>

<!ENTITY example.outputs.7 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 7:</para>'>

<!ENTITY example.outputs.70 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 7.0:</para>'>

<!ENTITY example.outputs.71 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 7.1:</para>'>

<!ENTITY example.outputs.72 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 7.2:</para>'>

<!ENTITY example.outputs.73 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 7.3:</para>'>

<!ENTITY example.outputs.8 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 8:</para>'>

<!ENTITY example.outputs.8.similar '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 8 is similar to:</para>'>

<!ENTITY example.outputs.80 '<para xmlns="http://docbook.org/ns/docbook">Output of the above example in PHP 8.0:</para>'>

<!ENTITY example.outputs.32bit '<para xmlns="http://docbook.org/ns/docbook">Output of the above example on 32 bit machines:</para>'>

<!ENTITY example.outputs.64bit '<para xmlns="http://docbook.org/ns/docbook">Output of the above example on 64 bit machines:</para>'>

<!ENTITY example.outputs.similar '<para xmlns="http://docbook.org/ns/docbook">The above example will output
something similar to:</para>'>

<!ENTITY examples.outputs '<para xmlns="http://docbook.org/ns/docbook">The above examples will output:</para>'>

<!ENTITY examples.outputs.32bit '<para xmlns="http://docbook.org/ns/docbook">Output of the above examples on 32 bit machines:</para>'>

<!ENTITY examples.outputs.64bit '<para xmlns="http://docbook.org/ns/docbook">Output of the above examples on 64 bit machines:</para>'>

<!ENTITY examples.outputs.similar '<para xmlns="http://docbook.org/ns/docbook">The above examples will output
something similar to:</para>'>

<!ENTITY array.resetspointer '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function will
<function>reset</function> the <type>array</type> pointer of the input array after
use.</simpara></note>'>

<!ENTITY seealso.array.sorting 'The <link xmlns="http://docbook.org/ns/docbook" linkend="array.sorting">comparison of array sorting functions</link>'>

<!ENTITY sort.flags.parameter '<varlistentry xmlns="http://docbook.org/ns/docbook">
  <term><parameter>flags</parameter></term>
  <listitem>
   <para>
    The optional second parameter <parameter>flags</parameter>
    may be used to modify the sorting behavior using these values:
   </para>
   <para>
    Sorting type flags:
    <itemizedlist>
     <listitem>
      <simpara><constant>SORT_REGULAR</constant> - compare items normally;
      the details are described in the <link linkend="language.operators.comparison">comparison operators</link> section</simpara>
     </listitem>
     <listitem>
      <simpara><constant>SORT_NUMERIC</constant> - compare items numerically</simpara>
     </listitem>
     <listitem>
      <simpara><constant>SORT_STRING</constant> - compare items as strings</simpara>
     </listitem>
     <listitem>
      <simpara>
       <constant>SORT_LOCALE_STRING</constant> - compare items as
       strings, based on the current locale. It uses the locale,
       which can be changed using <function>setlocale</function>
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <constant>SORT_NATURAL</constant> - compare items as strings
       using "natural ordering" like <function>natsort</function>
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <constant>SORT_FLAG_CASE</constant> - can be combined
       (bitwise OR) with
       <constant>SORT_STRING</constant> or
       <constant>SORT_NATURAL</constant> to sort strings case-insensitively
      </simpara>
     </listitem>
    </itemizedlist>
   </para>
  </listitem>
 </varlistentry>
'>

<!ENTITY ini.shorthandbytes '<simpara xmlns="http://docbook.org/ns/docbook">When an <type>int</type> is used, the
value is measured in bytes. Shorthand notation, as described
in <link linkend="faq.using.shorthandbytes">this FAQ</link>, may also be used.
</simpara>'>

<!ENTITY info.deprecated.alias 'For backward compatibility, the following
deprecated alias may be used: '>

<!ENTITY info.function.alias 'This function is an alias of: '>

<!ENTITY info.method.alias 'This method is an alias of: '>

<!ENTITY info.function.alias.deprecated '<simpara xmlns="http://docbook.org/ns/docbook">This function alias is
deprecated and only exists for backwards compatibility reasons. The use of this
function is not recommended, as it may be removed from PHP in the future.
</simpara>'>

<!ENTITY ext.windows.path.dll 'In order for this extension to work, there are
<acronym xmlns="http://docbook.org/ns/docbook">DLL</acronym> files that must be available to the Windows
system <envar xmlns="http://docbook.org/ns/docbook">PATH</envar>. For information on how to do this, see the
<acronym xmlns="http://docbook.org/ns/docbook">FAQ</acronym> entitled "<link
 xmlns="http://docbook.org/ns/docbook" linkend="faq.installation.addtopath">How do I add my PHP directory to the PATH
on Windows</link>". Although copying DLL
files from the PHP folder into the Windows system directory also works
(because the system directory is by default in the system&apos;s
<envar xmlns="http://docbook.org/ns/docbook">PATH</envar>), this is not recommended.
<emphasis xmlns="http://docbook.org/ns/docbook">This extension requires the following files to be in the
<envar>PATH</envar>:</emphasis> '>

<!ENTITY manual.migration.seealso 'See also the migration guides for PHP versions'>

<!ENTITY style.oop 'Object-oriented style'>
<!ENTITY style.procedural 'Procedural style'>

<!ENTITY resource '<link xmlns="http://docbook.org/ns/docbook" linkend="language.types.resource">resource</link>'>

<!ENTITY foreach '<link xmlns="http://docbook.org/ns/docbook" linkend="control-structures.foreach">foreach</link>'>

<!ENTITY yield '<link xmlns="http://docbook.org/ns/docbook" linkend="control-structures.yield">yield</link>'>

<!ENTITY parameter.context 'Refer to the <link xmlns="http://docbook.org/ns/docbook" linkend="context">context</link>
section of the manual for a description of <literal xmlns="http://docbook.org/ns/docbook">contexts</literal>.'>

<!ENTITY parameter.use_include_path 'When set to &true;, the filename is also
searched for within the <link xmlns="http://docbook.org/ns/docbook" linkend="ini.include-path">include_path</link>'>

<!-- Returns -->

<!ENTITY return.falseforfailure ' or &false; on failure'>
<!ENTITY return.falseforfailure.style.procedural '&style.procedural; returns &false; on failure.'>

<!ENTITY return.success 'Returns &true; on success&return.falseforfailure;.'>

<!ENTITY return.nullorfalse 'Returns &null; on success&return.falseforfailure;.'>

<!ENTITY return.void 'No value is returned.'>

<!ENTITY return.true.always 'Always returns &true;.'>

<!ENTITY return.callbacksort 'The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.'>

<!ENTITY return.falseproblem '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This function may
return Boolean &false;, but may also return a non-Boolean value which
evaluates to &false;. Please read the section on <link
linkend="language.types.boolean">Booleans</link> for more
information. Use <link linkend="language.operators.comparison">the ===
operator</link> for testing the return value of this
function.</simpara></warning>'>

<!-- FileInfo -->
<!ENTITY fileinfo.parameters.finfo '<para xmlns="http://docbook.org/ns/docbook">An <classname>finfo</classname> instance, returned by <function>finfo_open</function>.</para>'>
<!ENTITY fileinfo.changelog.finfo-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>finfo</parameter> parameter expects an <classname>finfo</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!-- OpenSSL -->
<!ENTITY openssl.param.x509 '<varlistentry xmlns="http://docbook.org/ns/docbook">
 <term><parameter>x509</parameter></term>
 <listitem>
  <para>
   See <link linkend="openssl.certparams">Key/Certificate parameters</link> for a list of valid values.
  </para>
 </listitem>
</varlistentry>'>

<!ENTITY openssl.param.csr '<varlistentry xmlns="http://docbook.org/ns/docbook">
 <term><parameter>csr</parameter></term>
 <listitem>
  <para>
   See <link linkend="openssl.certparams">CSR parameters</link> for a list of valid values.
  </para>
 </listitem>
</varlistentry>'>

<!ENTITY openssl.param.key '<varlistentry xmlns="http://docbook.org/ns/docbook">
 <term><parameter>key</parameter></term>
 <listitem>
  <para>
   See <link linkend="openssl.certparams">Public/Private Key parameters</link> for a list of valid values.
  </para>
 </listitem>
</varlistentry>'>

<!-- Image (GD) Notes -->
<!ENTITY note.config.t1lib '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function is only available
if PHP is compiled using <option role="configure">--with-t1lib[=DIR]</option>.
</simpara></note>'>

<!ENTITY note.freetype '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function is only available if
PHP is compiled with freetype support (<option role="configure">--with-freetype-dir=DIR</option>)
</simpara></note>'>

<!ENTITY note.gd.notrequired '<note xmlns="http://docbook.org/ns/docbook"><para>This function does not require the GD image library.</para></note>'>

<!ENTITY note.gd.interpolation '<note xmlns="http://docbook.org/ns/docbook"><para>This function is affected by the interpolation method set by <function>imagesetinterpolation</function>.</para></note>'>

<!ENTITY gd.image.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
image</parameter></term><listitem><para>A <classname>GdImage</classname> object, returned by one of the image creation functions,
such as <function>imagecreatetruecolor</function>.</para></listitem></varlistentry>'>

<!ENTITY gd.font.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
font</parameter></term><listitem><para>Can be 1, 2, 3, 4, 5 for built-in
fonts in latin2 encoding (where higher numbers corresponding to larger fonts) or <classname>GdFont</classname> instance,
returned by <function>imageloadfont</function>.</para></listitem></varlistentry>'>

<!ENTITY gd.changelog.gdfont-instance '<row xmlns="http://docbook.org/ns/docbook">
  <entry>8.1.0</entry>
  <entry>
  The <parameter>font</parameter> parameter now accepts both an <classname>GdFont</classname> instance
  and an &integer;; previously only &integer; was accepted.
  </entry>
</row>'>

<!ENTITY gd.ttf.fontfile "
    <varlistentry xmlns='http://docbook.org/ns/docbook'>
     <term><parameter>fontfile</parameter></term>
     <listitem>
      <para>
       The path to the TrueType font you wish to use.
      </para>
      <para>
       Depending on which version of the GD library PHP is using, <emphasis>when
       <parameter>fontfile</parameter> does not begin with a leading
       <literal>/</literal> then <literal>.ttf</literal> will be appended</emphasis>
       to the filename and the library will attempt to search for that
       filename along a library-defined font path.
      </para>
      <para>
       When using versions of the GD library lower than 2.0.18, a <literal>space</literal> character,
       rather than a semicolon, was used as the 'path separator' for different font files.
       Unintentional use of this feature will result in the warning message:
       <literal>Warning: Could not find/open font</literal>. For these affected versions, the
       only solution is moving the font to a path which does not contain spaces.
      </para>
      <para>
       In many cases where a font resides in the same directory as the script using it
       the following trick will alleviate any include problems.
       <programlisting role='php'>
<![CDATA[
<?php
// Set the environment variable for GD
putenv('GDFONTPATH=' . realpath('.'));

// Name the font to be used (note the lack of the .ttf extension)
$font = 'SomeFont';
?>
]]>
       </programlisting>
      </para>
      <note>
       <para>
        Note that <link linkend='ini.open-basedir'>open_basedir</link> does
        <emphasis>not</emphasis> apply to <parameter>fontfile</parameter>.
       </para>
      </note>
     </listitem>
    </varlistentry>
">

<!ENTITY gd.return.identifier 'Returns an image object on success, &false; on errors.'>

<!ENTITY gd.return.trueonerror '<caution xmlns="http://docbook.org/ns/docbook"><simpara>However, if libgd fails to output the image, this function returns &true;.</simpara></caution>'>

<!ENTITY gd.identifier.color "A color identifier created with <function xmlns='http://docbook.org/ns/docbook'>imagecolorallocate</function>.">

<!ENTITY gd.value.red 'Value of red component.'>

<!ENTITY gd.value.green 'Value of green component.'>

<!ENTITY gd.value.blue 'Value of blue component.'>

<!ENTITY gd.source.height 'Source height.'>

<!ENTITY gd.source.width 'Source width.'>

<!ENTITY gd.image.path 'The path or an open stream resource (which is automatically closed after this function returns) to save the file to. If not set or &null;, the raw image stream will be output directly.'>

<!ENTITY gd.image.new 'Create a new image from file or URL'>

<!ENTITY gd.image.source 'Source image resource.'>

<!ENTITY gd.image.destination 'Destination image resource.'>

<!ENTITY gd.image.output 'Output image to browser or file'>

<!ENTITY gd.image.colors 'If you created the image from a file, only colors used in the image are resolved. Colors present only in the palette are not resolved.'>

<!ENTITY gd.font.size 'The font size in points.'>

<!ENTITY gd.constants.types '<simpara xmlns="http://docbook.org/ns/docbook">
    Used as a return value by <function>imagetypes</function>
</simpara>'>

<!ENTITY gd.constants.color '<simpara xmlns="http://docbook.org/ns/docbook">
    Special color option which can be used instead of a color allocated with
    <function>imagecolorallocate</function> or
    <function>imagecolorallocatealpha</function>.
</simpara>'>

<!ENTITY gd.constants.affine '<simpara xmlns="http://docbook.org/ns/docbook">
    An affine transformation type constant used by the <function>imageaffinematrixget</function> function.
</simpara>'>

<!ENTITY gd.constants.arc '<simpara xmlns="http://docbook.org/ns/docbook">
    A style constant used by the <function>imagefilledarc</function> function.
</simpara>'>

<!ENTITY gd.constants.gd2 '<simpara xmlns="http://docbook.org/ns/docbook">
    A type constant used by the <function>imagegd2</function> function.
</simpara>'>

<!ENTITY gd.constants.effect '<simpara xmlns="http://docbook.org/ns/docbook">
    Alpha blending effect used by the <function>imagelayereffect</function> function.
</simpara>'>

<!ENTITY gd.constants.filter '<simpara xmlns="http://docbook.org/ns/docbook">
    Special GD filter used by the <function>imagefilter</function> function.
</simpara>'>

<!ENTITY gd.constants.type '<simpara xmlns="http://docbook.org/ns/docbook">
    Image type constant used by the <function>image_type_to_mime_type</function>
    and <function>image_type_to_extension</function> functions.
</simpara>'>

<!ENTITY gd.constants.png-filter '<simpara xmlns="http://docbook.org/ns/docbook">
    A special PNG filter, used by the <function>imagepng</function> function.
</simpara>'>

<!ENTITY gd.constants.flip '<simpara xmlns="http://docbook.org/ns/docbook">
    Used together with <function>imageflip</function>, available as of PHP 5.5.0.
</simpara>'>

<!ENTITY gd.constants.interpolation '<simpara xmlns="http://docbook.org/ns/docbook">
    Used together with <function>imagesetinterpolation</function>, available as of PHP 5.5.0.
</simpara>'>

<!ENTITY gd.changlog.t1lib '<row xmlns="http://docbook.org/ns/docbook">
    <entry>7.0.0</entry><entry>T1Lib support was removed from PHP, thus this function was removed.</entry>
</row>'>

<!ENTITY gd.deprecated.gd-formats '<warning xmlns="http://docbook.org/ns/docbook"><simpara>The GD
and GD2 image formats are proprietary image formats of libgd. They have to be regarded
<emphasis>obsolete</emphasis>, and should only be used for development and testing
purposes.</simpara></warning>'>

<!ENTITY gd.changelog.image-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>image</parameter> expects a <classname>GdImage</classname>
  instance now; previously, a <type>resource</type> was expected.
 </entry>
</row>'>

<!-- DBM notes -->

<!ENTITY dbm.dbm-identifier.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
dbm_identifier</parameter></term><listitem><para>The DBM link identifier,
returned by <function>dbmopen</function>.</para></listitem></varlistentry>'>

<!-- JSON notes -->

<!ENTITY json.implementation.superset '
 <note xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <para>
   PHP implements a superset of JSON as specified in the original
   <link xlink:href="&url.rfc;7159">RFC 7159</link>.
  </para>
 </note>
'>

<!-- cURL notes -->

<!ENTITY curl.ch.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>handle</parameter>
</term><listitem><para>A cURL handle returned by
<function>curl_init</function>.</para></listitem></varlistentry>'>

<!ENTITY curl.mh.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>multi_handle</parameter>
</term><listitem><para>A cURL multi handle returned by
<function>curl_multi_init</function>.</para></listitem></varlistentry>'>

<!ENTITY curl.sh.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>share_handle</parameter>
</term><listitem><para>A cURL share handle returned by
<function>curl_share_init</function>.</para></listitem></varlistentry>'>

<!ENTITY curl.changelog.handle-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>handle</parameter> expects a <classname>CurlHandle</classname>
  instance now; previously, a <type>resource</type> was expected.
 </entry>
</row>'>

<!ENTITY curl.changelog.multi-handle-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>multi_handle</parameter> expects a <classname>CurlMultiHandle</classname>
  instance now; previously, a <type>resource</type> was expected.
 </entry>
</row>'>

<!ENTITY curl.changelog.share-handle-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>share_handle</parameter> expects a <classname>CurlShareHandle</classname>
  instance now; previously, a <type>resource</type> was expected.
 </entry>
</row>'>

<!-- dbase notes -->

<!ENTITY dbase.type-conversion '<para xmlns="http://docbook.org/ns/docbook">
   Each field is converted to the appropriate PHP type, except:
   <itemizedlist>
    <listitem>
     <simpara>
      Dates are left as strings.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      DateTime values are converted to strings.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Integers outside the range
      <constant>PHP_INT_MIN</constant>..<constant>PHP_INT_MAX</constant> are
      returned as strings.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Before dbase 7.0.0, booleans (<literal>L</literal>) were converted to <literal>1</literal> or
      <literal>0</literal>.
     </simpara>
    </listitem>
   </itemizedlist>
  </para>'>

<!-- enchant entities -->

<!ENTITY enchant.param.broker '<varlistentry xmlns="http://docbook.org/ns/docbook">
     <term><parameter>broker</parameter></term>
     <listitem>
      <para>
       An Enchant broker returned by <function>enchant_broker_init</function>.
      </para>
     </listitem>
    </varlistentry>'>

<!ENTITY enchant.param.dictionary '<varlistentry xmlns="http://docbook.org/ns/docbook">
     <term><parameter>dictionary</parameter></term>
     <listitem>
      <para>
       An Enchant dictionary returned by <function>enchant_broker_request_dict</function>
       or <function>enchant_broker_request_pwl_dict</function>.
      </para>
     </listitem>
    </varlistentry>'>

<!ENTITY enchant.changelog.broker-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>broker</parameter> expects an <classname>EnchantBroker</classname> instance now;
  previoulsy, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY enchant.changelog.dictionary-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>dictionary</parameter> expects an <classname>EnchantDictionary</classname> instance now;
  previoulsy, a &resource; was expected.
 </entry>
</row>'>

<!-- IMAP notes -->

<!ENTITY imap.changelog.imap-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>imap</parameter> parameter expects an <classname>IMAP\Connection</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY imap.imap-parameter.imap '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
imap</parameter></term><listitem><para>An <classname>IMAP\Connection</classname> instance.</para></listitem></varlistentry>'>

<!-- Deprecated -->
<!ENTITY imap.imap-stream.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
imap</parameter></term><listitem><para>An IMAP stream returned by
<function>imap_open</function>.</para></listitem></varlistentry>'>

<!ENTITY imap.pattern '<para xmlns="http://docbook.org/ns/docbook">Specifies where in the mailbox hierarchy
to start searching.</para><para xmlns="http://docbook.org/ns/docbook">There are two special characters you can
pass as part of the <parameter>pattern</parameter>:
&apos;<literal>*</literal>&apos; and &apos;<literal>&#37;</literal>&apos;.
&apos;<literal>*</literal>&apos; means to return all mailboxes. If you pass
<parameter>pattern</parameter> as &apos;<literal>*</literal>&apos;, you will
get a list of the entire mailbox hierarchy.
&apos;<literal>&#37;</literal>&apos;
means to return the current level only.
&apos;<literal>&#37;</literal>&apos; as the <parameter>pattern</parameter>
parameter will return only the top level
mailboxes; &apos;<literal>~/mail/&#37;</literal>&apos; on <literal>UW_IMAPD</literal> will return every mailbox in the <filename>~/mail</filename> directory, but none in subfolders of that directory.</para>'>

<!ENTITY imap.mailboxname.insecure '<warning xmlns="http://docbook.org/ns/docbook"><simpara>
Passing untrusted data to this parameter is <emphasis>insecure</emphasis>, unless
<link linkend="ini.imap.enable-insecure-rsh">imap.enable_insecure_rsh</link> is disabled.
</simpara></warning>'>

<!-- intl notes -->

<!ENTITY intl.parameter.intl-calendar '<para xmlns="http://docbook.org/ns/docbook">An <classname>IntlCalendar</classname> instance.</para>'>

<!ENTITY intl.error.intl-calendar '<para xmlns="http://docbook.org/ns/docbook">On failure &false; is also returned. To detect error conditions use <function>intl_get_error_code</function>, or set up Intl to throw <link linkend="ini.intl.use-exceptions">exceptions</link>.</para>'>

<!ENTITY intl.codepoint.parameter '<para xmlns="http://docbook.org/ns/docbook">The <type>int</type> codepoint value (e.g. <literal>0x2603</literal> for <emphasis>U+2603 SNOWMAN</emphasis>), or the character encoded as a UTF-8 <type>string</type> (e.g. <literal>"\u{2603}"</literal>)</para>'>

<!ENTITY intl.codepoint.return '<para xmlns="http://docbook.org/ns/docbook">The return type will be <type>int</type> unless the code point was passed as a UTF-8 <type>string</type>, in which case a <type>string</type> will be returned.</para>'>

<!ENTITY intl.codepoint.example 'Testing different code points'>

<!ENTITY intl.locale-len.return '<para xmlns="http://docbook.org/ns/docbook">Returns &null; when the length of <parameter>locale</parameter> exceeds <constant>INTL_MAX_LOCALE_LEN</constant>.</para>'>

<!ENTITY intl.property.parameter '<para xmlns="http://docbook.org/ns/docbook">The Unicode property to lookup (see the <literal>IntlChar::PROPERTY_*</literal> constants).</para>'>

<!ENTITY intl.property.example 'Testing different properties'>

<!-- LDAP notes -->

<!ENTITY ldap.parameter.ldap 'An <classname xmlns="http://docbook.org/ns/docbook">LDAP\Connection</classname> instance, returned by <function xmlns="http://docbook.org/ns/docbook">ldap_connect</function>.'>

<!ENTITY ldap.parameter.result 'An <classname xmlns="http://docbook.org/ns/docbook">LDAP\Result</classname> instance, returned by <function xmlns="http://docbook.org/ns/docbook">ldap_list</function> or <function xmlns="http://docbook.org/ns/docbook">ldap_search</function>.'>

<!ENTITY ldap.parameter.entry 'An <classname xmlns="http://docbook.org/ns/docbook">LDAP\ResultEntry</classname> instance.'>

<!ENTITY ldap.warn.control-paged '<warning xmlns="http://docbook.org/ns/docbook">
 <simpara>
  This function has been <emphasis>DEPRECATED</emphasis> as of PHP 7.4.0, and <emphasis>REMOVED</emphasis> as of PHP 8.0.0.
  Instead the <parameter>controls</parameter> parameter of <function>ldap_search</function> should be used.
  See also <link linkend="ldap.controls">LDAP Controls</link> for details.
 </simpara>
</warning>'>

<!ENTITY ldap.changelog.controls-nullable '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>controls</parameter> is nullable now; previously, it defaulted to <literal>[]</literal>.
 </entry>
</row>'>

<!ENTITY ldap.changelog.ldap-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>ldap</parameter> parameter expects an <classname>LDAP\Connection</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY ldap.changelog.entry-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>entry</parameter> parameter expects an <classname>LDAP\ResultEntry</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY ldap.changelog.result-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>result</parameter> parameter expects an <classname>LDAP\Result</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY ldap.changelog.return-result-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  Returns an <classname>LDAP\Result</classname> instance now;
  previously, a &resource; was returned.
 </entry>
</row>'>

<!ENTITY ldap.changelog.return-result-entry-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  Returns an <classname>LDAP\ResultEntry</classname> instance now;
  previously, a &resource; was returned.
 </entry>
</row>'>

<!ENTITY ldap.return-result 'Returns an <classname xmlns="http://docbook.org/ns/docbook">LDAP\Result</classname> instance,&return.falseforfailure;.'>

<!-- mbstring notes -->

<!ENTITY note.mbstring.encoding.internal '<note xmlns="http://docbook.org/ns/docbook"><para>The internal encoding or the
character encoding specified by <function>mb_regex_encoding</function>
will be used as the character encoding for this function.</para></note>'>

<!ENTITY note.mbstring.encoding.current '<note xmlns="http://docbook.org/ns/docbook"><para>The
character encoding specified by <function>mb_regex_encoding</function>
will be used as the character encoding for this function by default.</para></note>'>

<!ENTITY mbstring.encoding.parameter '<para xmlns="http://docbook.org/ns/docbook">The <parameter>encoding</parameter>
parameter is the character encoding. If it is omitted or &null;, the internal character
encoding value will be used.</para>'>

<!ENTITY mbstring.warning.e-modifier '<warning xmlns="http://docbook.org/ns/docbook"><para>Never use the <literal>e</literal> modifier when working on untrusted input. No automatic escaping will happen (as known from <function>preg_replace</function>). Not taking care of this will most likely create remote code execution vulnerabilities in your application.</para></warning>'>

<!ENTITY mbstring.changelog.encoding-nullable '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>encoding</parameter> is nullable now.
 </entry>
</row>'>

<!ENTITY mbstring.changelog.needle-empty '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>needle</parameter> now accepts an empty string.
 </entry>
</row>'>

<!-- mcrypt notes -->

<!ENTITY mcrypt.parameter.cipher '<para xmlns="http://docbook.org/ns/docbook">One of the <constant>MCRYPT_ciphername</constant> constants, or the name of the algorithm as string.</para>'>

<!ENTITY mcrypt.parameter.iv '<para xmlns="http://docbook.org/ns/docbook">Used for the initialization in CBC, CFB, OFB modes, and in some algorithms in STREAM mode. If you do not supply an IV, while it is needed for an algorithm, the function issues a warning and uses an IV with all its bytes set to "<literal>\0</literal>".</para>'>

<!ENTITY mcrypt.parameter.iv.strict '<para xmlns="http://docbook.org/ns/docbook">Used for the initialization in CBC, CFB, OFB modes, and in some algorithms in STREAM mode. If the provided IV size is not supported by the chaining mode or no IV was provided, but the chaining mode requires one, the function will emit a warning and return &false;.</para>'>

<!ENTITY mcrypt.parameter.mode '<para xmlns="http://docbook.org/ns/docbook">One of the <constant>MCRYPT_MODE_modename</constant> constants, or one of the following strings: "ecb", "cbc", "cfb", "ofb", "nofb" or "stream".</para>'>

 <!-- MCVE notes -->

<!ENTITY mcve.conn.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
conn</parameter></term><listitem><para>An MCVE_CONN resource returned by
<function>m_initengine</function>.</para></listitem></varlistentry>'>

<!-- memcached notes -->

<!ENTITY memcached.parameter.expiration 'The expiration time, defaults to 0. See <link
 linkend="memcached.expiration" xmlns="http://docbook.org/ns/docbook">Expiration Times</link> for more info.'>

<!ENTITY memcached.parameter.server_key 'The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.'>

<!ENTITY memcached.parameter.items 'An array of key/value pairs to store on the server.'>

<!ENTITY memcached.parameter.key 'The key under which to store the value.'>

<!ENTITY memcached.parameter.value 'The value to store.'>

<!ENTITY memcached.result.getresultcode 'Use <methodname xmlns="http://docbook.org/ns/docbook">Memcached::getResultCode</methodname> if necessary.'>

<!-- password notes -->

<!ENTITY password.parameter.algo 'A <link xmlns="http://docbook.org/ns/docbook" linkend="password.constants">password algorithm constant</link> denoting the algorithm to use when hashing the password.'>

<!ENTITY password.parameter.hash 'A hash created by <function xmlns="http://docbook.org/ns/docbook">password_hash</function>.'>

<!ENTITY password.parameter.options 'An associative array containing options. See the <link xmlns="http://docbook.org/ns/docbook" linkend="password.constants">password algorithm constants</link> for documentation on the supported options for each algorithm.'>

<!ENTITY password.parameter.password 'The user&apos;s password.'>

<!-- pspell notes -->

<!ENTITY pspell.changelog.pspell-dictionary '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>dictionary</parameter> parameter expects an <classname>PSpell\Dictionary</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY pspell.changelog.pspell-config '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>config</parameter> parameter expects an <classname>PSpell\Config</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY pspell.parameter.pspell-dictionary '<para xmlns="http://docbook.org/ns/docbook">An <classname>PSpell\Dictionary</classname> instance.</para>'>

<!ENTITY pspell.parameter.pspell-config '<para xmlns="http://docbook.org/ns/docbook">An <classname>PSpell\Config</classname> instance.</para>'>

<!-- socket entities -->

<!ENTITY sockets.changelog.socket-param '<row xmlns="http://docbook.org/ns/docbook">
  <entry>8.0.0</entry>
  <entry>
   <parameter>socket</parameter> is a <classname>Socket</classname> instance now;
   previously, it was a <type>resource</type>.
  </entry>
 </row>'>

<!ENTITY sockets.changelog.address-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>address</parameter> is an <classname>AddressInfo</classname> instance now;
  previously, it was a <type>resource</type>.
 </entry>
</row>'>

<!-- geaman notes -->

<!ENTITY gearman.parameter.host 'The job server host name.'>

<!ENTITY gearman.parameter.port 'The job server port.'>

<!ENTITY gearman.parameter.functionname 'A registered function the worker is to execute'>

<!ENTITY gearman.parameter.workload 'Serialized data to be processed'>

<!ENTITY gearman.parameter.data 'Additional data that may be needed to complete the work'>

<!ENTITY gearman.parameter.context 'Application context to associate with a task'>

<!ENTITY gearman.parameter.unique 'A unique ID used to identify a particular task'>

<!ENTITY gearman.parameter.jobhandle 'The job handle assigned by the Gearman server'>

<!-- Date and time entities -->
<!ENTITY date.timezone.intro.title '<title xmlns="http://docbook.org/ns/docbook">List of Supported Timezones</title>'>

<!ENTITY date.timezone.intro "<para xmlns='http://docbook.org/ns/docbook'>
Here you'll find the complete list of timezones supported by PHP, which are
meant to be used with e.g. <function>date_default_timezone_set</function>.
<caution><simpara>The behavior of timezones not listed here is undefined.</simpara></caution>
</para><note xmlns='http://docbook.org/ns/docbook'><simpara>The latest version of the timezone database can be
installed via PECL's <link xlink:href='&url.pecl.package.get;timezonedb' xmlns:xlink='http://www.w3.org/1999/xlink'>timezonedb</link>.
</simpara></note>">

<!ENTITY date.timezone.bc '<simpara xmlns="http://docbook.org/ns/docbook">Please do not use any of the timezones
listed here (besides UTC), they only exist for backward compatible reasons, and may expose erroneous behavior.
Furthermore, these timezones may be removed from the IANA timezone database at any time.
</simpara>'>

<!ENTITY date.timezone.posix-signs '<simpara xmlns="http://docbook.org/ns/docbook">
 If you disregard the above warning, please also note that the IANA
 timezone database that provides PHP&apos;s timezone support uses POSIX style
 signs, which results in the <literal>Etc/GMT+n</literal> and
 <literal>Etc/GMT-n</literal> time zones being reversed from common usage.
</simpara>
<simpara xmlns="http://docbook.org/ns/docbook">
 For example, the time zone 8 hours ahead of GMT that is used in China and
 Western Australia (among other places) is actually
 <literal>Etc/GMT-8</literal> in this database, not
 <literal>Etc/GMT+8</literal> as you would normally expect.
</simpara>
<simpara xmlns="http://docbook.org/ns/docbook">
 Once again, it is strongly recommended that you use the correct time zone
 for your location, such as <literal>Asia/Shanghai</literal> or
 <literal>Australia/Perth</literal> for the above examples.
</simpara>'>

<!ENTITY date.timezone.abbrev-volatile '<simpara xmlns="http://docbook.org/ns/docbook">
These timezone abbreviations have to be regarded as highly volatile, i.e. they
might be different for each timezonedb release, and should not be relied upon.
It is strongly recommended to avoid timezone abbreviations.
</simpara>'>

<!ENTITY date.timezone.errors.description '<para xmlns="http://docbook.org/ns/docbook">
Every call to a date/time function will generate a <constant>E_WARNING</constant>
if the time zone is not valid. See also <function>date_default_timezone_set</function></para>'>

<!ENTITY date.timezone.errors.changelog '<row xmlns="http://docbook.org/ns/docbook"><entry>5.1.0</entry><entry><para>
Now issues the <constant>E_STRICT</constant> and <constant>E_NOTICE</constant>
time zone errors.</para></entry></row>'>

<!ENTITY date.timestamp.description '
<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>timestamp</parameter></term><listitem><para>
The optional <parameter>timestamp</parameter> parameter is an
<type>int</type> Unix timestamp that defaults to the current
local time if <parameter>timestamp</parameter> is omitted or &null;. In other
words, it defaults to the value of <function>time</function>.
</para></listitem></varlistentry>'>

<!ENTITY date.datetime.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>object</parameter></term>
<listitem><para>Procedural style only: A <classname>DateTime</classname> object
returned by <function>date_create</function></para></listitem></varlistentry>'>

<!ENTITY date.datetime.description.modified '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>object</parameter></term>
<listitem><para>Procedural style only: A <classname>DateTime</classname> object
returned by <function>date_create</function>.
The function modifies this object.</para></listitem></varlistentry>'>

<!ENTITY date.datetimezone.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
object</parameter></term><listitem><para>Procedural style only: A <classname>DateTimeZone</classname> object
returned by <function>timezone_open</function></para></listitem></varlistentry>'>

<!ENTITY date.datetime.return.modifiedobjectorfalseforfailure 'Returns the <classname xmlns="http://docbook.org/ns/docbook">DateTime</classname> object for method chaining&return.falseforfailure;.'>

<!ENTITY date.timezone.dbversion 'This list is based upon the timezone database version'>

<!ENTITY date.timezone.africa 'Africa'>
<!ENTITY date.timezone.america 'America'>
<!ENTITY date.timezone.antarctica 'Antarctica'>
<!ENTITY date.timezone.arctic 'Arctic'>
<!ENTITY date.timezone.asia 'Asia'>
<!ENTITY date.timezone.atlantic 'Atlantic'>
<!ENTITY date.timezone.australia 'Australia'>
<!ENTITY date.timezone.europe 'Europe'>
<!ENTITY date.timezone.indian 'Indian'>
<!ENTITY date.timezone.pacific 'Pacific'>
<!ENTITY date.timezone.others 'Others'>
<!ENTITY date.timezone.abbreviations 'Abbreviations'>

<!ENTITY date.formats 'Valid formats are explained in <link xmlns="http://docbook.org/ns/docbook" linkend="datetime.formats">Date and Time Formats</link>.'>
<!ENTITY date.formats.parameter 'A date/time string. &date.formats;'>

<!-- DomXml Notes -->
<!ENTITY node.inserted 'This node will not show up in the document unless it
is inserted with (e.g.) <function xmlns="http://docbook.org/ns/docbook">domnode_append_child</function>.'>


<!-- Dom Notes -->
<!ENTITY dom.node.inserted 'This node will not show up in the document unless
it is inserted with (e.g.) <function xmlns="http://docbook.org/ns/docbook">DOMNode::appendChild</function>.'>

<!ENTITY dom.allowstatic '<para xmlns="http://docbook.org/ns/docbook">Prior to PHP 8.0.0 this method
<emphasis>could</emphasis> be called statically, but would issue an <constant>E_DEPRECATED</constant> error.
As of PHP 8.0.0 calling this method statically throws an <classname>Error</classname> exception</para>'>
<!ENTITY dom.malformederror '<para xmlns="http://docbook.org/ns/docbook">While malformed HTML should load successfully, this function may generate <constant>E_WARNING</constant> errors when it encounters bad markup. <link linkend="function.libxml-use-internal-errors">libxml&apos;s error handling functions</link> may be used to handle these errors.</para>'>
<!ENTITY dom.note.utf8 '<note xmlns="http://docbook.org/ns/docbook"><para>The DOM extension uses UTF-8 encoding. Use <function>utf8_encode</function> and <function>utf8_decode</function> to work with texts in ISO-8859-1 encoding or <link linkend="ref.iconv">iconv</link> for other encodings.</para></note>'>
<!ENTITY dom.note.json '<note xmlns="http://docbook.org/ns/docbook"><para>When using <function>json_encode</function> on a <classname>DOMDocument</classname> object the result will be that of encoding an empty object.</para></note>'>



<!-- Dom Examples -->
<!ENTITY dom.book.example '<para xmlns="http://docbook.org/ns/docbook">The following examples use <filename>book.xml</filename> which contains the following:</para>
<programlisting role="xml" xmlns="http://docbook.org/ns/docbook">
<!-- Warning: The CDATA markup here is a little tricky. Please DO NOT BREAK it! -->
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE books [
  <!ELEMENT books   (book+)>
  <!ELEMENT book    (title, author+, xhtml:blurb?)>
  <!ELEMENT title   (#PCDATA)>
  <!ELEMENT blurb   (#PCDATA)>
  <!ELEMENT author  (#PCDATA)>
  <!ATTLIST books   xmlns        CDATA  #IMPLIED>
  <!ATTLIST books   xmlns:xhtml  CDATA  #IMPLIED>
  <!ATTLIST book    id           ID     #IMPLIED>
  <!ATTLIST author  email        CDATA  #IMPLIED>
]>
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<books xmlns="http://books.php/" xmlns:xhtml="http://www.w3.org/1999/xhtml">
  <book id="php-basics">
    <title>PHP Basics</title>
    <author email="jim.smith@basics.php">Jim Smith</author>
    <author email="jane.smith@basics.php">Jane Smith</author>
    <xhtml:blurb><![CDATA[
<p><em>PHP Basics</em> provides an introduction to PHP.</p>
]]]]><![CDATA[></xhtml:blurb>
  </book>
  <book id="php-advanced">
    <title>PHP Advanced Programming</title>
    <author email="jon.doe@advanced.php">Jon Doe</author>
  </book>
</books>
]]></programlisting>'>


<!-- FileSystem entities -->
<!ENTITY fs.emits.warning.on.failure '<para xmlns="http://docbook.org/ns/docbook">
Upon failure, an <constant>E_WARNING</constant> is emitted.
</para>'>

<!ENTITY fs.validfp.all '<para xmlns="http://docbook.org/ns/docbook">The file pointer must be valid, and must point to
a file successfully opened by <function>fopen</function> or
<function>fsockopen</function> (and not yet closed by
<function>fclose</function>).</para>'>

<!ENTITY fs.file.pointer '<para xmlns="http://docbook.org/ns/docbook">A file system pointer <type>resource</type>
that is typically created using <function>fopen</function>.</para>'>

<!ENTITY fs.file.32bit '<note xmlns="http://docbook.org/ns/docbook"><simpara>
    Because PHP&apos;s integer type is signed and many platforms use 32bit integers,
    some filesystem functions may return unexpected results for files which
    are larger than 2GB.
   </simpara></note>'>

<!ENTITY ini.scanner.typed '<para xmlns="http://docbook.org/ns/docbook">
    As of PHP 5.6.1 can also be specified as <constant>INI_SCANNER_TYPED</constant>.
    In this mode boolean, null and integer types are preserved when possible.
    String values <literal>"true"</literal>, <literal>"on"</literal> and <literal>"yes"</literal>
    are converted to &true;. <literal>"false"</literal>, <literal>"off"</literal>, <literal>"no"</literal>
    and <literal>"none"</literal> are considered &false;. <literal>"null"</literal> is converted to &null;
    in typed mode. Also, all numeric strings are converted to integer type if it is possible.
   </para>'>

<!-- GNUPG -->
<!ENTITY gnupg.identifier '<para xmlns="http://docbook.org/ns/docbook">The gnupg identifier, from a call to
<function>gnupg_init</function> or <classname>gnupg</classname>.</para>'>

<!ENTITY gnupg.fingerprint '<para xmlns="http://docbook.org/ns/docbook">The fingerprint key.</para>'>

<!-- HaruDoc -->
<!ENTITY haru.error '<para xmlns="http://docbook.org/ns/docbook">Throws a <classname>HaruException</classname> on error.</para>'>

<!-- ODBC -->
<!ENTITY odbc.connection.id '<para xmlns="http://docbook.org/ns/docbook">The ODBC connection identifier,
see <function>odbc_connect</function> for details.</para>'>

<!ENTITY odbc.parameter.catalog 'The catalog (&apos;qualifier&apos; in ODBC 2 parlance).'>

<!ENTITY odbc.parameter.schema 'The schema (&apos;owner&apos; in ODBC 2 parlance).'>

<!ENTITY odbc.parameter.search 'This parameter accepts the following search patterns:
<literal xmlns="http://docbook.org/ns/docbook">&#x25;</literal> to match zero or more characters,
and <literal xmlns="http://docbook.org/ns/docbook">_</literal> to match a single character.'>

<!ENTITY odbc.result.driver-specific 'Drivers can report additional columns.'>

<!-- OAUTH -->
<!ENTITY oauth.callback.error 'Emits an <constant xmlns="http://docbook.org/ns/docbook">E_ERROR</constant> level
error if the callback function cannot be called, or was not specified.'>

<!ENTITY oauth.changelog.error.null 'Previously returned &null; on failure, instead of &false;.'>

<!-- Oracle -->
<!ENTITY oci.db "<para xmlns='http://docbook.org/ns/docbook' xmlns:xlink='http://www.w3.org/1999/xlink'>Contains
the <literal>Oracle instance</literal> to connect to. It can be
an <link xlink:href='&url.oracle.oic.connect;'>Easy Connect
string</link>, or a Connect Name from
the <filename>tnsnames.ora</filename> file, or the name of a local
Oracle instance.
</para>
<para xmlns='http://docbook.org/ns/docbook'>If not specified or &null;, PHP uses
environment variables such as <constant>TWO_TASK</constant> (on Linux)
or <constant>LOCAL</constant> (on Windows)
and <constant>ORACLE_SID</constant> to determine the
<literal>Oracle instance</literal> to connect to.
</para>
<para xmlns='http://docbook.org/ns/docbook'>
To use the Easy Connect naming method, PHP must be linked with Oracle
10<emphasis>g</emphasis> or greater Client libraries. The Easy Connect string for Oracle
10<emphasis>g</emphasis> is of the form:
<emphasis>[//]host_name[:port][/service_name]</emphasis>. From Oracle
11<emphasis>g</emphasis>, the syntax is:
<emphasis>[//]host_name[:port][/service_name][:server_type][/instance_name]</emphasis>.
Further options were introduced with Oracle 19c, including timeout and keep-alive
settings.  Refer to Oracle documentation.  Service names can be found by running
the Oracle utility <literal>lsnrctl status</literal> on the database server
machine.
</para>
<para xmlns='http://docbook.org/ns/docbook'>
The <filename>tnsnames.ora</filename> file can be in the Oracle Net search path,
which
includes <filename>/your/path/to/instantclient/network/admin</filename>, <filename>$ORACLE_HOME/network/admin</filename>
and <filename>/etc</filename>.  Alternatively set <literal>TNS_ADMIN</literal>
so that <filename>$TNS_ADMIN/tnsnames.ora</filename> is read.  Make sure the web
daemon has read access to the file.
</para>">

<!ENTITY oci.charset "<para xmlns='http://docbook.org/ns/docbook'>Determines
the character set used by the Oracle Client libraries.  The character
set does not need to match the character set used by the database.  If
it doesn't match, Oracle will do its best to convert data to and from
the database character set.  Depending on the character sets this may
not give usable results.  Conversion also adds some time overhead.
</para>
<para xmlns='http://docbook.org/ns/docbook'>If not specified, the
Oracle Client libraries determine a character set from
the <constant>NLS_LANG</constant> environment variable.
</para>
<para xmlns='http://docbook.org/ns/docbook'>Passing this parameter can
reduce the time taken to connect.
</para>">

<!ENTITY oci.sessionmode '<para xmlns="http://docbook.org/ns/docbook">This
parameter is available since version PHP 5 (PECL OCI8 1.1) and accepts the
following values: <constant>OCI_DEFAULT</constant>,
<constant>OCI_SYSOPER</constant> and <constant>OCI_SYSDBA</constant>.
If either <constant>OCI_SYSOPER</constant> or
<constant>OCI_SYSDBA</constant> were specified, this function will try
to establish privileged connection using external credentials.
Privileged connections are disabled by default. To enable them you
need to set <link linkend="ini.oci8.privileged-connect">oci8.privileged_connect</link>
to <literal>On</literal>.
</para>
<para xmlns="http://docbook.org/ns/docbook">
PHP 5.3 (PECL OCI8 1.3.4) introduced the
<constant>OCI_CRED_EXT</constant> mode value. This tells Oracle to use
External or OS authentication, which must be configured in the
database.  The <constant>OCI_CRED_EXT</constant> flag can only be used
with username of &quot;/&quot; and a empty password.
<link linkend="ini.oci8.privileged-connect">oci8.privileged_connect</link>
may be <literal>On</literal> or <literal>Off</literal>.
</para>
<para xmlns="http://docbook.org/ns/docbook">
<constant>OCI_CRED_EXT</constant> may be combined with the
<constant>OCI_SYSOPER</constant> or
<constant>OCI_SYSDBA</constant> modes.
</para>
<para xmlns="http://docbook.org/ns/docbook">
<constant>OCI_CRED_EXT</constant> is not supported on Windows for
security reasons.
</para>'>

<!ENTITY oci.datatypes '<para xmlns="http://docbook.org/ns/docbook">For details on the data type mapping performed by
the OCI8 extension, see the <link linkend="oci8.datatypes">datatypes
supported by the driver</link></para>'>

<!ENTITY oci.parameter.connection '<para xmlns="http://docbook.org/ns/docbook">An Oracle connection identifier,
returned by <function>oci_connect</function>, <function>oci_pconnect</function>,
or <function>oci_new_connect</function>.</para>'>

<!ENTITY oci.availability.note.10g '<note xmlns="http://docbook.org/ns/docbook"><title>Oracle version requirement</title>
<para>This function is available when PHP is linked with Oracle Database
libraries from version 10<emphasis>g</emphasis> onwards.</para></note>'>

<!ENTITY oci.clientinfo.tip '<tip xmlns="http://docbook.org/ns/docbook"><title>Performance</title><para>With older versions of
OCI8 or the Oracle Database, the client information can be set using the Oracle
<literal>DBMS_APPLICATION_INFO</literal> package. This is less efficient than
using <function>oci_set_client_info</function>.</para></tip>'>

<!ENTITY oci.roundtrip.caution '<caution xmlns="http://docbook.org/ns/docbook"><title>Round-trip Gotcha</title>
<para>Some but not all OCI8 functions cause round-trips.  Round-trips to the
database may not occur with queries when result caching is enabled.
</para></caution>'>

<!ENTITY oci.use.setprefetch '<para xmlns="http://docbook.org/ns/docbook">For
queries returning a large number of rows, performance can be
significantly improved by
increasing <link linkend="ini.oci8.default-prefetch">oci8.default_prefetch</link>
or using <function>oci_set_prefetch</function>.
</para>'>


<!ENTITY oci.arg.statement.id
"<para xmlns='http://docbook.org/ns/docbook'>A valid OCI8 statement
identifier created by <function>oci_parse</function> and executed
by <function>oci_execute</function>, or a <literal>REF
CURSOR</literal> statement identifier.</para>">

<!-- PCNTL Notes -->
<!ENTITY pcntl.parameter.status '<para xmlns="http://docbook.org/ns/docbook">The <parameter>status</parameter>
parameter is the status parameter supplied to a successful
call to <function>pcntl_waitpid</function>.</para>'>

<!-- PS Notes -->
<!ENTITY ps.note.visible '<para xmlns="http://docbook.org/ns/docbook">The note will not be visible if the document
is printed or viewed but it will show up if the document is converted to
pdf by either Acrobat Distiller™ or Ghostview.</para>'>

<!-- Notes for safe-mode limited functions: -->

<!-- Not used in EN anymore -->
<!ENTITY note.sm.disabled '<note xmlns="http://docbook.org/ns/docbook"><simpara>&sm.disabled;</simpara></note>'>

<!-- Not used in EN anymore -->
<!ENTITY note.sm.uidcheck '<note xmlns="http://docbook.org/ns/docbook"><simpara>When <link
linkend="features.safe-mode">safe mode</link> is enabled, PHP checks whether
the files or directories being operated upon have the same UID (owner) as the
script that is being executed.</simpara></note>'>

<!-- Not used in EN anymore -->
<!ENTITY note.sm.uidcheck.dir '<note xmlns="http://docbook.org/ns/docbook"><simpara>When <link
linkend="features.safe-mode">safe mode</link> is enabled, PHP checks whether
the directory in which the script is operating has the same UID (owner) as the
script that is being executed.</simpara></note>'>

<!ENTITY note.open-basedir.func '<note xmlns="http://docbook.org/ns/docbook"><para>This function is affected by <link
linkend="ini.open-basedir">open_basedir</link>.</para></note>'>


<!ENTITY note.language-construct '<note xmlns="http://docbook.org/ns/docbook"><simpara>Because this is a
language construct and not a function, it cannot be called using
<link linkend="functions.variable-functions">variable functions</link>.</simpara>
</note>'>

<!-- Common pieces in features/safe-mode.xml
     Jade doesn't allow in-line entities, so I put them here... Though they
     should have been inline in safe-mode.xml -->

<!-- Not used in EN anymore -->
<!ENTITY sm.uidcheck 'Checks whether the files or directories being operated
upon have the same UID (owner) as the script that is being executed.'>

<!-- Not used in EN anymore -->
<!ENTITY warn.sm.exec '<warning xmlns="http://docbook.org/ns/docbook"><simpara>With <link linkend="features.safe-mode">safe mode</link> enabled,
the command string is escaped with <function>escapeshellcmd</function>. Thus,
<literal>echo y | echo x</literal> becomes <literal>echo y \| echo x</literal>.</simpara></warning>'>

<!-- Not used in EN anymore -->
<!ENTITY note.exec-path '<note xmlns="http://docbook.org/ns/docbook"><simpara>When
<link linkend="features.safe-mode">safe mode</link> is enabled, you can only
execute files within the <link linkend="ini.safe-mode-exec-dir">safe_mode_exec_dir</link>.
For practical reasons, it is currently not allowed to have <literal>..</literal>
components in the path to the executable.</simpara></note>'>

<!-- Not used in EN anymore -->
<!ENTITY sm.uidcheck.dir 'Checks whether the directory in which
the script is operating has the same UID (owner) as the script that is being
executed.'>

<!-- Not used in EN anymore -->
<!ENTITY sm.disabled 'This function is disabled when PHP is running in <link xmlns="http://docbook.org/ns/docbook"
linkend="features.safe-mode">safe mode</link>.'>

<!-- Common pieces in partintro-sections -->
<!ENTITY no.config '<para xmlns="http://docbook.org/ns/docbook">This extension has no configuration directives defined in &php.ini;.</para>'>
<!ENTITY no.resource '<para xmlns="http://docbook.org/ns/docbook">This extension has no resource types defined.</para>'>
<!ENTITY no.constants '<para xmlns="http://docbook.org/ns/docbook">This extension has no constants defined.</para>'>
<!ENTITY no.requirement '<para xmlns="http://docbook.org/ns/docbook">No external libraries are needed to build this extension.</para>'>
<!ENTITY no.install '<para xmlns="http://docbook.org/ns/docbook">There is no installation needed to use these
functions; they are part of the PHP core.</para>'>

<!-- Used in every chapter that has directive descriptions -->
<!ENTITY ini.descriptions.title '<para xmlns="http://docbook.org/ns/docbook">Here&apos;s a short explanation of
the configuration directives.</para>'>

<!-- Common pieces for reference part BEGIN-->

<!-- Used in reference/$extname/ini.xml -->
<!ENTITY extension.runtime '<simpara xmlns="http://docbook.org/ns/docbook">
The behaviour of these functions is affected by settings in &php.ini;.
</simpara>'>

<!ENTITY ini.php.constants 'For further details and definitions of the
PHP_INI_* modes, see the <xref xmlns="http://docbook.org/ns/docbook" linkend="configuration.changes.modes"/>.'>

<!-- Used in reference/$extname/constants.xml -->
<!ENTITY extension.constants '<simpara xmlns="http://docbook.org/ns/docbook">
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
</simpara>'>

<!-- For STANDARD Constants used in reference/$extname/constants.xml -->
<!ENTITY extension.constants.core '<simpara xmlns="http://docbook.org/ns/docbook">
The constants below are always available as part of the PHP core.
</simpara>'>

<!-- Used in reference/$extname/classes.xml -->
<!ENTITY extension.classes '<simpara xmlns="http://docbook.org/ns/docbook">
The classes below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
</simpara>'>

<!ENTITY note.extension.php5 '<note xmlns="http://docbook.org/ns/docbook"><simpara>
This extension requires PHP 5.</simpara></note>'>

<!-- PDO entities -->
<!ENTITY pdo.driver-constants '<simpara xmlns="http://docbook.org/ns/docbook">The constants below are defined by
this driver, and will only be available when the extension has been either
compiled into PHP or dynamically loaded at runtime. In addition, these
driver-specific constants should only be used if you are using this driver.
Using driver-specific attributes with another driver may result in
unexpected behaviour. <function>PDO::getAttribute</function> may be used to
obtain the <constant>PDO::ATTR_DRIVER_NAME</constant> attribute to check the
driver, if your code can run against multiple drivers.</simpara>'>

<!ENTITY pdo.errors.exception-not-errmode '<note xmlns="http://docbook.org/ns/docbook"><simpara>An exception is raised even when the <constant>PDO::ATTR_ERRMODE</constant> attribute is not <constant>PDO::ERRMODE_EXCEPTION</constant>.</simpara></note>'>

<!-- PECL entities -->
<!ENTITY pecl.moved 'This <link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link> extension
is not bundled with PHP.'>

<!ENTITY pecl.bundled 'This <link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link> extension
is bundled with PHP.'>

<!ENTITY pecl.info 'Information for installing this PECL extension may be
found in the manual chapter titled <link xmlns="http://docbook.org/ns/docbook" linkend="install.pecl">Installation
of PECL extensions</link>. Additional information such as new releases,
downloads, source files, maintainer information, and a CHANGELOG, can be
located here: '>

<!ENTITY pecl.info.dead 'This extension is considered unmaintained and dead. However, the source code for
this extension is still available within <acronym xmlns="http://docbook.org/ns/docbook">PECL</acronym>
<acronym xmlns="http://docbook.org/ns/docbook">SVN</acronym> here: '>

<!ENTITY pecl.info.dead.git 'This extension is considered unmaintained and dead. However, the source code for
this extension is still available within <acronym xmlns="http://docbook.org/ns/docbook">PECL</acronym>
<acronym xmlns="http://docbook.org/ns/docbook">GIT</acronym> here: '>

<!ENTITY pecl.windows.download 'A <acronym xmlns="http://docbook.org/ns/docbook">DLL</acronym> for this
<acronym xmlns="http://docbook.org/ns/docbook">PECL</acronym> extension is currently unavailable. See also the
<link xmlns="http://docbook.org/ns/docbook" linkend="install.windows.building">building on Windows</link>
section.'>

<!ENTITY pecl.windows.download.avail 'Windows binaries (<acronym xmlns="http://docbook.org/ns/docbook">DLL</acronym> files) 
for this <acronym xmlns="http://docbook.org/ns/docbook">PECL</acronym> extension are available from the PECL website.'>

<!ENTITY pecl.windows.download.unbundled '&pecl.windows.download;'>

<!ENTITY pecl.moved-ver 'This extension has been moved to the
<link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link> repository and is no longer bundled with
PHP as of PHP '>

<!-- PGSQL entities -->

<!ENTITY pgsql.parameter.connection '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Connection</classname> instance.</para>'>

<!ENTITY pgsql.parameter.connection-with-unspecified-default '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Connection</classname> instance.
When <parameter>connection</parameter> is unspecified, the default connection is used.
The default connection is the last connection made by <function>pg_connect</function>
or <function>pg_pconnect</function>.</para>'>

<!ENTITY pgsql.parameter.connection-with-nullable-default '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Connection</classname> instance.
When <parameter>connection</parameter> is &null;, the default connection is used.
The default connection is the last connection made by <function>pg_connect</function>
or <function>pg_pconnect</function>.</para>'>

<!ENTITY pgsql.parameter.result '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Result</classname> instance, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>(among others).</para>'>

<!ENTITY pgsql.parameter.lob '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Lob</classname> instance, returned by <function>pg_lo_open</function>.</para>'>

<!ENTITY pgsql.changelog.connection-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>connection</parameter> parameter expects an <classname>PgSql\Connection</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY pgsql.changelog.result-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>result</parameter> parameter expects an <classname>PgSql\Result</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY pgsql.changelog.lob-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>lob</parameter> parameter expects an <classname>PgSql\Lob</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>

<!ENTITY pgsql.changelog.return-result-object '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  Returns an <classname>PgSql\Result</classname> instance now;
  previously, a &resource; was returned.
 </entry>
</row>'>

<!-- Common pieces for reference part END -->


<!ENTITY windows.builtin '<simpara xmlns="http://docbook.org/ns/docbook">The Windows version of PHP has built-in
support for this extension. You do not need to load any additional
extensions in order to use these functions.</simpara>'>

<!-- These are here as helpers for manual consistency and brievety-->
<!ENTITY safemode '<link xmlns="http://docbook.org/ns/docbook" linkend="ini.safe-mode">safe mode</link>'>

<!ENTITY sqlsafemode '<link xmlns="http://docbook.org/ns/docbook" linkend="ini.sql.safe-mode">SQL safe mode</link>'>

<!-- APD Notes -->
<!ENTITY apd.debug-level.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
debug_level</parameter></term><listitem><para>An integer which is formed by adding
together the <literal>XXX_TRACE</literal> constants.</para><para>It is not recommended
to use <constant>MEMORY_TRACE</constant>. It is very slow and does not appear to be accurate.
<constant>ASSIGNMENT_TRACE</constant> is not implemented yet.</para><para>To turn on all
functional traces (TIMING, FUNCTIONS, ARGS SUMMARY (like strace -c)) use the value 99</para>
</listitem></varlistentry>'>

<!-- BCMath Notes -->
<!ENTITY bc.scale.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
scale</parameter></term><listitem><para>This optional parameter is used to set the number
of digits after the decimal place in the result. If omitted, it will default to the scale set
globally with the <function>bcscale</function> function, or fallback to <literal>0</literal> if
this has not been set.</para></listitem></varlistentry>'>

<!-- CTYPE Notes -->
<!ENTITY note.ctype.parameter.integer '<note xmlns="http://docbook.org/ns/docbook"><para>
If an <type>int</type> between -128 and 255 inclusive is provided, it is interpreted as
the ASCII value of a single character (negative values have 256 added in order to allow
characters in the Extended ASCII range). Any other integer is interpreted as a string
containing the decimal digits of the integer.</para></note>'>

<!-- FTP Notes -->
<!ENTITY ftp.changelog.ftp-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.1.0</entry>
 <entry>
  The <parameter>ftp</parameter> parameter expects an <classname>FTP\Connection</classname>
  instance now; previously, a &resource; was expected.
 </entry>
</row>'>
<!ENTITY ftp.parameter.ftp '<para xmlns="http://docbook.org/ns/docbook">An <classname>FTP\Connection</classname> instance.</para>'>

<!-- GMP Notes -->
<!ENTITY gmp.return 'A <classname xmlns="http://docbook.org/ns/docbook">GMP</classname> object.'>
<!ENTITY gmp.parameter '<para xmlns="http://docbook.org/ns/docbook">A <classname>GMP</classname> object, an &integer; or a numeric &string;.</para>'>

<!-- MySQLi Notes -->
<!ENTITY mysqli.result.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
result</parameter></term><listitem><para>Procedural style only: A <classname>mysqli_result</classname>
object returned by <function>mysqli_query</function>, <function>mysqli_store_result</function>,
<function>mysqli_use_result</function> or <function>mysqli_stmt_get_result</function>.</para></listitem></varlistentry>'>
<!ENTITY mysqli.link.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
mysql</parameter></term><listitem><para>Procedural style only: A <classname>mysqli</classname> object
returned by <function>mysqli_connect</function> or <function>mysqli_init</function>
</para></listitem></varlistentry>'>
<!ENTITY mysqli.stmt.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
statement</parameter></term><listitem><para>Procedural style only: A <classname>mysqli_stmt</classname> object
returned by <function>mysqli_stmt_init</function>.</para></listitem></varlistentry>'>
<!ENTITY mysqli.available.mysqlnd 'Available only with <link xmlns="http://docbook.org/ns/docbook"
linkend="book.mysqlnd">mysqlnd</link>.'>
<!ENTITY mysqli.charset.note '<note xmlns="http://docbook.org/ns/docbook">
<para>MySQLnd always assumes the server default charset. This charset is sent during connection
hand-shake/authentication, which mysqlnd will use.</para><para>Libmysqlclient uses the default charset set in the
<filename>my.cnf</filename> or by an explicit call to <function>mysqli_options</function> prior to
calling <function>mysqli_real_connect</function>, but after <function>mysqli_init</function>.</para></note>'>
<!ENTITY mysqli.sqlinjection.warning '<warning xmlns="http://docbook.org/ns/docbook">
<title>Security warning: SQL injection</title><para>If the query contains any variable
input then <link linkend="mysqli.quickstart.prepared-statements">parameterized
prepared statements</link> should be used instead. Alternatively, the
data must be properly formatted and all strings must be escaped using 
the <function>mysqli_real_escape_string</function>
function.</para></warning>'>

<!-- Notes for SAPI/Apache -->
<!ENTITY apache.req.module '<simpara xmlns="http://docbook.org/ns/docbook">This function is supported when PHP
is installed as an Apache module webserver.
</simpara>'>

<!-- SimpleXML Notes -->
<!ENTITY simplexml.iteration '<note xmlns="http://docbook.org/ns/docbook"><simpara>SimpleXML has made a rule of adding
iterative properties to most methods. They cannot be viewed using <function>var_dump</function>
or anything else which can examine objects.</simpara></note>'>

<!-- SQLite Notes -->
<!ENTITY sqlite.case-fold '<para xmlns="http://docbook.org/ns/docbook">The column names returned by
<constant>SQLITE_ASSOC</constant> and <constant>SQLITE_BOTH</constant> will be
case-folded according to the value of the
<link linkend="ini.sqlite.assoc-case">sqlite.assoc_case</link> configuration
option.</para>'>

<!ENTITY sqlite.decode-bin '<para xmlns="http://docbook.org/ns/docbook">When the <parameter>decode_binary</parameter>
parameter is set to &true; (the default), PHP will decode the binary encoding
it applied to the data if it was encoded using the
<function>sqlite_escape_string</function>.  You should normally leave this
value at its default, unless you are interoperating with databases created by
other sqlite capable applications.</para>'>

<!ENTITY sqlite.no-unbuffered '<note xmlns="http://docbook.org/ns/docbook"><para>This function cannot be used with
unbuffered result handles.</para></note>'>

<!ENTITY sqlite.param-compat '<note xmlns="http://docbook.org/ns/docbook"><simpara>Two alternative syntaxes are
supported for compatibility with other database extensions (such as MySQL).
The preferred form is the first, where the <parameter>dbhandle</parameter>
parameter is the first parameter to the function.</simpara></note>'>

<!ENTITY sqlite.result-type '<para xmlns="http://docbook.org/ns/docbook">The optional <parameter>result_type</parameter>
parameter accepts a constant and determines how the returned array will be
indexed. Using <constant>SQLITE_ASSOC</constant> will return only associative
indices (named fields) while <constant>SQLITE_NUM</constant> will return
only numerical indices (ordinal field numbers). <constant>SQLITE_BOTH</constant>
will return both associative and numerical indices.
<constant>SQLITE_BOTH</constant> is the default for this function.</para>'>

<!-- Database Notes -->
<!ENTITY database.field-case '<note xmlns="http://docbook.org/ns/docbook"><simpara>Field names returned by this function
are <emphasis>case-sensitive</emphasis>.</simpara></note>'>

<!ENTITY database.fetch-null '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function sets NULL fields to
the PHP &null; value.</simpara></note>'>

<!-- MSQL Notes -->
<!-- The msql.*.description entities are used in the parameters refsect1 -->
<!ENTITY msql.linkid.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
link_identifier</parameter></term><listitem><para>The mSQL connection.
If not specified, the last link opened by <function>msql_connect</function>
is assumed. If no such link is found, the function will try to establish a
link as if <function>msql_connect</function> was called, and use it.
</para></listitem></varlistentry>'>

<!ENTITY msql.result.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
result</parameter></term><listitem><para>The result <type>resource</type> that
is being evaluated. This result comes from a call to
<function>msql_query</function>.</para></listitem></varlistentry>'>

<!ENTITY msql.field-offset.req.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
field_offset</parameter></term><listitem><para>The numerical field offset. The
<parameter>field_offset</parameter> starts at <literal>1</literal>.</para></listitem></varlistentry>'>


<!-- MySQL Notes -->
<!-- The mysql.*.description entities are used in the parameters refsect1 -->
<!ENTITY mysql.linkid.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
link_identifier</parameter></term><listitem><para>The MySQL connection. If the
link identifier is not specified, the last link opened by
<function>mysql_connect</function> is assumed. If no such link is found, it
will try to create one as if <function>mysql_connect</function> had been called
with no arguments. If no connection is found or established, an
<constant>E_WARNING</constant> level error is generated.</para></listitem>
</varlistentry>'>

<!ENTITY mysql.linkid-noreopen.description '<varlistentry
xmlns="http://docbook.org/ns/docbook"><term><parameter>
link_identifier</parameter></term><listitem><para>The MySQL connection. If the
link identifier is not specified, the last link opened by
<function>mysql_connect</function> is assumed. If no connection is found or
established, an <constant>E_WARNING</constant> level error is
generated.</para></listitem></varlistentry>'>

<!ENTITY mysql.result.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
result</parameter></term><listitem><para>The result <type>resource</type> that
is being evaluated. This result comes from a call to
<function>mysql_query</function>.</para></listitem></varlistentry>'>

<!ENTITY mysql.field-offset.req.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
field_offset</parameter></term><listitem><para>The numerical field offset. The
<parameter>field_offset</parameter> starts at <literal>0</literal>. If
<parameter>field_offset</parameter> does not exist, an error of level
<constant>E_WARNING</constant> is also issued.</para></listitem></varlistentry>'>

<!ENTITY mysql.alternative.note '<para xmlns="http://docbook.org/ns/docbook">This extension was deprecated in PHP 5.5.0, and it was removed in PHP 7.0.0.
Instead, the <link linkend="book.mysqli">MySQLi</link> or <link linkend="ref.pdo-mysql">PDO_MySQL</link> extension should be used.
See also <link linkend="mysqlinfo.api.choosing">MySQL: choosing an API</link> guide.
Alternatives to this function include:</para>'>

<!ENTITY mysql.alternative.note.4-3-0 '<para xmlns="http://docbook.org/ns/docbook">This function was deprecated in PHP 4.3.0, and it
and the entire <link linkend="book.mysql">original MySQL extension</link> was removed in PHP 7.0.0.
Instead, use either the actively developed <link linkend="book.mysqli">MySQLi</link> or <link linkend="ref.pdo-mysql">PDO_MySQL</link> extensions.
See also the <link linkend="mysqlinfo.api.choosing">MySQL: choosing an API</link> guide.
Alternatives to this function include:</para>'>

<!ENTITY mysql.alternative.note.5-3-0 '<para xmlns="http://docbook.org/ns/docbook">This function was deprecated in PHP 5.3.0, and it
and the entire <link linkend="book.mysql">original MySQL extension</link> was removed in PHP 7.0.0.
Instead, use either the actively developed <link linkend="book.mysqli">MySQLi</link> or <link linkend="ref.pdo-mysql">PDO_MySQL</link> extensions.
See also the <link linkend="mysqlinfo.api.choosing">MySQL: choosing an API</link> guide.
Alternatives to this function include:</para>'>

<!ENTITY mysql.alternative.note.5-4-0 '<para xmlns="http://docbook.org/ns/docbook">This function was deprecated in PHP 5.4.0, and it
and the entire <link linkend="book.mysql">original MySQL extension</link> was removed in PHP 7.0.0.
Instead, use either the actively developed <link linkend="book.mysqli">MySQLi</link> or <link linkend="ref.pdo-mysql">PDO_MySQL</link> extensions.
See also the <link linkend="mysqlinfo.api.choosing">MySQL: choosing an API</link> guide.
Alternatives to this function include:</para>'>

<!ENTITY mysql.alternative.note.5-5-0 '<para xmlns="http://docbook.org/ns/docbook">This function was deprecated in PHP 5.5.0, and it
and the entire <link linkend="book.mysql">original MySQL extension</link> was removed in PHP 7.0.0.
Instead, use either the actively developed <link linkend="book.mysqli">MySQLi</link> or <link linkend="ref.pdo-mysql">PDO_MySQL</link> extensions.
See also the <link linkend="mysqlinfo.api.choosing">MySQL: choosing an API</link> guide.
Alternatives to this function include:</para>'>

<!ENTITY mysql.close.connections.result.sets '<para xmlns="http://docbook.org/ns/docbook">
Open non-persistent MySQL connections and result sets are automatically destroyed when a 
PHP script finishes its execution. So, while explicitly closing open 
connections and freeing result sets is optional, doing so is recommended. 
This will immediately return resources to PHP and MySQL, which can 
improve performance. For related information, see 
<link linkend="language.types.resource.self-destruct">freeing resources</link></para>'>

<!-- Sybase Notes -->
<!ENTITY sybase.ct.only '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function is only available when
using the CT library interface to Sybase, and not with the DB library.
</simpara></note>'>

<!ENTITY sybase.db.only '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function is only available when
using the DB library interface to Sybase, and not with the CT library.</simpara></note>'>

<!ENTITY sybase.linkid.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
link_identifier</parameter></term><listitem><para>The Sybase connection. If the
link identifier is not specified, the last link opened by
<function>sybase_connect</function> is assumed. If no such link is found, it
will try to create one as if <function>sybase_connect</function> was called
with no arguments. If no connection is found or established, an
<constant>E_WARNING</constant> level error is generated.</para></listitem>
</varlistentry>'>

<!-- CPDF Notes -->
<!ENTITY cpdf.ul '<para xmlns="http://docbook.org/ns/docbook">The optional parameter <parameter>mode</parameter>
determines the unit length. If it is <literal>0</literal> or omitted, the
default unit as specified for the page is used. In other cases, the coordinates
are measured in postscript points, disregarding the current unit.</para>'>

<!ENTITY cpdf.mode.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
mode</parameter></term><listitem><para>The optional parameter <parameter>mode</parameter>
determines the unit length. If it is <literal>0</literal> or omitted, the
default unit as specified for the page is used. In other cases, the coordinates
are measured in postscript points, disregarding the current unit.</para>
</listitem></varlistentry>'>

<!ENTITY cpdf.pdf-document.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
pdf_document</parameter></term><listitem><para>The document handle, returned by
<function>cpdf_open</function>.</para></listitem></varlistentry>'>

<!-- Xattr entities -->
<!ENTITY xattr.namespace '<para xmlns="http://docbook.org/ns/docbook">Extended attributes have two different namespaces: user
and root. The user namespace is available to all users, while the root namespace
is available only to users with root privileges. xattr operates on the user
namespace  by default, but this can be changed with the
<parameter>flags</parameter> parameter.</para>'>

<!-- Notes for IPv6 -->
<!ENTITY ipv6.brackets '<note xmlns="http://docbook.org/ns/docbook"><simpara>When specifying a numerical IPv6 address
(e.g. <literal>fe80::1</literal>), you must enclose the IP in square
brackets—for example, <literal>tcp://[fe80::1]:80</literal>.</simpara></note>'>

<!ENTITY ipv6.php5 '<note xmlns="http://docbook.org/ns/docbook"><simpara>IPv6 Support was added in PHP 5.0.0.
</simpara></note>'>

<!-- Notes for tidy -->
<!ENTITY tidy.object 'The <classname xmlns="http://docbook.org/ns/docbook">Tidy</classname> object.'>

<!ENTITY tidy.conf-enc '<para xmlns="http://docbook.org/ns/docbook">The <parameter>config</parameter> parameter
can be passed either as an array or as a string. If a string is passed,
it is interpreted as the name of the configuration file, otherwise, it is
interpreted as the options themselves. Check
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.tidy.conf;">&url.tidy.conf;</link>
for an explanation about each option.</para><para>The
<parameter>encoding</parameter> parameter sets the encoding for input/output
documents. The possible values for <parameter>encoding</parameter> are:
<literal>ascii</literal>, <literal>latin0</literal>, <literal>latin1</literal>,
<literal>raw</literal>, <literal>utf8</literal>, <literal>iso2022</literal>,
<literal>mac</literal>, <literal>win1252</literal>, <literal>ibm858</literal>,
<literal>utf16</literal>, <literal>utf16le</literal>,
<literal>utf16be</literal>, <literal>big5</literal> and
<literal>shiftjis</literal>.</para>'>

<!-- Snippets for the installation section -->
<!ENTITY warn.apache2.compat '<warning xmlns="http://docbook.org/ns/docbook"><para>We do not recommend using a
threaded MPM in production with Apache 2. Use the prefork MPM, which is
the default MPM with Apache 2.0 and 2.2.
For information on why, read the related FAQ entry on using
<link linkend="faq.installation.apache2">Apache2 with a threaded MPM</link></para></warning>'>

<!ENTITY note.apache.slashes '<note xmlns="http://docbook.org/ns/docbook"><simpara>Remember that when adding
path values in the Apache configuration files on Windows, all backslashes
such as <filename>c:\directory\file.ext</filename> should be converted to
forward slashes: <filename>c:/directory/file.ext</filename>. A trailing
slash may also be necessary for directories.</simpara></note>'>

<!-- Snippets and titles for the contributors section -->
<!ENTITY Credit.Authors.and.Contributors 'Authors and Contributors'>

<!ENTITY Credit.Introduction '<para xmlns="http://docbook.org/ns/docbook"> We highlight the currently most active
people on the front page of the manual, but there are many more contributors who
currently help in our work or have provided a great amount of help to the project
in the past. There are a lot of unnamed people who help out with user
notes on manual pages, which continually get included in the references, the
work of whom we are also very thankful for. All of the lists provided below are in
alphabetical order.
</para>'>

<!ENTITY Credit.Authors.and.Editors 'Authors and Editors'>

<!ENTITY Credit.Past.Authors.Text 'The following contributors should be
recognized for the impact they have made and/or continue to make by adding
content to the manual:'>

<!ENTITY Credit.Past.Editors.Text 'The following contributors have done
significant work editing the manual:'>

<!ENTITY Credit.Note.Editors.Title 'User Note Maintainers'>

<!ENTITY Credit.Note.Editors.Active 'The currently most active maintainers are:'>

<!ENTITY Credit.Note.Editors.Inactive 'These people have also put a lot of effort
into managing user notes:'>

<!ENTITY listendand ' and'>

<!-- classkit and runkit entities -->
<!ENTITY note.classkit.selfmanipulation '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function cannot
be used to manipulate the currently running (or chained) method.</simpara>
</note>'>

<!ENTITY note.runkit.selfmanipulation '<note xmlns="http://docbook.org/ns/docbook"><simpara>This function cannot
be used to manipulate the currently running (or chained) method.</simpara>
</note>'>

<!ENTITY note.runkit.sandbox '<note xmlns="http://docbook.org/ns/docbook"><simpara>Sandbox support (required for
<function>runkit_lint</function>, <function>runkit_lint_file</function>,
and the <classname>Runkit_Sandbox</classname> class) is only available as of
PHP 5.1.0 or specially patched versions of PHP 5.0, and requires that thread
safety be enabled.
See the <filename>README</filename> file included in the runkit package for
more information.</simpara></note>'>

<!ENTITY note.runkit.internal-override '<note xmlns="http://docbook.org/ns/docbook"><simpara>By default, only
userspace functions may be removed, renamed, or modified.  In order to
override internal functions, you must enable the
<literal>runkit.internal_override</literal> setting in &php.ini;.</simpara>
</note>'>

<!-- SSH2 Extension -->
<!ENTITY note.ssh2.subsystem.publickey '<note xmlns="http://docbook.org/ns/docbook"><simpara>The public key subsystem
is used for managing public keys on a server to which the client is
<emphasis>already</emphasis> authenticated.  To authenticate to a remote system
using public key authentication, use the
<function>ssh2_auth_pubkey_file</function> function instead.</simpara></note>'>

<!-- Session notes -->
<!ENTITY returns.session.storage.retval 'The return value (usually &true; on success, &false; on failure). Note this value is returned internally to PHP for processing.'>

<!-- XMLWriter Notes -->
<!ENTITY xmlwriter.xmlwriter.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
writer</parameter></term><listitem><para>Only for procedural calls.
The <classname>XMLWriter</classname> instance that is being modified. This object is returned from a call to <function>xmlwriter_open_uri</function> or <function>xmlwriter_open_memory</function>.</para></listitem></varlistentry>'>

<!ENTITY xmlwriter.changelog.writer-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>writer</parameter> expects an <classname>XMLWriter</classname>
  instance now; previously, a <type>resource</type> was expected.
 </entry>
</row>'>

<!-- SOAP notes -->
<!ENTITY soap.wsdl.mode.only "<note xmlns='http://docbook.org/ns/docbook'><para>This function only works in WSDL mode.</para></note>">

<!-- Stomp notes -->
<!ENTITY stomp.param.link "<varlistentry xmlns='http://docbook.org/ns/docbook'><term><parameter>link</parameter></term><listitem><para>Procedural style only: The stomp link identifier returned by <function>stomp_connect</function>.</para></listitem></varlistentry>">
<!ENTITY stomp.param.headers "<varlistentry xmlns='http://docbook.org/ns/docbook'><term><parameter>headers</parameter></term><listitem><para>Associative array containing the additional headers (example: receipt).</para></listitem></varlistentry>">
<!ENTITY stomp.note.transaction "<note xmlns='http://docbook.org/ns/docbook'><para>A transaction header may be specified, indicating that the message acknowledgment should be part of the named transaction.</para></note>">
<!ENTITY stomp.note.sync "<tip xmlns='http://docbook.org/ns/docbook'><simpara>Stomp is inherently asynchronous. Synchronous communication can be implemented adding a receipt header. This will cause methods to not return anything until the server has acknowledged receipt of the message or until read timeout was reached.</simpara></tip>">

<!-- SVN notes -->
<!ENTITY svn.relativepath "<note xmlns='http://docbook.org/ns/docbook'><simpara>Relative paths will be resolved as if the current working directory was the one that contains the PHP binary. To use the calling script&apos;s working directory, use <function>realpath</function> or dirname(__FILE__).</simpara></note>">
<!ENTITY svn.referto.status 'Refer to <link xmlns="http://docbook.org/ns/docbook" linkend="svn.constants.status">status constants</link> for possible values.'>
<!ENTITY svn.referto.type 'Refer to <link xmlns="http://docbook.org/ns/docbook" linkend="svn.constants.type">type constants</link> for possible values.'>

<!-- FANN notes -->
<!ENTITY fann.ann.description '<para xmlns="http://docbook.org/ns/docbook">Neural network <type>resource</type>.</para>'>
<!ENTITY fann.train.description '<para xmlns="http://docbook.org/ns/docbook">Neural network training data <type>resource</type>.</para>'>
<!ENTITY fann.errdat.description '<para xmlns="http://docbook.org/ns/docbook">Either neural network <type>resource</type> or neural network trainining data <type>resource</type>.</para>'>
<!ENTITY fann.return.void '<para xmlns="http://docbook.org/ns/docbook">No value is returned.</para>'>
<!ENTITY fann.return.bool '<para xmlns="http://docbook.org/ns/docbook">Returns &true; on success, or &false; otherwise.</para>'>
<!ENTITY fann.return.ann '<para xmlns="http://docbook.org/ns/docbook"> Returns a neural network <type>resource</type> on success, or &false; on error.</para>'>
<!ENTITY fann.return.train '<para xmlns="http://docbook.org/ns/docbook"> Returns a train data <type>resource</type> on success, or &false; on error.</para>'>
<!ENTITY fann.note.function.fann-2.2 '<note xmlns="http://docbook.org/ns/docbook"><para>This function is only available if the fann extension has been build against libfann &gt;= 2.2.</para></note>'>

<!-- Imagick generic return types -->
<!ENTITY imagick.return.success 'Returns &true; on success.'>
<!ENTITY imagick.imagick.throws 'Throws ImagickException on error.'>
<!ENTITY imagick.imagickdraw.throws 'Throws ImagickDrawException on error.'>
<!ENTITY imagick.imagickpixel.throws 'Throws ImagickPixelException on error.'>
<!ENTITY imagick.imagickpixeliterator.throws 'Throws ImagickPixelIteratorException on error.'>

<!-- Imagick version infos -->
<!ENTITY imagick.method.available.0x629 'This method is available if Imagick has been compiled against ImageMagick version 6.2.9 or newer.'>
<!ENTITY imagick.method.available.0x631 'This method is available if Imagick has been compiled against ImageMagick version 6.3.1 or newer.'>
<!ENTITY imagick.method.available.0x632 'This method is available if Imagick has been compiled against ImageMagick version 6.3.2 or newer.'>
<!ENTITY imagick.method.available.0x636 'This method is available if Imagick has been compiled against ImageMagick version 6.3.6 or newer.'>
<!ENTITY imagick.method.available.0x637 'This method is available if Imagick has been compiled against ImageMagick version 6.3.7 or newer.'>
<!ENTITY imagick.method.available.0x638 'This method is available if Imagick has been compiled against ImageMagick version 6.3.8 or newer.'>
<!ENTITY imagick.method.available.0x639 'This method is available if Imagick has been compiled against ImageMagick version 6.3.9 or newer.'>
<!ENTITY imagick.method.available.0x640 'This method is available if Imagick has been compiled against ImageMagick version 6.4.0 or newer.'>
<!ENTITY imagick.method.available.0x641 'This method is available if Imagick has been compiled against ImageMagick version 6.4.1 or newer.'>
<!ENTITY imagick.method.available.0x642 'This method is available if Imagick has been compiled against ImageMagick version 6.4.2 or newer.'>
<!ENTITY imagick.method.available.0x643 'This method is available if Imagick has been compiled against ImageMagick version 6.4.3 or newer.'>
<!ENTITY imagick.method.available.0x644 'This method is available if Imagick has been compiled against ImageMagick version 6.4.4 or newer.'>
<!ENTITY imagick.method.available.0x645 'This method is available if Imagick has been compiled against ImageMagick version 6.4.5 or newer.'>
<!ENTITY imagick.method.available.0x647 'This method is available if Imagick has been compiled against ImageMagick version 6.4.7 or newer.'>
<!ENTITY imagick.method.available.0x649 'This method is available if Imagick has been compiled against ImageMagick version 6.4.9 or newer.'>
<!ENTITY imagick.method.available.0x653 'This method is available if Imagick has been compiled against ImageMagick version 6.5.3 or newer.'>
<!ENTITY imagick.method.available.0x657 'This method is available if Imagick has been compiled against ImageMagick version 6.5.7 or newer.'>

<!ENTITY imagick.method.not.available.0x700 'This method is not available if Imagick has been compiled against ImageMagick version 7.0.0 or newer.'>

<!ENTITY imagick.constant.available 'This constant is available if Imagick has been compiled against ImageMagick version'>

<!ENTITY imagick.deprecated.function-3-4-4 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>This function has been <emphasis>DEPRECATED</emphasis> as of Imagick 3.4.4. Relying on this function is highly discouraged.</simpara></warning>'>

<!-- Imagick default channel information -->
<!ENTITY imagick.default.channel.info 'Defaults to <constant xmlns="http://docbook.org/ns/docbook">Imagick::CHANNEL_DEFAULT</constant>. Refer to this list of <link xmlns="http://docbook.org/ns/docbook" linkend="imagick.constants.channel">channel constants</link>'>

<!-- Fuzz parameter -->
<!ENTITY imagick.parameter.fuzz 'The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.'>

<!-- Channel parameter -->
<!ENTITY imagick.parameter.channel 'Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine <link xmlns="http://docbook.org/ns/docbook" linkend="imagick.constants.channel">channel constants</link> using bitwise operators. &imagick.default.channel.info;'>

<!-- Alpha parameter -->
<!ENTITY imagick.parameter.alpha 'The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.'>

<!ENTITY imagick.imagickexception.throw 'Throw an
<classname xmlns="http://docbook.org/ns/docbook">ImagickException</classname> on error.'>

<!ENTITY imagick.bestfit.note '<note xmlns="http://docbook.org/ns/docbook">
 <simpara>
  The behavior of the parameter <parameter>bestfit</parameter> changed in Imagick 3.0.0.
  Before this version given dimensions 400x400 an image of dimensions 200x150 would be
  left untouched. In Imagick 3.0.0 and later the image would be scaled up to size 400x300 as
  this is the "best fit" for the given dimensions. If <parameter>bestfit</parameter>
  parameter is used both width and height must be given.
 </simpara>
</note>'>

<!ENTITY note.openssl.cnf '<note xmlns="http://docbook.org/ns/docbook">
 <simpara>
  You need to have a valid <filename>openssl.cnf</filename> installed for
  this function to operate correctly.
  See the notes under <link linkend="openssl.installation">the installation
  section</link> for more information.
 </simpara>
</note>'>
<!ENTITY note.openssl.param-notext '<para xmlns="http://docbook.org/ns/docbook">
 The optional parameter <parameter>notext</parameter> affects
 the verbosity of the output; if it is &false;, then additional human-readable
 information is included in the output. The default value of
 <parameter>notext</parameter> is &true;.
</para>'>

<!-- COM/Dotnet -->
<!ENTITY com.variant-arith '<note xmlns="http://docbook.org/ns/docbook">
<para>
 As with all the variant arithmetic functions, the parameters for this function
 can be either a PHP native type (integer, string, floating point, boolean or
 &null;), or an instance of a COM, VARIANT or DOTNET class.  PHP native types
 will be converted to variants using the same rules as found in the constructor
 for the <xref linkend="class.variant"/> class.  COM and DOTNET objects
 will have the value of their default property taken and used as the variant value.
</para>
<para>
 The variant arithmetic functions are wrappers around the similarly named
 functions in the COM library; for more information on these functions, consult
 the MSDN library.  The PHP functions are named slightly differently; for example
 <function>variant_add</function> in PHP corresponds to <literal>VarAdd()
 </literal> in the MSDN documentation.
</para>
</note>
'>
<!ENTITY com.use-oo-instead '<note xmlns="http://docbook.org/ns/docbook">
 <simpara>
  This function does not exist in PHP 5; instead, you should use the regular
  and more natural OO syntax to access properties or call methods.
 </simpara>
</note>
'>

<!-- phar -->
<!ENTITY phar.write '<note xmlns="http://docbook.org/ns/docbook"><para>This
method requires the &php.ini; setting <literal>phar.readonly</literal> to be
set to <literal>0</literal> in order to work for <classname>Phar</classname>
objects.  Otherwise, a <classname>PharException</classname> will be thrown.</para></note>'>

<!ENTITY phar.removed.pharcompress '<note xmlns="http://docbook.org/ns/docbook"><para>This
method has been removed from the phar extension as of version 2.0.0.  Alternative
implementations are available using <function>Phar::compress</function>,
<function>Phar::decompress</function>, <function>Phar::compressFiles</function> and
<function>Phar::decompressFiles</function>.</para></note>'>

<!ENTITY phar.removed.pharfileinfocompress '<note xmlns="http://docbook.org/ns/docbook"><para>This
method has been removed from the phar extension as of version 2.0.0.  Alternative
implementations are available using <function>PharFileInfo::isCompressed</function>,
<function>PharFileInfo::decompress</function>, and <function>PharFileInfo::compress</function>.</para></note>'>

<!ENTITY phar.note.performance '<note xmlns="http://docbook.org/ns/docbook">
 <simpara>
  <function>Phar::addFile</function>, <function>Phar::addFromString</function> and <function>Phar::offsetSet</function>
  save a new phar archive each time they are called. If performance is a concern,
  <function>Phar::buildFromDirectory</function> or <function>Phar::buildFromIterator</function>
  should be used instead.
 </simpara>
</note>'>

<!ENTITY phardata.note.performance '<note xmlns="http://docbook.org/ns/docbook">
 <simpara>
  <function>PharData::addFile</function>, <function>PharData::addFromString</function> and <function>PharData::offsetSet</function>
  save a new phar archive each time they are called. If performance is a concern,
  <function>PharData::buildFromDirectory</function> or <function>PharData::buildFromIterator</function>
  should be used instead.
 </simpara>
</note>'>

<!-- XML -->
<!ENTITY libxml.required '<para xmlns="http://docbook.org/ns/docbook">
 This extension requires the <link linkend="book.libxml">libxml</link> PHP extension.
 This means passing the <option role="configure">--with-libxml</option>,
 or prior to PHP 7.4 the <option role="configure">--enable-libxml</option>,
 configuration flag, although this is implicitly accomplished because libxml
 is enabled by default.
</para>'>

<!-- XMLReader -->
<!ENTITY xmlreader.libxml20620.note '<caution xmlns="http://docbook.org/ns/docbook"><para>This function is only available when PHP is compiled against libxml 20620 or later.</para></caution>'>

<!-- inotify -->
<!ENTITY inotify.instance.description 'Resource returned by
<function xmlns="http://docbook.org/ns/docbook">inotify_init</function>'>

<!-- User streams -->
<!ENTITY userstream.not.implemented.warning '<para xmlns="http://docbook.org/ns/docbook">Emits
<constant>E_WARNING</constant> if call to this method fails
(i.e. not implemented).</para>'>
<!ENTITY userstream.updates.context '<note xmlns="http://docbook.org/ns/docbook"><para>The
<varname linkend="streamwrapper.props.context">streamWrapper::$context</varname>
property is updated if a valid context is passed to the caller function.</para></note>'>

<!-- Gmagick -->
<!ENTITY gmagick.return.success 'Returns &true; on success.'>
<!ENTITY gmagick.gmagickexception.throw 'Throws an
<classname xmlns="http://docbook.org/ns/docbook">GmagickException</classname> on error.'>

<!-- Reflection -->
<!ENTITY reflection.export.return 'If the <parameter xmlns="http://docbook.org/ns/docbook">return</parameter> parameter
is set to &true;, then the export is returned as a <type xmlns="http://docbook.org/ns/docbook">string</type>,
otherwise &null; is returned.'>

<!ENTITY reflection.export.param.return 'Setting to &true; will return the export,
as opposed to emitting it. Setting to &false; (the default) will do the opposite.'>

<!ENTITY reflection.invoke.reference 'If the function has arguments that need
to be references, then they must be references in the passed argument list.'>

<!ENTITY reflection.export.param.name 'The reflection to export.'>

<!-- SPL -->
<!ENTITY spl.datastructures.intro.title '<title xmlns="http://docbook.org/ns/docbook">Datastructures</title>'>

<!ENTITY spl.exceptions.intro.title '<title xmlns="http://docbook.org/ns/docbook">Exceptions</title>'>
<!ENTITY spl.exceptions.intro '<para xmlns="http://docbook.org/ns/docbook">SPL provides a set of standard Exceptions.</para><para xmlns="http://docbook.org/ns/docbook">See also the <xref linkend="reserved.exceptions" /></para>'>

<!ENTITY spl.files.intro.title '<title xmlns="http://docbook.org/ns/docbook">File Handling</title>'>
<!ENTITY spl.files.intro '<partintro xmlns="http://docbook.org/ns/docbook"><para>SPL provides a number of classes to work with files.</para></partintro>'>

<!ENTITY spl.interfaces.intro.title '<title xmlns="http://docbook.org/ns/docbook">Interfaces</title>'>
<!ENTITY spl.interfaces.intro '<para xmlns="http://docbook.org/ns/docbook">SPL provides a set of interfaces.</para><para xmlns="http://docbook.org/ns/docbook">See also the <xref linkend="reserved.interfaces" /></para>'>
<!ENTITY spl.interfaces.list '<title xmlns="http://docbook.org/ns/docbook">Interface list</title>'>

<!ENTITY spl.iterators.intro.title '<title xmlns="http://docbook.org/ns/docbook">Iterators</title>'>
<!ENTITY spl.iterators.intro '<para xmlns="http://docbook.org/ns/docbook">SPL provides a set of iterators to traverse over objects.</para>'>

<!ENTITY spl.misc.intro.title '<title xmlns="http://docbook.org/ns/docbook">Miscellaneous Classes and Interfaces</title>'>
<!ENTITY spl.misc.intro '<partintro xmlns="http://docbook.org/ns/docbook"><para>Classes and interfaces which do not fit into the other SPL categories.</para></partintro>'>

<!-- ZIP -->
<!ENTITY zip.filename.separator '<note xmlns="http://docbook.org/ns/docbook"><simpara>For maximum portability, it is recommended to always use forward slashes (<literal>/</literal>) as directory separator in ZIP filenames.</simpara></note>'>

<!-- Win32Service -->
<!ENTITY win32service.false.error ', &false; if there is a problem with the parameters or a <link xmlns="http://docbook.org/ns/docbook" linkend="win32service.constants.errors">Win32 Error Code</link> on failure.'>
<!ENTITY win32service.success.false.error 'Returns &true; on success&win32service.false.error;'>
<!ENTITY win32service.noerror.false.error 'returned <constant xmlns="http://docbook.org/ns/docbook">WIN32_NO_ERROR</constant> on success&win32service.false.error;'>

<!-- SNMP -->
<!ENTITY snmp.set.type.values '<para xmlns="http://docbook.org/ns/docbook">
 The <acronym>MIB</acronym> defines the type of each object id. It has to be specified as a single character from the below list.
</para>
<table xmlns="http://docbook.org/ns/docbook">
 <title>types</title>
 <tgroup cols="2">
  <tbody>
   <row><entry>=</entry><entry>The type is taken from the MIB</entry></row>
   <row><entry>i</entry><entry>INTEGER</entry> </row>
   <row><entry>u</entry><entry>INTEGER</entry></row>
   <row><entry>s</entry><entry>STRING</entry></row>
   <row><entry>x</entry><entry>HEX STRING</entry></row>
   <row><entry>d</entry><entry>DECIMAL STRING</entry></row>
   <row><entry>n</entry><entry>NULLOBJ</entry></row>
   <row><entry>o</entry><entry>OBJID</entry></row>
   <row><entry>t</entry><entry>TIMETICKS</entry></row>
   <row><entry>a</entry><entry>IPADDRESS</entry></row>
   <row><entry>b</entry><entry>BITS</entry></row>
  </tbody>
 </tgroup>
</table>
<para xmlns="http://docbook.org/ns/docbook">
 If <constant>OPAQUE_SPECIAL_TYPES</constant> was defined while compiling the <acronym>SNMP</acronym> library, the following are also valid:
</para>
<table xmlns="http://docbook.org/ns/docbook">
 <title>types</title>
 <tgroup cols="2">
  <tbody>
   <row><entry>U</entry><entry>unsigned int64</entry></row>
   <row><entry>I</entry><entry>signed int64</entry></row>
   <row><entry>F</entry><entry>float</entry></row>
   <row><entry>D</entry><entry>double</entry></row>
  </tbody>
 </tgroup>
</table>
'>
<!ENTITY snmp.set.type.values.asn.mapping '<para xmlns="http://docbook.org/ns/docbook">
 Most of these will use the obvious corresponding ASN.1 type.  &apos;s&apos;, &apos;x&apos;, &apos;d&apos; and &apos;b&apos; are all different ways of specifying an OCTET STRING value, and
 the &apos;u&apos; unsigned type is also used for handling Gauge32 values.
</para>
'>
<!ENTITY snmp.set.type.values.equal.note '<para xmlns="http://docbook.org/ns/docbook">
 If the MIB-Files are loaded by into the MIB Tree with "snmp_read_mib" or by specifying it in the libsnmp config, &apos;=&apos; may be used as
 the <parameter>type</parameter> parameter for all object ids as the type can then be automatically read from the MIB.
</para>
'>
<!ENTITY snmp.set.type.values.bitset.note '<para xmlns="http://docbook.org/ns/docbook">
 Note that there are two ways to set a variable of the type BITS like e.g.
 "SYNTAX    BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
</para>
<itemizedlist xmlns="http://docbook.org/ns/docbook">
 <listitem>
  <simpara>
   Using type "b" and a list of bit numbers. This method is not recommended since GET query for the same OID would return e.g. 0xF8.
  </simpara>
 </listitem>
 <listitem>
  <simpara>
   Using type "x" and a hex number but without(!) the usual "0x" prefix.
  </simpara>
 </listitem>
</itemizedlist>
<para xmlns="http://docbook.org/ns/docbook">
 See examples section for more details.
</para>
'>
<!ENTITY snmp.methods.exceptions_enable.refsect '<refsect1 role="errors" xmlns="http://docbook.org/ns/docbook">
&reftitle.errors;
<para>
 This method does not throw any exceptions by default.
 To enable throwing an SNMPException exception when some of library errors occur
 the SNMP class parameter <parameter>exceptions_enabled</parameter>
 should be set to a corresponding value. See <link linkend="snmp.props.exceptions-enabled">
 <parameter>SNMP::$exceptions_enabled</parameter> explanation</link> for more details.
</para>
</refsect1>
'>

<!-- Eio -->
<!ENTITY eio.callback.proto '<para xmlns="http://docbook.org/ns/docbook">
<parameter xmlns="http://docbook.org/ns/docbook">callback</parameter> function is called when the request is done.
It should match the following prototype: <programlisting role="php"><![CDATA[
void callback(mixed $data, int $result[, resource $req]);
]]></programlisting>
<variablelist xmlns="http://docbook.org/ns/docbook">
<varlistentry xmlns="http://docbook.org/ns/docbook">
<term><parameter>data</parameter></term>
<listitem><para>is custom data passed to the request.</para></listitem>
</varlistentry>
<varlistentry xmlns="http://docbook.org/ns/docbook">
<term><parameter>result</parameter></term>
<listitem><para>request-specific result value; basically, the value returned by corresponding
system call.</para></listitem>
</varlistentry>
<varlistentry xmlns="http://docbook.org/ns/docbook">
<term><parameter>req</parameter></term>
<listitem><para>is optional request resource which can be used with functions like <function>eio_get_last_error</function></para></listitem>
</varlistentry>
</variablelist>
</para>
'>

<!ENTITY eio.request.pri.values '<para
xmlns="http://docbook.org/ns/docbook">The request priority: <constant
xmlns="http://docbook.org/ns/docbook">EIO_PRI_DEFAULT</constant>, <constant
xmlns="http://docbook.org/ns/docbook">EIO_PRI_MIN</constant>, <constant
xmlns="http://docbook.org/ns/docbook">EIO_PRI_MAX</constant>, or &null;.
If &null; passed, <parameter
xmlns="http://docbook.org/ns/docbook">pri</parameter> internally is set to
<constant xmlns="http://docbook.org/ns/docbook">EIO_PRI_DEFAULT</constant>.
</para>
'>

<!ENTITY eio.warn.relpath '<warning
xmlns="http://docbook.org/ns/docbook"><simpara xmlns="http://docbook.org/ns/docbook">Avoid relative
paths</simpara></warning>
'>

<!ENTITY trader.arg.array.of.real 'Array of real values.'>
<!ENTITY trader.arg.array.of.real.high 'High price, array of real values.'>
<!ENTITY trader.arg.array.of.real.low 'Low price, array of real values.'>
<!ENTITY trader.arg.array.of.real.close 'Closing price, array of real values.'>
<!ENTITY trader.arg.array.of.real.open 'Opening price, array of real values.'>
<!ENTITY trader.arg.array.of.real.volume 'Volume traded, array of real values.'>
<!ENTITY trader.arg.array.of.real.periods 'Array of real values.'>
<!ENTITY trader.arg.penetration 'Percentage of penetration of a candle within another candle.'>
<!ENTITY trader.arg.vfactor 'Volume Factor. Valid range from 1 to 0.'>
<!ENTITY trader.arg.time.period 'Number of period. Valid range from 2 to 100000.'>
<!ENTITY trader.arg.fast.period 'Number of period for the fast MA. Valid range from 2 to 100000.'>
<!ENTITY trader.arg.slow.period 'Number of period for the slow MA. Valid range from 2 to 100000.'>
<!ENTITY trader.arg.signal.period 'Smoothing for the signal line (nb of period). Valid range from 1 to 100000.'>
<!ENTITY trader.arg.fastk.period 'Time period for building the Fast-K line. Valid range from 1 to 100000.'>
<!ENTITY trader.arg.fastd.period 'Smoothing for making the Fast-D line. Valid range from 1 to 100000, usually set to 3.'>
<!ENTITY trader.arg.slowk.period 'Smoothing for making the Slow-K line. Valid range from 1 to 100000, usually set to 3.'>
<!ENTITY trader.arg.slowd.period 'Smoothing for making the Slow-D line. Valid range from 1 to 100000.'>
<!ENTITY trader.arg.min.period 'Value less than minimum will be changed to Minimum period. Valid range from 2 to 100000'>
<!ENTITY trader.arg.max.period 'Value higher than minimum will be changed to Maximum period. Valid range from 2 to 100000'>
<!ENTITY trader.arg.ma.type 'Type of Moving Average. <link xmlns="http://docbook.org/ns/docbook" linkend="trader.constants">TRADER_MA_TYPE_*</link> series of constants should be used.'>
<!ENTITY trader.arg.fast.ma.type 'Type of Moving Average for fast MA. <link xmlns="http://docbook.org/ns/docbook" linkend="trader.constants">TRADER_MA_TYPE_*</link> series of constants should be used.'>
<!ENTITY trader.arg.slow.ma.type 'Type of Moving Average for slow MA. <link xmlns="http://docbook.org/ns/docbook" linkend="trader.constants">TRADER_MA_TYPE_*</link> series of constants should be used.'>
<!ENTITY trader.arg.fastd.ma.type 'Type of Moving Average for Fast-D. <link xmlns="http://docbook.org/ns/docbook" linkend="trader.constants">TRADER_MA_TYPE_*</link> series of constants should be used.'>
<!ENTITY trader.arg.slowk.ma.type 'Type of Moving Average for Slow-K. <link xmlns="http://docbook.org/ns/docbook" linkend="trader.constants">TRADER_MA_TYPE_*</link> series of constants should be used.'>
<!ENTITY trader.arg.slowd.ma.type 'Type of Moving Average for Slow-D. <link xmlns="http://docbook.org/ns/docbook" linkend="trader.constants">TRADER_MA_TYPE_*</link> series of constants should be used.'>
<!ENTITY trader.arg.slowk.ma.type 'Type of Moving Average for Slow-K. <link xmlns="http://docbook.org/ns/docbook" linkend="trader.constants">TRADER_MA_TYPE_*</link> series of constants should be used.'>
<!ENTITY trader.arg.signal.ma.type 'Type of Moving Average for signal line. <link xmlns="http://docbook.org/ns/docbook" linkend="trader.constants">TRADER_MA_TYPE_*</link> series of constants should be used.'>
<!ENTITY trader.arg.nbdevup 'Deviation multiplier for upper band. Valid range from <link xmlns="http://docbook.org/ns/docbook" linkend="constant.trader-real-min">TRADER_REAL_MIN</link> to <link xmlns="http://docbook.org/ns/docbook" linkend="constant.trader-real-max">TRADER_REAL_MAX</link>.'>
<!ENTITY trader.arg.nbdevdn 'Deviation multiplier for lower band. Valid range from <link xmlns="http://docbook.org/ns/docbook" linkend="constant.trader-real-min">TRADER_REAL_MIN</link> to <link xmlns="http://docbook.org/ns/docbook" linkend="constant.trader-real-max">TRADER_REAL_MAX</link>.'>
<!ENTITY trader.arg.fast.limit 'Upper limit use in the adaptive algorithm. Valid range from 0.01 to 0.99.'>
<!ENTITY trader.arg.slow.limit 'Lower limit use in the adaptive algorithm. Valid range from 0.01 to 0.99.'>

<!-- Mongo -->
<!ENTITY mongo.setreadpreference.parameters '<variablelist xmlns="http://docbook.org/ns/docbook"><varlistentry><term><parameter>read_preference</parameter></term><listitem><para>The read preference mode: <constant>MongoClient::RP_PRIMARY</constant>, <constant>MongoClient::RP_PRIMARY_PREFERRED</constant>, <constant>MongoClient::RP_SECONDARY</constant>, <constant>MongoClient::RP_SECONDARY_PREFERRED</constant>, or <constant>MongoClient::RP_NEAREST</constant>.</para></listitem></varlistentry><varlistentry><term><parameter>tags</parameter></term><listitem><para>An array of zero or more tag sets, where each tag set is itself an array of criteria used to match tags on replica set members.</para></listitem></varlistentry></variablelist>'>
<!ENTITY mongo.setreadpreference.returnvalues '<para xmlns="http://docbook.org/ns/docbook">Returns &true; on success, or &false; otherwise.</para>'>
<!ENTITY mongo.setreadpreference.errors '<para xmlns="http://docbook.org/ns/docbook">Emits <constant>E_WARNING</constant> if either parameter is invalid, or if one or more tag sets are provided with the <constant>MongoClient::RP_PRIMARY</constant> read preference mode.</para>'>
<!ENTITY mongo.getreadpreference.returnvalues '<para xmlns="http://docbook.org/ns/docbook">This function returns an array describing the read preference. The array contains the values <literal>type</literal> for the string read preference mode (corresponding to the <classname>MongoClient</classname> constants), and <literal>tagsets</literal> containing a list of all tag set criteria. If no tag sets were specified, <literal>tagsets</literal> will not be present in the array.</para>'>
<!ENTITY mongo.setwriteconcern.parameters '<variablelist xmlns="http://docbook.org/ns/docbook"><varlistentry><term><parameter>w</parameter></term><listitem><para>The write concern. This may be an integer denoting the number of servers required to acknowledge the write, or a string mode (e.g. "majority").</para></listitem></varlistentry><varlistentry><term><parameter>wtimeout</parameter></term><listitem><para>The maximum number of milliseconds to wait for the server to satisfy the write concern.</para></listitem></varlistentry></variablelist>'>
<!ENTITY mongo.setwriteconcern.returnvalues '<para xmlns="http://docbook.org/ns/docbook">Returns &true; on success, or &false; otherwise.</para>'>
<!ENTITY mongo.setwriteconcern.errors '<para xmlns="http://docbook.org/ns/docbook">Emits <constant>E_WARNING</constant> if the <literal>w</literal> parameter is not an integer or string value.</para>'>
<!ENTITY mongo.getwriteconcern.returnvalues '<para xmlns="http://docbook.org/ns/docbook">This function returns an array describing the write concern. The array contains the values <literal>w</literal> for an integer acknowledgement level or string mode, and <literal>wtimeout</literal> denoting the maximum number of milliseconds to wait for the server to satisfy the write concern.</para>'>
<!ENTITY mongo.command.parameters.maxtimems '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"maxTimeMS"</literal></para><para>Specifies a cumulative time limit in milliseconds for processing the operation on the server (does not include idle time). If the operation is not completed by the server within the timeout period, a <classname>MongoExecutionTimeoutException</classname> will be thrown.</para></listitem>'>
<!ENTITY mongo.index.parameters.background '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"background"</literal></para><para>Builds the index in the background so that building an index does <emphasis>not</emphasis> block other database activities. Specify &true; to build in the background. The default value is &false;.</para><warning xmlns="http://docbook.org/ns/docbook"><para>Prior to MongoDB 2.6.0, index builds on secondaries were executed as foreground operations, irrespective of this option. See <link xlink:href="&url.mongodb.dochub.indexes.rs;" xmlns:xlink="http://www.w3.org/1999/xlink">Building Indexes with Replica Sets</link> for more information.</para></warning></listitem>'>
<!ENTITY mongo.index.parameters.dropdups '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"dropDups"</literal></para><para>Specify &true; to force creation of a unique index where the collection may contain duplicate values for a key. MongoDB will index the first occurrence of a key and delete all subsequent documents from the collection that contain a duplicate value for that key. The default value is &false;.</para><warning xmlns="http://docbook.org/ns/docbook"><para><literal>"dropDups"</literal> may delete data from your database. Use with extreme caution.</para></warning><note xmlns="http://docbook.org/ns/docbook"><para>This option is not supported on MongoDB 2.8+. Index creation will fail if the collection contains duplicate values.</para></note></listitem>'>
<!ENTITY mongo.index.parameters.expireafterseconds '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"expireAfterSeconds"</literal></para><para>The value of this option should specify the number of seconds after which a document should be considered expired and automatically removed from the collection. This option is only compatible with single-field indexes where the field will contain <classname>MongoDate</classname> values.</para><note xmlns="http://docbook.org/ns/docbook"><para>This feature is available in MongoDB 2.2+. See <link xlink:href="&url.mongodb.docs.expire_data;" xmlns:xlink="http://www.w3.org/1999/xlink">Expire Data from Collections by Setting TTL</link> for more information.</para></note></listitem>'>
<!ENTITY mongo.index.parameters.name '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"name"</literal></para><para>A optional name that uniquely identifies the index.</para><note xmlns="http://docbook.org/ns/docbook"><para>By default, the driver will generate an index name based on the index&apos;s field(s) and ordering or type. For example, a compound index <literal>array("x" => 1, "y" => -1)</literal> would be named <literal>"x_1_y_-1"</literal> and a geospatial index <literal>array("loc" => "2dsphere")</literal> would be named <literal>"loc_2dsphere"</literal>. For indexes with many fields, it is possible that the generated name might exceed MongoDB&apos;s <link xlink:href="&url.mongodb.docs.limits;#Index-Name-Length" xmlns:xlink="http://www.w3.org/1999/xlink">limit for index names</link>. The <literal>"name"</literal> option may be used in that case to supply a shorter name.</para></note></listitem>'>
<!ENTITY mongo.index.parameters.sparse '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"sparse"</literal></para><para>Specify &true; to create a sparse index, which only indexes documents containing a specified field. The default value is &false;.</para></listitem>'>
<!ENTITY mongo.index.parameters.unique '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"unique"</literal></para><para>Specify &true; to create a unique index. The default value is &false;. This option applies only to ascending/descending indexes.</para><note xmlns="http://docbook.org/ns/docbook"><para>When MongoDB indexes a field, if a document does not have a value for the field, a &null; value is indexed. If multiple documents do not contain a field, a unique index will reject all but the first of those documents. The <literal>"sparse"</literal> option may be used to overcome this, since it will prevent documents without the field from being indexed.</para></note></listitem>'>
<!ENTITY mongo.listcollections.note '<note xmlns="http://docbook.org/ns/docbook"><simpara>This method will use the <link xlink:href="&url.mongodb.docs.command;listCollections" xmlns:xlink="http://www.w3.org/1999/xlink">listCollections</link> database command when communicating with MongoDB 2.8+. For previous database versions, the method will query the special <literal>system.namespaces</literal> collection.</simpara></note>'>
<!ENTITY mongo.listcollections.parameters.filter '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"filter"</literal></para><para>Optional query criteria. If provided, this criteria will be used to filter the collections included in the result.</para><para>Relevant fields that may be queried include <literal>"name"</literal> (collection name as a string, without the database name prefix) and <literal>"options" (object containing options used to create the collection).</literal>.</para><note><simpara>MongoDB 2.6 and earlier versions require the <literal>"name"</literal> criteria, if specified, to be a string value (i.e. equality match). This is because the driver must prefix the value with the database name in order to query the <literal>system.namespaces</literal> collection. Later versions of MongoDB do not have this limitation, as the driver will use the listCollections command.</simpara></note></listitem>'>
<!ENTITY mongo.listcollections.parameters.includesystemcollections '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"includeSystemCollections"</literal></para><para>Boolean, defaults to &false;. Determines whether system collections should be included in the result.</para></listitem>'>
<!ENTITY mongo.writes.parameters.writeconcern '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"w"</literal></para><para>See <link linkend="mongo.writeconcerns">Write Concerns</link>. The default value for <classname>MongoClient</classname> is <literal>1</literal>.</para></listitem>'>
<!ENTITY mongo.writes.parameters.writeconcerntimeout '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"wtimeout"</literal></para><para>Deprecated alias for <literal>"wTimeoutMS"</literal>.</para></listitem>'>
<!ENTITY mongo.writes.parameters.writeconcerntimeoutms '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"wTimeoutMS"</literal></para><para>This option specifies the time limit, in milliseconds, for <link linkend="mongo.writeconcerns">write concern</link> acknowledgement. It is only applicable when <literal>"w"</literal> is greater than <literal>1</literal>, as the timeout pertains to replication. If the write concern is not satisfied within the time limit, a <classname>MongoCursorException</classname> will be thrown. A value of <literal>0</literal> may be specified to block indefinitely. The default value for <classname>MongoClient</classname> is <literal>10000</literal> (ten seconds).</para></listitem>'>
<!ENTITY mongo.writes.parameters.fsync '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"fsync"</literal></para><para>Boolean, defaults to &false;. If journaling is enabled, it works exactly like <literal>"j"</literal>. If journaling is not enabled, the write operation blocks until it is synced to database files on disk. If &true;, an acknowledged insert is implied and this option will override setting <literal>"w"</literal> to <literal>0</literal>.</para><note><simpara>If journaling is enabled, users are strongly encouraged to use the <literal>"j"</literal> option instead of <literal>"fsync"</literal>. Do not use <literal>"fsync"</literal> and <literal>"j"</literal> simultaneously, as that will result in an error.</simpara></note></listitem>'>
<!ENTITY mongo.writes.parameters.sockettimeoutms '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"socketTimeoutMS"</literal></para><para>This option specifies the time limit, in milliseconds, for socket communication. If the server does not respond within the timeout period, a <classname>MongoCursorTimeoutException</classname> will be thrown and there will be no way to determine if the server actually handled the write or not. A value of <literal>-1</literal> may be specified to block indefinitely. The default value for <classname>MongoClient</classname> is <literal>30000</literal> (30 seconds).</para></listitem>'>
<!ENTITY mongo.writes.parameters.journal '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"j"</literal></para><para>Boolean, defaults to &false;. Forces the write operation to block until it is synced to the journal on disk. If &true;, an acknowledged write is implied and this option will override setting <literal>"w"</literal> to <literal>0</literal>.</para><note><simpara>If this option is used and journaling is disabled, MongoDB 2.6+ will raise an error and the write will fail; older server versions will simply ignore the option.</simpara></note></listitem>'>
<!ENTITY mongo.writes.parameters.safe '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"safe"</literal></para><para>Deprecated. Please use the <link linkend="mongo.writeconcerns">write concern</link> <literal>"w"</literal> option.</para></listitem>'>
<!ENTITY mongo.writes.parameters.timeout '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"timeout"</literal></para><para>Deprecated alias for <literal>"socketTimeoutMS"</literal>.</para></listitem>'>
<!ENTITY mongo.errors.exceptions.writeconcern '<para xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoCursorException</classname> if the <literal>"w"</literal> option is set and the write fails.</para><para xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoCursorTimeoutException</classname> if the <literal>"w"</literal> option is set to a value greater than one and the operation takes longer than <varname>MongoCursor::$timeout</varname> milliseconds to complete.  This does not kill the operation on the server, it is a client-side timeout. The operation in <varname>MongoCollection::$wtimeout</varname> is milliseconds.</para>'>
<!ENTITY mongo.errors.deprecated '<para xmlns="http://docbook.org/ns/docbook">Issues <constant>E_DEPRECATED</constant> warning</para>'>
<!ENTITY mongo.gridfs.store.metadata.note '<note xmlns="http://docbook.org/ns/docbook"><para>These fields may also overwrite those that would be created automatically by the driver, as described in the MongoDB core documentation for the <link xlink:href="&url.mongodb.docs.gridfs;#the-files-collection" xmlns:xlink="http://www.w3.org/1999/xlink">files collection</link>. Some practical use cases for this behavior would be to specify a custom <literal>chunkSize</literal> or <literal>_id</literal> for the file.</para></note>'>
<!ENTITY mongo.gridfs.store.return '<para xmlns="http://docbook.org/ns/docbook">Returns the <literal>_id</literal> of the saved file document. This will be a generated <classname>MongoId</classname> unless an <literal>_id</literal> was explicitly specified in the <parameter>metadata</parameter> parameter.</para>'>
<!ENTITY mongo.mongowritebatch.writeoptions.description '<listitem xmlns="http://docbook.org/ns/docbook"><para>An array of Write Options.<informaltable><thead><row><entry>key</entry><entry>value meaning</entry></row></thead><tbody><row><entry>w (int|string)</entry><entry><link linkend="mongo.writeconcerns">Write concern</link> value</entry></row><row><entry>wtimeout (int)</entry><entry><link linkend="mongo.writeconcerns">Maximum time to wait for replication</link></entry></row><row><entry>ordered</entry><entry>Determines if MongoDB must apply this batch in order. Ordered writes execute serially (i.e. one at a time) and execution will stop after the first error. Unordered writes may execute in parallel and execution will not stop after the first error. Defaults to &true;</entry></row><row><entry>j (bool)</entry><entry>Wait for journaling on the primary. This value is discouraged, use WriteConcern instead</entry></row><row><entry>fsync (bool)</entry><entry>Wait for fsync on the primary. This value is discouraged, use WriteConcern instead</entry></row></tbody></informaltable></para></listitem>'>
<!ENTITY mongo.mongowritebatch.collection.description '<listitem xmlns="http://docbook.org/ns/docbook"><para>The <classname>MongoCollection</classname> to execute the batch on. Its <link linkend="mongo.writeconcerns">write concern</link> will be copied and used as the default write concern if none is given as <parameter>$write_options</parameter> or during <methodname>MongoWriteBatch::execute</methodname>.</para></listitem>'>
<!ENTITY mongo.context.server ' <varlistentry xmlns="http://docbook.org/ns/docbook"> <term> <parameter>server</parameter> </term> <listitem> <para> An array containing the basic information about the server that was picked. <informaltable> <tgroup cols="2"> <thead> <row> <entry>key</entry> <entry>value</entry> </row> </thead> <tbody> <row> <entry>hash</entry> <entry>server hash, example: <literal>localhost:27017;-;X;56052</literal></entry> </row> <row> <entry>type</entry> <entry>Node type (primary/secondary/mongos/arbiter): <literal>2</literal></entry> </row> <row> <entry>max_bson_size</entry> <entry>The maximum BSON Size over the wire this node accepts: <literal>16777216</literal></entry> </row> <row> <entry>max_message_size</entry> <entry>The maximum Message Size over the wire this node accepts: <literal>48000000</literal></entry> </row> <row> <entry>request_id</entry> <entry>The request identifier for this message: <literal>42</literal></entry> </row> </tbody> </tgroup> </informaltable> </para> </listitem> </varlistentry>'> 
<!ENTITY mongo.context.writeoptions '<varlistentry xmlns="http://docbook.org/ns/docbook"> <term> <parameter>writeOptions</parameter> </term> <listitem> <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>key</entry> <entry>value</entry> </row> </thead> <tbody> <row> <entry>ordered</entry> <entry>boolean, if the operation (in case of batch operation) must be executed sequentually (ordered=true)</entry> </row> <row> <entry>writeConcern</entry> <entry>An array of writeConcern options (see below)</entry> </row> </tbody> </tgroup> </informaltable> <table> <title>writeConcern array values</title> <tgroup cols="2"> <thead> <row> <entry>key</entry> <entry>value</entry> </row> </thead> <tbody> <row> <entry>fsync</entry> <entry>boolean, force flushing to disk before returning</entry> </row> <row> <entry>j</entry> <entry>boolean, force journal write before returning</entry> </row> <row> <entry>wtimeout</entry> <entry>integer, milliseconds, maximum time the primary is allowed to wait to verify replication</entry> </row> <row> <entry>w</entry> <entry>integer=server count, or string=replication-tag</entry> </row> </tbody> </tgroup> </table> </para> </listitem> </varlistentry>'> 
<!ENTITY mongo.context.protocoloptions ' <varlistentry xmlns="http://docbook.org/ns/docbook"> <term> <parameter>protocolOptions</parameter> </term> <listitem> <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>key</entry> <entry>value</entry> </row> </thead> <tbody> <row> <entry>message_length</entry> <entry>The total size (in bytes) of the encoded message being sent over the wire</entry> </row> <row> <entry>request_id</entry> <entry>The request identifier for this message: <literal>42</literal></entry> </row> <row> <entry>namespace</entry> <entry>The MongoDB namespace used for the protocol message <literal>dbname.collectionname</literal></entry> </row> </tbody> </tgroup> </informaltable> </para> </listitem> </varlistentry>'> 
<!ENTITY mongo.alternative.class.note '<para
xmlns="http://docbook.org/ns/docbook">This extension that defines this class
is deprecated. Instead, the <link linkend="set.mongodb">MongoDB</link> extension should be used.
Alternatives to this class include:</para>'>
<!ENTITY mongo.noalternative.class.note '<para
xmlns="http://docbook.org/ns/docbook">This extension that defines this class
is deprecated. Instead, the <link linkend="set.mongodb">MongoDB</link> extension should be used.
There is no equivalent for this class in the new extension.</para>'>
<!ENTITY mongo.alternative.method.note '<para
xmlns="http://docbook.org/ns/docbook">This extension that defines this method
is deprecated. Instead, the <link linkend="set.mongodb">MongoDB</link> extension should be used.
Alternatives to this method include:</para>'>
<!ENTITY mongo.noalternative.method.note '<para
xmlns="http://docbook.org/ns/docbook">This extension that defines this method
is deprecated. Instead, the <link linkend="set.mongodb">MongoDB</link> extension should be used.
There is no equivalent for this method in the new extension.</para>'>
<!ENTITY mongo.alternative.phplib.note '<para
xmlns="http://docbook.org/ns/docbook">This extension that defines this method
is deprecated. Instead, the <link linkend="set.mongodb">MongoDB</link> extension should be used.
There is no equivalent for this method in the new extension, but there is an
alternative in the <link linkend="mongodb.overview">PHP library</link>:</para>'>

<!ENTITY mongo.deprecated.note '<para
xmlns="http://docbook.org/ns/docbook">This extension is deprecated. Instead,
the <link linkend="set.mongodb">MongoDB</link> extension should be
used.</para>'>

<!-- mongodb -->
<!ENTITY mongodb.option.collation '
         <row xmlns="http://docbook.org/ns/docbook">
          <entry>collation</entry>
          <entry><type class="union"><type>array</type><type>object</type></type></entry>
          <entry>
           <para>
            <link xlink:href="&url.mongodb.docs.collation;" xmlns:xlink="http://www.w3.org/1999/xlink">Collation</link> allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the <literal>"locale"</literal> field is mandatory; all other collation fields are optional. For descriptions of the fields, see <link xlink:href="&url.mongodb.docs.collation;#collation-document" xmlns:xlink="http://www.w3.org/1999/xlink">Collation Document</link>.
           </para>
           <para>
            If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
           </para>
           <para>
            This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.
           </para>
          </entry>
         </row>
'>
<!ENTITY mongodb.option.encryption.keyVaultClient '
         <row xmlns="http://docbook.org/ns/docbook">
          <entry>keyVaultClient</entry>
          <entry><classname>MongoDB\Driver\Manager</classname></entry>
          <entry>The Manager used to route data key queries to a separate MongoDB cluster. By default, the current Manager and cluster is used.</entry>
         </row>
'>
<!ENTITY mongodb.option.encryption.keyVaultNamespace '
         <row xmlns="http://docbook.org/ns/docbook">
          <entry>keyVaultNamespace</entry>
          <entry><type>string</type></entry>
          <entry>A fully qualified namespace (e.g. <literal>"databaseName.collectionName"</literal>) denoting the collection that contains all data keys used for encryption and decryption.</entry>
         </row>
'>
<!ENTITY mongodb.option.encryption.kmsProviders '
         <row xmlns="http://docbook.org/ns/docbook">
          <entry>kmsProviders</entry>
          <entry><type>array</type></entry>
          <entry>
           <para>
            A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Currently <literal>"aws"</literal>, <literal>"azure"</literal>, <literal>"gcp"</literal>, and <literal>"local"</literal> are supported and at least one must be specified.
           </para>
           <para>
            The format for <literal>"aws"</literal> is as follows:
           </para>
           <programlisting role="javascript">
<![CDATA[
aws: {
    accessKeyId: <string>,
    secretAccessKey: <string>
}
]]>
           </programlisting>
           <para>
            The format for <literal>"azure"</literal> is as follows:
           </para>
           <programlisting role="javascript">
<![CDATA[
azure: {
    tenantId: <string>,
    clientId: <string>,
    clientSecret: <string>,
    identityPlatformEndpoint: <optional string> // Defaults to "login.microsoftonline.com"

}
]]>
           </programlisting>
           <para>
            The format for <literal>"gcp"</literal> is as follows:
           </para>
           <programlisting role="javascript">
<![CDATA[
aws: {
    email: <string>,
    privateKey: <base64 string>|<MongoDB\BSON\Binary>,
    endpoint: <optional string> // Defaults to "oauth2.googleapis.com"

}
]]>
           </programlisting>
           <para>
            The format for <literal>"local"</literal> is as follows:
           </para>
           <programlisting role="javascript">
<![CDATA[
local: {
    // 96-byte master key used to encrypt/decrypt data keys
    key: <base64 string>|<MongoDB\BSON\Binary>
}
]]>
           </programlisting>
          </entry>
         </row>
'>
<!ENTITY mongodb.option.maxCommitTimeMS '
         <row xmlns="http://docbook.org/ns/docbook">
          <entry>maxCommitTimeMS</entry>
          <entry>integer</entry>
          <entry>
           <para>
            The maximum amount of time in milliseconds to allow a single
            <literal>commitTransaction</literal> command to run.
           </para>
           <para>
            If specified, <literal>maxCommitTimeMS</literal> must be a signed
            32-bit integer greater than or equal to zero.
           </para>
          </entry>
         </row>
'>
<!ENTITY mongodb.option.readConcern '
         <row xmlns="http://docbook.org/ns/docbook">
          <entry>readConcern</entry>
          <entry><classname>MongoDB\Driver\ReadConcern</classname></entry>
          <entry>
           <para>
            A read concern to apply to the operation.
           </para>
           <para>
            This option is available in MongoDB 3.2+ and will result in an
            exception at execution time if specified for an older server
            version.
           </para>
          </entry>
         </row>
'>
<!ENTITY mongodb.option.readPreference '
         <row xmlns="http://docbook.org/ns/docbook">
          <entry>readPreference</entry>
          <entry><classname>MongoDB\Driver\ReadPreference</classname></entry>
          <entry>
           <para>
            A read preference to use for selecting a server for the operation.
           </para>
          </entry>
         </row>
'>
<!ENTITY mongodb.option.session '
         <row xmlns="http://docbook.org/ns/docbook">
          <entry>session</entry>
          <entry><classname>MongoDB\Driver\Session</classname></entry>
          <entry>
           <para>
            A session to associate with the operation.
           </para>
          </entry>
         </row>
'>
<!ENTITY mongodb.option.transactionReadWriteConcern '
     <warning xmlns="http://docbook.org/ns/docbook">
      <para>
       If you are using a <literal>"session"</literal> which has a transaction
       in progress, you cannot specify a <literal>"readConcern"</literal> or
       <literal>"writeConcern"</literal> option. This will result in an
       <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname>
       being thrown. Instead, you should set these two options when you create
       the transaction with
       <methodname>MongoDB\Driver\Session::startTransaction</methodname>.
      </para>
     </warning>
'>
<!ENTITY mongodb.option.writeConcern '
         <row xmlns="http://docbook.org/ns/docbook">
          <entry>writeConcern</entry>
          <entry><classname>MongoDB\Driver\WriteConcern</classname></entry>
          <entry>
           <para>
            A write concern to apply to the operation.
           </para>
          </entry>
         </row>
'>
<!ENTITY mongodb.parameter.namespace '
   <varlistentry xmlns="http://docbook.org/ns/docbook">
    <term><parameter>namespace</parameter> (<type>string</type>)</term>
    <listitem>
     <para>
      A fully qualified namespace (e.g. <literal>"databaseName.collectionName"</literal>).
     </para>
    </listitem>
   </varlistentry>
'>
<!ENTITY mongodb.parameter.db '
   <varlistentry xmlns="http://docbook.org/ns/docbook">
    <term><parameter>db</parameter> (<type>string</type>)</term>
    <listitem>
     <para>
      The name of the database on which to execute the command.
     </para>
    </listitem>
   </varlistentry>
'>
<!ENTITY mongodb.parameter.bulkwrite '
   <varlistentry xmlns="http://docbook.org/ns/docbook">
    <term><parameter>bulk</parameter> (<classname>MongoDB\Driver\BulkWrite</classname>)</term>
    <listitem>
     <para>
      The write(s) to execute.
     </para>
    </listitem>
   </varlistentry>
'>
<!ENTITY mongodb.parameter.command '
   <varlistentry xmlns="http://docbook.org/ns/docbook">
    <term><parameter>command</parameter> (<classname>MongoDB\Driver\Command</classname>)</term>
    <listitem>
     <para>
      The command to execute.
     </para>
    </listitem>
   </varlistentry>
'>
<!ENTITY mongodb.parameter.query '
   <varlistentry xmlns="http://docbook.org/ns/docbook">
    <term><parameter>query</parameter> (<classname>MongoDB\Driver\Query</classname>)</term>
    <listitem>
     <para>
      The query to execute.
     </para>
    </listitem>
   </varlistentry>
'>
<!ENTITY mongodb.parameter.typeMap '
   <varlistentry xmlns="http://docbook.org/ns/docbook">
    <term><parameter>typeMap</parameter> (<type>array</type>)</term>
    <listitem>
     <para>
      <link linkend="mongodb.persistence.typemaps">Type map configuration</link>.
     </para>
    </listitem>
   </varlistentry>
'>
<!ENTITY mongodb.parameter.filter '
   <varlistentry xmlns="http://docbook.org/ns/docbook">
    <term><parameter>filter</parameter> (<type class="union"><type>array</type><type>object</type></type>)</term>
    <listitem>
     <para>
      The <link xlink:href="&url.mongodb.docs;tutorial/query-documents/" xmlns:xlink="http://www.w3.org/1999/xlink">query predicate</link>.
      An empty predicate will match all documents in the collection.
     </para>
     <note>
      <simpara>
       When evaluating query criteria, MongoDB compares types and values according to its own <link xlink:href="&url.mongodb.docs;reference/bson-type-comparison-order/" xmlns:xlink="http://www.w3.org/1999/xlink">comparison rules for BSON types</link>, which differs from PHP&apos;s <link linkend="types.comparisons">comparison</link> and <link linkend="language.types.type-juggling">type juggling</link> rules. When matching a special BSON type the query criteria should use the respective <link linkend="book.bson">BSON class</link> (e.g. use <classname>MongoDB\BSON\ObjectId</classname> to match an <link xlink:href="&url.mongodb.docs.objectid;" xmlns:xlink="http://www.w3.org/1999/xlink">ObjectId</link>).
      </simpara>
     </note>
    </listitem>
   </varlistentry>
'>
<!ENTITY mongodb.returns.cursor '<para xmlns="http://docbook.org/ns/docbook">Returns <classname>MongoDB\Driver\Cursor</classname> on success.</para>'>
<!ENTITY mongodb.returns.writeresult '<para xmlns="http://docbook.org/ns/docbook">Returns <classname>MongoDB\Driver\WriteResult</classname> on success.</para>'>
<!ENTITY mongodb.throws.std '&mongodb.throws.argumentparsing;&mongodb.throws.connection;&mongodb.throws.authentication;'>
<!ENTITY mongodb.throws.session-readwriteconcern '<member xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname> if the <literal>"session"</literal> option is used with an associated transaction in combination with a <literal>"readConcern"</literal> or <literal>"writeConcern"</literal> option.</member>'>
<!ENTITY mongodb.throws.session-unacknowledged '<member xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname> if the <literal>"session"</literal> option is used in combination with an unacknowledged write concern.</member>'>
<!ENTITY mongodb.throws.bulkwriteexception '<member xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoDB\Driver\Exception\BulkWriteException</classname> on any write failure (e.g. write error, failure to apply a write concern)</member>'>
<!ENTITY mongodb.throws.argumentparsing '<member xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname> on argument parsing errors.</member>'>
<!ENTITY mongodb.throws.authentication '<member xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoDB\Driver\Exception\AuthenticationException</classname> if authentication is needed and fails.</member>'>
<!ENTITY mongodb.throws.connection '<member xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoDB\Driver\Exception\ConnectionException</classname> if connection to the server fails (for reasons other than authentication).</member>'>
<!ENTITY mongodb.throws.bson.unexpected '<member xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoDB\Driver\Exception\UnexpectedValueException</classname> if the input did not contain exactly one BSON document. Possible reasons include, but are not limited to, invalid BSON, extra data (after reading one BSON document), or an unexpected <link xlink:href="&url.mongodb.libbson;" xmlns:xlink="http://www.w3.org/1999/xlink">libbson</link> error.</member>'>

<!ENTITY mongodb.note.decimal128 '
   <note xmlns="http://docbook.org/ns/docbook">
    <simpara>
     <classname>MongoDB\BSON\Decimal128</classname> is only compatible with
     MongoDB 3.4+. Attempting to use the BSON type with an earlier version of
     MongoDB will result in an error.
    </simpara>
   </note>
'>
<!ENTITY mongodb.note.extended-json '
  <note xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
   <simpara>
    The output is consistent with the <function>MongoDB\BSON\toJSON</function>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <link xlink:href="&url.mongodb.specs.extendedjson;#relaxed-extended-json-example">relaxed</link>
    or <link xlink:href="&url.mongodb.specs.extendedjson;#canonical-extended-json-example">canonical</link>
    extended JSON representations used by
    <function>MongoDB\BSON\toRelaxedExtendedJSON</function> and
    <function>MongoDB\BSON\toCanonicalExtendedJSON</function>, respectively.
   </simpara>
  </note>
'>
<!ENTITY mongodb.note.forking '
   <note xmlns="http://docbook.org/ns/docbook">
    <simpara>
     On Unix platforms, the MongoDB driver is sensitive to scripts that use the
     fork() system call without also calling exec(). Users are advised not to
     re-use <classname>MongoDB\Driver\Manager</classname> instances in a forked
     child process.
    </simpara>
   </note>
'>

<!ENTITY mongodb.note.uint32 '
  <note xmlns="http://docbook.org/ns/docbook">
   <simpara>
    Because PHP&apos;s integer type is signed, some values returned by this
    method may appear as negative integers on 32-bit platforms. The
    <literal>"&#37;u"</literal> formatter of <function>sprintf</function> may be
    used to obtain a string representation of the unsigned decimal value.
   </simpara>
  </note>
'>

<!ENTITY mongodb.note.server.readpreference '
  <note xmlns="http://docbook.org/ns/docbook">
   <simpara>
    The <literal>"readPreference"</literal> option does not control the server
    to which the driver issues the operation; it will always be executed on
    this server object. Instead, it may be used when issuing the operation to a
    secondary (from a replica set connection, not standalone) or mongos node to
    ensure that the driver sets the wire protocol accordingly or adds the read
    preference to the operation, respectively.
   </simpara>
  </note>
'>

<!ENTITY mongodb.note.server.write '
  <note xmlns="http://docbook.org/ns/docbook">
   <simpara>
    It is the caller&apos;s responsibility to ensure that the server is capable
    of executing the write operation. For example, executing a write operation
    on a secondary (excluding its "local" database) will fail.
   </simpara>
  </note>
'>

<!-- Radius -->
<!ENTITY radius.request.required '<note xmlns="http://docbook.org/ns/docbook"><para>A request must be created via <function>radius_create_request</function> before this function can be called.</para></note>'>
<!ENTITY radius.parameter.attribute-type '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>type</parameter></term><listitem><para>The attribute type.</para></listitem></varlistentry>'>
<!ENTITY radius.parameter.handle '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>radius_handle</parameter></term><listitem><para>The RADIUS resource.</para></listitem></varlistentry>'>
<!ENTITY radius.parameter.options '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>options</parameter></term><listitem><para>A bitmask of the attribute options. The available options include <link linkend="constant.radius-option-tagged"><constant>RADIUS_OPTION_TAGGED</constant></link> and <link linkend="constant.radius-option-salt"><constant>RADIUS_OPTION_SALT</constant></link>.</para></listitem></varlistentry>'>
<!ENTITY radius.parameter.tag '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>tag</parameter></term><listitem><para>The attribute tag. This parameter is ignored unless the <link linkend="constant.radius-option-tagged"><constant>RADIUS_OPTION_TAGGED</constant></link> option is set.</para></listitem></varlistentry>'>
<!ENTITY radius.parameter.vendor '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>vendor</parameter></term><listitem><para>The vendor ID.</para></listitem></varlistentry>'>

<!-- posix snippets -->
<!ENTITY posix.parameter.fd '<varlistentry xmlns="http://docbook.org/ns/docbook">
 <term><parameter>fd</parameter></term>
 <listitem>
  <para>
   The file descriptor, which is expected to be either a file
   <type>resource</type> or an <type>int</type>. An <type>int</type>
   will be assumed to be a file descriptor that can be passed directly to
   the underlying system call.
  </para>
  <para>
   In almost all cases, you will want to provide a file <type>resource</type>.
  </para>
 </listitem>
</varlistentry>'>

<!ENTITY posix.rlimits '
<para xmlns="http://docbook.org/ns/docbook">
  Each resource has an associated soft and hard limit.  The soft
  limit is the value that the kernel enforces for the corresponding
  resource.  The hard limit acts as a ceiling for the soft limit.
  An unprivileged process may only set its soft limit to a value
  from 0 to the hard limit, and irreversibly lower its hard limit.
</para>
'>

<!-- strings snippets -->
<!ENTITY strings.parameter.encoding '
 <para xmlns="http://docbook.org/ns/docbook">
  An optional argument defining the encoding used when converting characters.
 </para>

 <para xmlns="http://docbook.org/ns/docbook">
  If omitted, <parameter>encoding</parameter> defaults to the value of the
  <link linkend="ini.default-charset">default_charset</link> configuration
  option.
 </para>

 <para xmlns="http://docbook.org/ns/docbook">
  Although this argument is technically optional, you are highly encouraged to
  specify the correct value for your code
  if the <link linkend="ini.default-charset">default_charset</link>
  configuration option may be set incorrectly for the given input.
 </para>
'>

<!ENTITY strings.parameter.format '
<varlistentry xmlns="http://docbook.org/ns/docbook">
 <term><parameter>format</parameter></term>
 <listitem>
  <para>
   The format string is composed of zero or more directives:
   ordinary characters (excluding <literal>&#37;</literal>) that are
   copied directly to the result and <emphasis>conversion
   specifications</emphasis>, each of which results in fetching its
   own parameter.
  </para>

  <para>
   A conversion specification follows this prototype:
   <literal>&#37;[argnum$][flags][width][.precision]specifier</literal>.
  </para>

  <formalpara>
   <title>Argnum</title>
   <para>
    An integer followed by a dollar sign <literal>$</literal>,
    to specify which number argument to treat in the conversion.
   </para>
  </formalpara>
  
  <para>
   <table>
    <title>Flags</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Flag</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>-</literal></entry>
       <entry>
        Left-justify within the given field width;
        Right justification is the default
       </entry>
      </row>
      <row>
       <entry><literal>+</literal></entry>
       <entry>
        Prefix positive numbers with a plus sign
        <literal>+</literal>; Default only negative
        are prefixed with a negative sign.
       </entry>
      </row>
      <row>
       <entry><literal> </literal>(space)</entry>
       <entry>
        Pads the result with spaces.
        This is the default.
       </entry>
      </row>
      <row>
       <entry><literal>0</literal></entry>
       <entry>
        Only left-pads numbers with zeros.
        With <literal>s</literal> specifiers this can
        also right-pad with zeros.
       </entry>
      </row>
      <row>
       <entry><literal>&apos;</literal>(char)</entry>
       <entry>
        Pads the result with the character (char).
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>

  <formalpara>
   <title>Width</title>
   <para>
    An integer that says how many characters (minimum)
    this conversion should result in.
   </para>
  </formalpara>

  <formalpara>
   <title>Precision</title>
   <para>
    A period <literal>.</literal> followed by an integer
    who&apos;s meaning depends on the specifier:
    <itemizedlist>
     <listitem>
      <simpara>
       For <literal>e</literal>, <literal>E</literal>,
       <literal>f</literal> and <literal>F</literal>
       specifiers: this is the number of digits to be printed
       after the decimal point (by default, this is 6).
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       For <literal>g</literal>, <literal>G</literal>,
       <literal>h</literal> and <literal>H</literal>
       specifiers: this is the maximum number of significant
       digits to be printed.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       For <literal>s</literal> specifier: it acts as a cutoff point,
       setting a maximum character limit to the string.
      </simpara>
     </listitem>
    </itemizedlist>
    <note>
     <simpara>
      If the period is specified without an explicit value for precision,
      0 is assumed.
     </simpara>
    </note>
   </para>
  </formalpara>

  <note>
   <simpara>
    Attempting to use a position specifier greater than
    <constant>PHP_INT_MAX</constant> will generate warnings.
   </simpara>
  </note>

  <para>
   <table>
    <title>Specifiers</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Specifier</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>&#37;</literal></entry>
       <entry>
        A literal percent character. No argument is required.
       </entry>
      </row>
      <row>
       <entry><literal>b</literal></entry>
       <entry>
        The argument is treated as an integer and presented
        as a binary number.
       </entry>
      </row>
      <row>
       <entry><literal>c</literal></entry>
       <entry>
        The argument is treated as an integer and presented
        as the character with that ASCII.
       </entry>
      </row>
      <row>
       <entry><literal>d</literal></entry>
       <entry>
        The argument is treated as an integer and presented
        as a (signed) decimal number.
       </entry>
      </row>
      <row>
       <entry><literal>e</literal></entry>
       <entry>
        The argument is treated as scientific notation (e.g. 1.2e+2).
       </entry>
      </row>
      <row>
       <entry><literal>E</literal></entry>
       <entry>
        Like the <literal>e</literal> specifier but uses
        uppercase letter (e.g. 1.2E+2).
       </entry>
      </row>
      <row>
       <entry><literal>f</literal></entry>
       <entry>
        The argument is treated as a float and presented
        as a floating-point number (locale aware).
       </entry>
      </row>
      <row>
       <entry><literal>F</literal></entry>
       <entry>
        The argument is treated as a float and presented
        as a floating-point number (non-locale aware).
       </entry>
      </row>
      <row>
       <entry><literal>g</literal></entry>
       <entry>
        <para>
         General format.
        </para>
        <para>
         Let P equal the precision if nonzero, 6 if the precision is omitted,
         or 1 if the precision is zero.
         Then, if a conversion with style E would have an exponent of X:
        </para>
        <para>
         If P > X ≥ −4, the conversion is with style f and precision P − (X + 1).
         Otherwise, the conversion is with style e and precision P − 1.
        </para>
       </entry>
      </row>
      <row>
       <entry><literal>G</literal></entry>
       <entry>
        Like the <literal>g</literal> specifier but uses
        <literal>E</literal> and <literal>f</literal>.
       </entry>
      </row>
      <row>
       <entry><literal>h</literal></entry>
       <entry>
        Like the <literal>g</literal> specifier but uses <literal>F</literal>.
        Available as of PHP 8.0.0.
       </entry>
      </row>
      <row>
       <entry><literal>H</literal></entry>
       <entry>
        Like the <literal>g</literal> specifier but uses
        <literal>E</literal> and <literal>F</literal>. Available as of PHP 8.0.0.
       </entry>
      </row>
      <row>
       <entry><literal>o</literal></entry>
       <entry>
        The argument is treated as an integer and presented
        as an octal number.
       </entry>
      </row>
      <row>
       <entry><literal>s</literal></entry>
       <entry>
        The argument is treated and presented as a string.
       </entry>
      </row>
      <row>
       <entry><literal>u</literal></entry>
       <entry>
        The argument is treated as an integer and presented
        as an unsigned decimal number.
       </entry>
      </row>
      <row>
       <entry><literal>x</literal></entry>
       <entry>
        The argument is treated as an integer and presented
        as a hexadecimal number (with lowercase letters).
       </entry>
      </row>
      <row>
       <entry><literal>X</literal></entry>
       <entry>
        The argument is treated as an integer and presented
        as a hexadecimal number (with uppercase letters).
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>

  <warning>
   <para>
    The <literal>c</literal> type specifier ignores padding and width
   </para>
  </warning>

  <warning>
   <para>
    Attempting to use a combination of the string and width specifiers with character sets that require more than one byte per character may result in unexpected results
   </para>
  </warning>

  <para>
   Variables will be co-erced to a suitable type for the specifier:
   <table>
    <title>Type Handling</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Type</entry>
       <entry>Specifiers</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><type>string</type></entry>
       <entry><literal>s</literal></entry>
      </row>
      <row>
       <entry><type>int</type></entry>
       <entry>
        <literal>d</literal>,
        <literal>u</literal>,
        <literal>c</literal>,
        <literal>o</literal>,
        <literal>x</literal>,
        <literal>X</literal>,
        <literal>b</literal>
       </entry>
      </row>
      <row>
       <entry><type>float</type></entry>
       <entry>
        <literal>e</literal>,
        <literal>E</literal>,
        <literal>f</literal>,
        <literal>F</literal>,
        <literal>g</literal>,
        <literal>G</literal>,
        <literal>h</literal>,
        <literal>H</literal>
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
 </listitem>
</varlistentry>
'>

<!ENTITY strings.parameter.needle.non-string '
 <para xmlns="http://docbook.org/ns/docbook">
  Prior to PHP 8.0.0, if <parameter>needle</parameter> is not a string, it is converted
  to an integer and applied as the ordinal value of a character.
  This behavior is deprecated as of PHP 7.3.0, and relying on it is highly
  discouraged. Depending on the intended behavior, the
  <parameter>needle</parameter> should either be explicitly cast to string,
  or an explicit call to <function>chr</function> should be performed.
 </para>
'>

<!ENTITY strings.changelog.encoding '
 <row xmlns="http://docbook.org/ns/docbook">
  <entry>5.6.0</entry>
  <entry>
   The default value for the <parameter>encoding</parameter> parameter was
   changed to be the value of the
   <link linkend="ini.default-charset">default_charset</link> configuration
   option.
  </entry>
 </row>
'>

<!-- filter snippets -->
<!ENTITY filter.param.filter '
 <varlistentry xmlns="http://docbook.org/ns/docbook">
  <term><parameter>filter</parameter></term>
  <listitem>
   <para>
    The ID of the filter to apply. The <xref linkend="filter.filters" />
    manual page lists the available filters.
   </para>
   <para>
    If omitted, <constant>FILTER_DEFAULT</constant> will be used, which is
    equivalent to
    <link linkend="filter.filters.sanitize"><constant>FILTER_UNSAFE_RAW</constant></link>.
    This will result in no filtering taking place by default.
   </para>
  </listitem>
 </varlistentry>
'>

<!-- csprng snippets -->
<!ENTITY csprng.sources '
<para xmlns="http://docbook.org/ns/docbook">
 The sources of randomness used for this function are as follows:
</para>
<itemizedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <listitem>
  <simpara>
   On Windows,
   <link xlink:href="&url.csprng.crypt-gen-random;"><function>CryptGenRandom</function></link>
   will always be used. As of PHP 7.2.0, the
   <link xlink:href="&url.csprng.cng-api;">CNG-API</link>
   will always be used instead.
  </simpara>
 </listitem>
 <listitem>
  <simpara>
   On Linux, the
   <link xlink:href="&url.csprng.get-random-2;">getrandom(2)</link>
   syscall will be used if available.
  </simpara>
 </listitem>
 <listitem>
  <simpara>
   On other platforms, <filename>/dev/urandom</filename> will be used.
  </simpara>
 </listitem>
 <listitem>
  <simpara>
   If none of the aforementioned sources are available, then an
   <classname>Exception</classname> will be thrown.
  </simpara>
 </listitem>
</itemizedlist>
'>
<!ENTITY csprng.errors '
 <listitem xmlns="http://docbook.org/ns/docbook">
  <simpara>
   If an appropriate source of randomness cannot be found,
   an <classname>Exception</classname> will be thrown.
  </simpara>
 </listitem>
 <listitem xmlns="http://docbook.org/ns/docbook">
  <simpara>
    If invalid parameters are given, a <classname>TypeError</classname>
    will be thrown.
  </simpara>
 </listitem>
'>
<!ENTITY csprng.function.backport '
 <note xmlns="http://docbook.org/ns/docbook">
  <simpara>
   Although this function was added to PHP in PHP 7.0, a
   <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.csprng.compat;">userland implementation</link>
   is available for PHP 5.2 to 5.6, inclusive.
  </simpara>
 </note>
'>


<!-- UOPZ snippets -->

<!ENTITY uopz.warn.removed.function-5-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
<emphasis>REMOVED</emphasis> in PECL uopz 5.0.0.</simpara></warning>'>

<!-- XML snippets -->

<!ENTITY xml.changelog.parser-param '<row xmlns="http://docbook.org/ns/docbook">
 <entry>8.0.0</entry>
 <entry>
  <parameter>parser</parameter> expects an <classname>XMLParser</classname>
  instance now; previously, a <type>resource</type> was expected.
 </entry>
</row>'>

<!-- Migration Guide snippets -->
<!ENTITY migration56.openssl.peer-verification '
   <para xmlns="http://docbook.org/ns/docbook">
    All encrypted client streams now enable peer verification by default. By
    default, this will use OpenSSL&apos;s default CA bundle to verify the peer
    certificate. In most cases, no changes will need to be made to communicate
    with servers with valid SSL certificates, as distributors generally
    configure OpenSSL to use known good CA bundles.
   </para>
   
   <para xmlns="http://docbook.org/ns/docbook">
    The default CA bundle may be overridden on a global basis by setting
    either the openssl.cafile or openssl.capath configuration setting, or on a
    per request basis by using the
    <link linkend="context.ssl.cafile"><parameter>cafile</parameter></link> or
    <link linkend="context.ssl.capath"><parameter>capath</parameter></link>
    context options.
   </para>

   <para xmlns="http://docbook.org/ns/docbook">
    While not recommended in general, it is possible to disable peer
    certificate verification for a request by setting the
    <link linkend="context.ssl.verify-peer"><parameter>verify_peer</parameter></link>
    context option to &false;, and to disable peer name validation by setting
    the <link linkend="context.ssl.verify-peer-name"><parameter>verify_peer_name</parameter></link>
    context option to &false;.
   </para>
'>

<!-- 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: fen fdm=syntax fdl=2 si
vim: et tw=78
vi: ts=1 sw=1
-->