language-snippets.ent

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: eacabc8e152598143b08aa8ad83270c5caece6a6 Maintainer: Gregory Status: ready -->
<!-- Reviewed: yes -->
<!-- CREDITS: dallas -->
<!-- 请保持此文件与英文文件中相应的每个 ENTITY 行号一一对应以便于对照，修改与更新！ -->

<!ENTITY installation.enabled.disable '此扩展默认为启用，编译时可通过下列选项禁用：'>

<!-- Not used in EN anymore -->
<!ENTITY changelog.randomseed '<row xmlns="http://docbook.org/ns/docbook"><entry>4.2.0</entry><entry>随机数发生器自动进行播种。</entry></row>'>

<!ENTITY warn.deprecated.feature-5-3-0.removed-6-0-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>自 PHP 5.3.0
起，已经<emphasis>废弃</emphasis>此特性。强烈建议不要应用此特性。</simpara></warning>'>

<!ENTITY warn.deprecated.function-5-3-0.removed-6-0-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>自 PHP 5.3.0
起，已经<emphasis>废弃</emphasis>此函数。强烈建议不要应用此函数。</simpara></warning>'>


<!-- Cautions --> 
<!ENTITY caution.cryptographically-insecure '<caution xmlns="http://docbook.org/ns/docbook"><para>本函数并不会生成安全加密的值，不应用于加密用途。若需要安全加密的值，考虑使用
<function>random_int</function>、<function>random_bytes</function> 或 <function>openssl_random_pseudo_bytes</function>
替代。</para></caution>'>


<!-- Notes -->

<!ENTITY note.bin-safe '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数可安全用于二进制对象。</simpara></note>'>


<!ENTITY note.locale-single-byte '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数是本地识别的，会根据当前设置的 locale 处理输入，只适用于单字节字符集。
如果您需要使用多字节字符（大多数非西欧语言），请参考
<link linkend="book.mbstring">multibyte</link> 或 <link linkend="book.intl">intl</link> 扩展。</simpara></note>'>


<!ENTITY note.clearstatcache '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数的结果会被缓存。参见
<function>clearstatcache</function> 以获得更多细节。</simpara></note>'>


<!ENTITY note.context-support '<note xmlns="http://docbook.org/ns/docbook"><simpara>在 PHP 5.0.0
中增加了对上下文（Context）的支持。有关<literal>上下文（Context）</literal>的说明参见
<xref linkend="book.stream"/>。</simpara></note>'>

<!ENTITY note.exec-bg '<note xmlns="http://docbook.org/ns/docbook"><para>如何程序使用此函数启动，为了能保持在后台运行，此程序必须将输出重定向到文件或其它输出流。否则会导致
PHP 挂起，直至程序执行结束。</para></note>'>



<!ENTITY note.exec-bypass-shell '<note xmlns="http://docbook.org/ns/docbook"><para>在 Windows 下，<function>exec</function>
函数会先启动 cmd.exe 来执行指定的命令。如果你希望启动一个额外的应用而不用先启动 cmd.exe
可使用 <function>proc_open</function> 函数加上 <parameter>bypass_shell</parameter> 参数。</para></note>'>

<!ENTITY note.func-callback '<note xmlns="http://docbook.org/ns/docbook"><simpara>除了函数名，含有对象引用的数组和方法名也可以作为参数。</simpara></note>'>



<!ENTITY note.func-callback-exceptions '<note xmlns="http://docbook.org/ns/docbook"><para>在函数中注册有多个回调内容时(如使用
<function>call_user_func</function> 与 <function>call_user_func_array</function>)，如在前一个回调中有未捕获的异常，其后的将不再被调用。</para></note>'>


<!ENTITY note.funcbyref '<note xmlns="http://docbook.org/ns/docbook"><para>如果参数以引用方式传递，函数对该参数的任何改变将在函数返回后保留。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>因为函数依赖于当前作用域以确定参数的细节，所以在
5.3.0 以前的版本中不能用作函数的参数。如必须传递此值时，可将结果赋与一个变量，然后用此变量进行传递。</para></note>'>



<!ENTITY note.line-endings '<note xmlns="http://docbook.org/ns/docbook"><simpara>在读取在 Macintosh 电脑中或由其创建的文件时， 如果 PHP
不能正确的识别行结束符，启用运行时配置可选项 <link linkend="ini.auto-detect-line-endings">auto_detect_line_endings</link>
也许可以解决此问题。</simpara></note>'>



<!ENTITY note.no-remote '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数不能作用于<link
linkend="features.remote-files">远程文件</link>，被检查的文件必须是可通过服务器的文件系统访问的。</simpara></note>'>


<!ENTITY note.not-bin-safe '<warning xmlns="http://docbook.org/ns/docbook"><simpara>此函数（还）不能安全地适用于二进制对象！</simpara></warning>'>


<!ENTITY note.no-key-association '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数为 <parameter>array</parameter>
中的元素赋与新的键名。这将删除原有的键名，而不是仅仅将键名重新排序。</simpara></note>'>



<!ENTITY note.no-windows '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数未在 Windows 平台下实现。</simpara></note>'>


<!ENTITY note.no-windows.extension '<note xmlns="http://docbook.org/ns/docbook"><simpara>此扩展在 Windows 平台上不可用。</simpara></note>'>


<!ENTITY note.no-zts '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数未在 ZTS (Zend Thread Safety) PHP
解释器中实现。确认你的 PHP 版本，可以在命令行输入 <command>php -i</command> 来查看是否包含 <constant>PHP_ZTS</constant> 常量。</simpara></note>'>

<!ENTITY note.randomseed '<note xmlns="http://docbook.org/ns/docbook"><simpara>不再需要用
<function>srand</function> 或 <function>mt_srand</function>
给随机数发生器播种，因为现在是由系统自动完成的。</simpara></note>'>


<!ENTITY note.is-superglobal '<note xmlns="http://docbook.org/ns/docbook"><para>“Superglobal”也称为自动化的全局变量。这就表示其在脚本的所有作用域中都是可用的。不需要在函数或方法中用
<command>global $variable;</command> 来访问它。</para></note>'>




<!ENTITY note.uses-ob '<note xmlns="http://docbook.org/ns/docbook"><para>当使用了<parameter>return</parameter>
参数时，本函数使用其内部输出缓冲，因此不能在
<function>ob_start</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>注意：不同文件系统对时间的判断方法可能是不相同的。</para></note>'>


<!ENTITY note.uses-autoload '<note xmlns="http://docbook.org/ns/docbook"><para>如果此类不是已知类，使用此函数会使用任何已注册的
<link linkend="language.oop5.autoload">autoloader</link>。</para></note>'>


<!ENTITY note.network.header.sapi '<note xmlns="http://docbook.org/ns/docbook">
<para>
 数据头只会在SAPI支持时得到处理和输出。
</para>
</note>
'>


<!ENTITY note.sigchild '<note xmlns="http://docbook.org/ns/docbook">
 <para>
  如果 PHP 是通过 --enable-sigchild 编译的，此函数将没有返回值。
 </para>
</note>
'>

<!ENTITY note.sort-unstable '<note xmlns="http://docbook.org/ns/docbook">
 <para>
  如果两个成员完全相同，那么它们在排序数组中的相对顺序是未定义的。
 </para>
</note>
'>

<!-- Tips -->

<!ENTITY tip.fopen-wrapper '<tip xmlns="http://docbook.org/ns/docbook"><simpara>如已启用<link linkend="ini.allow-url-fopen"
>fopen 包装器</link>，在此函数中， URL 可作为文件名。关于如何指定文件名详见 <function>fopen</function>。各种
wapper 的不同功能请参见 <xref linkend="wrappers"/>，注意其用法及其可提供的预定义变量。</simpara></tip>'>






<!ENTITY tip.fopen-wrapper.stat '<tip xmlns="http://docbook.org/ns/docbook"><simpara>自 PHP 5.0.0 起, 此函数也用于<emphasis>某些</emphasis>
URL 包装器。请参见 <xref linkend="wrappers"/>以获得支持 <function>stat</function> 系列函数功能的包装器列表。</simpara></tip>'>



<!ENTITY tip.ob-capture '<tip xmlns="http://docbook.org/ns/docbook"><simpara>和直接将结果输出到浏览器一样，可使用<link
linkend="book.outcontrol">输出控制函数</link>来捕获当前函数的输出，然后(例如)保存到一个 <type>string</type> 中。</simpara></tip>'>




<!ENTITY tip.userlandnaming '<tip xmlns="http://docbook.org/ns/docbook"><simpara>请参见<xref linkend="userlandnaming" />。</simpara></tip>'>



<!-- Warnings -->

<!ENTITY warn.escapeshell '<warning xmlns="http://docbook.org/ns/docbook"><para>当用户提供的数据传入此函数，使用
<function>escapeshellarg</function> 或 <function>escapeshellcmd</function>
来确保用户欺骗系统从而执行任意命令。</para></warning>'>



<!ENTITY warn.experimental '<warning xmlns="http://docbook.org/ns/docbook"><simpara>此扩展是<emphasis>实验性 </emphasis>的。
此扩展的表象，包括其函数名称以及其他此扩展的相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本扩展风险自担。</simpara></warning>'>




<!ENTITY warn.deprecated.feature-5-3-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>自 PHP 5.3.0
起，已经<emphasis>废弃</emphasis>此特性。强烈建议不要应用此特性。</simpara></warning>'>



<!ENTITY warn.deprecated.feature-5-3-0.removed-5-4-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本特性已自
PHP 5.3.0 起<emphasis>废弃</emphasis>并将自 PHP 5.4.0
起<emphasis>移除</emphasis>。</simpara></warning>'>

<!ENTITY warn.deprecated.function-5-3-0.removed-5-4-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本函数已自 PHP 5.3.0 起<emphasis>废弃</emphasis>并将自
PHP 5.4.0 起<emphasis>移除</emphasis>。</simpara></warning>'>

<!ENTITY warn.deprecated.feature-5-5-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本特性已自 PHP 5.5.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本特性。</simpara></warning>'>


<!ENTITY warn.deprecated.feature-5-6-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本特性已自 PHP 5.6.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本特性。</simpara></warning>'>


<!ENTITY warn.deprecated.feature-7-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本特性已自 PHP 7.0.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本特性。</simpara></warning>'>


<!ENTITY warn.deprecated.feature-7-1-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本特性已自 PHP 7.1.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本特性。</simpara></warning>'>


<!ENTITY warn.deprecated.function-7-1-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本函数已自 PHP 7.1.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本函数。</simpara></warning>'>


<!ENTITY warn.deprecated.function-7-1-0.removed-7-2-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本函数已自 PHP 7.1.0 起<emphasis>废弃</emphasis>并将自
PHP 7.2.0 起<emphasis>移除</emphasis>。强烈建议不要使用本函数。</simpara></warning>'>



<!ENTITY warn.deprecated.feature-7-2-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本特性已自 PHP 7.2.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本特性。</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>本函数已自 PHP 7.2.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本函数。</simpara></warning>'>

<!ENTITY warn.deprecated.function-7-2-0.removed-8-0-0 '<warning
 xmlns="http://docbook.org/ns/docbook"><simpara>本函数已自 PHP 7.2.0
 起被<emphasis>废弃</emphasis>，并自 PHP 8.0.0 起被<emphasis>移除</emphasis>。
 强烈建议不要依赖本函数。</simpara></warning>'>

<!ENTITY warn.deprecated.feature-7-3-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本特性已自 PHP 7.3.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本特性。</simpara></warning>'>


<!ENTITY warn.deprecated.function-7-3-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本函数已自 PHP 7.3.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本函数。</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>本特性已自 PHP 7.4.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本特性。</simpara></warning>'>


<!ENTITY warn.deprecated.function-7-4-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>本函数已自 PHP 7.4.0
起<emphasis>废弃</emphasis>。强烈建议不要使用本函数。</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>本函数已自 PHP 8.0.0
 起被<emphasis>废弃</emphasis>。强烈建议不要依赖本函数。</simpara></warning>'>

<!ENTITY removed.php.future '本过时特性<emphasis
xmlns="http://docbook.org/ns/docbook">将</emphasis>肯定会在未来被<emphasis xmlns="http://docbook.org/ns/docbook">移除</emphasis>。'>

<!ENTITY warn.deprecated.function.removed-5-3-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>自 PHP 5.3.0
起，已经<emphasis>废弃</emphasis>并<emphasis>移除</emphasis>此函数。</simpara></warning>'>


<!ENTITY warn.deprecated.function.removed-5-5-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>自 PHP 5.5.0
起，已经<emphasis>废弃</emphasis>并<emphasis>移除</emphasis>此函数。</simpara></warning>'>


<!ENTITY warn.deprecated.alias-5-3-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>自 PHP 5.3.0
起，已经<emphasis>废弃</emphasis>此别名。强烈建议不要应用此别名。</simpara></warning>'>


<!ENTITY warn.deprecated.func-5-4-0 '<warning xmlns="http://docbook.org/ns/docbook">
<simpara>自PHP 5.4.0 起,此函数已经被<emphasis>废弃</emphasis>。强烈建议不要使用此函数。</simpara></warning>'>


<!ENTITY warn.deprecated.alias-5-4-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>自 PHP 5.4.0
起，已经<emphasis>废弃</emphasis>此别名。强烈建议不要应用此别名。</simpara></warning>'>


<!ENTITY warn.deprecated.func-5-5-0 '<warning xmlns="http://docbook.org/ns/docbook">
<simpara>自PHP 5.5.0 起,此函数已经被<emphasis>废弃</emphasis>。强烈建议不要使用此函数。</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>该功能已在 PHP 5.6.0 中
<emphasis>废弃</emphasis> ，并在 PHP 7.0.0 中
<emphasis>移除</emphasis>。</simpara></warning>'>

<!ENTITY warn.removed.function-7-0-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>该函数已在 PHP 7.0.0 中
<emphasis>移除</emphasis>。</simpara></warning>'>

<!ENTITY warn.removed.function-7-4-0 '<warning
xmlns="http://docbook.org/ns/docbook"><simpara>该函数已在 PHP 7.4.0 中
<emphasis>移除</emphasis>。</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>该别名已在 PHP 7.4.0 中
<emphasis>废弃</emphasis>，并且自 PHP 8.0.0 起已被<emphasis>移除</emphasis>。</simpara></warning>'>

<!ENTITY warn.deprecated.alias-8-0-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>该别名已在 PHP 8.0.0 中
 <emphasis>废弃</emphasis>。</simpara></warning>'>

<!ENTITY warn.removed.alias-8-0-0 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>该别名已在 PHP 8.0.0 中被
 <emphasis>移除</emphasis>。</simpara></warning>'>

<!ENTITY warn.experimental.func '<warning xmlns="http://docbook.org/ns/docbook"><simpara>此函数是<emphasis>实验性</emphasis>的。此函数的表象，包括名称及其相关文档都可能在未来的
PHP 发布版本中未通知就被修改。使用本函数风险自担。</simpara></warning>'>




<!ENTITY warn.imaprecodeyaz '<warning xmlns="http://docbook.org/ns/docbook"><simpara><link
linkend="book.imap">IMAP</link>，<link linkend="book.recode">recode</link>，和 <link linkend="book.yaz">YAZ</link>
扩展不能同时使用，因为它们共享了相同 的内部符号。注意：Yaz
2.0 及以上版本不存在此问题。</simpara></warning>'>


<!ENTITY warn.install.cgi '<warning xmlns="http://docbook.org/ns/docbook"><para>服务器使用 CGI 方式进行部署可能存在几个公开的缺陷。请阅读
<link linkend="security.cgi-bin">CGI 安全</link>一章 以学习 如何抵御这些攻击。</para></warning>'>



<!ENTITY note.magicquotes.gpc '<note xmlns="http://docbook.org/ns/docbook"><title>设置选项说明： magic_quotes_gpc</title>
<para>设置选项<link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>默认值为 <literal>on</literal>。相当于对所有 GET, POST, and COOKIE
 数据使用了 <function>addslashes</function>。可以用 <function>stripslashes</function> 来去掉它们。</para></note>'>



<!ENTITY warn.passwordhashing '
<warning xmlns="http://docbook.org/ns/docbook">
 <para>
  由于此函数依赖的算法已不足够复杂,不推荐使用此函数对明文密码加密。详细内容参见
  <link linkend="faq.passwords.fasthash">这里</link>。
 </para>
</warning>
'>



<!ENTITY warn.ssl-non-standard '<warning xmlns="http://docbook.org/ns/docbook"><para>使用 SSL 时，Microsoft IIS
会违反协议不发送<literal>close_notify</literal>标记就关闭连接。PHP 会在到达数据尾端时报告“SSL: Fatal Protocol Error”。
要解决此问题，<link linkend="ini.error-reporting">error_reporting</link> 应设定为降低级别至不包含警告。
PHP 4.3.7 及更高版本可以在使用 <literal>https://</literal> 包装器打开流时检测出有问题的 IIS 服务器软件 并抑制警告。在使用
<function>fsockopen</function> 创建 <literal>ssl://</literal> 套接字时, 开发者需检测并抑制此警告。</para></warning>'>







<!ENTITY warn.undocumented.class '
<warning xmlns="http://docbook.org/ns/docbook">
 <simpara>
  本类的文档还在编写中，暂时只有属性和方法列表供参考。
 </simpara>
</warning>
'>


<!ENTITY warn.undocumented.func '<warning xmlns="http://docbook.org/ns/docbook"><simpara>本函数还未编写文档，仅有参数列表。</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 '自以下版本起 PHP '>

<!ENTITY version.trunk.changelog '未来'>

<!ENTITY no.function.parameters '<para xmlns="http://docbook.org/ns/docbook">此函数没有参数。</para>'>

<!ENTITY example.outputs '<para xmlns="http://docbook.org/ns/docbook">以上例程会输出：</para>'>

<!ENTITY example.outputs.5 '<para xmlns="http://docbook.org/ns/docbook">以上例程在 PHP 5 中的输出：</para>'>

<!ENTITY example.outputs.53 '<para xmlns="http://docbook.org/ns/docbook">以上例程在 PHP 5.3 中的输出：</para>'>

<!ENTITY example.outputs.54 '<para xmlns="http://docbook.org/ns/docbook">以上例程在 PHP 5.4 中的输出：</para>'>

<!ENTITY example.outputs.55 '<para xmlns="http://docbook.org/ns/docbook">以上例程在 PHP 5.5 中的输出：</para>'>

<!ENTITY example.outputs.56 '<para xmlns="http://docbook.org/ns/docbook">以上例程在 PHP 5.6 中的输出：</para>'>

<!ENTITY example.outputs.7 '<para xmlns="http://docbook.org/ns/docbook">以上例程在 PHP 7 中的输出：</para>'>

<!ENTITY example.outputs.70 '<para xmlns="http://docbook.org/ns/docbook">以上例程在 PHP 7.0 中的输出：</para>'>

<!ENTITY example.outputs.71 '<para xmlns="http://docbook.org/ns/docbook">以上例程在 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">以上例程在 PHP 7.3 中的输出：</para>'>

<!ENTITY example.outputs.8 '<para xmlns="http://docbook.org/ns/docbook">以上例程在 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">以上例程在 PHP 8.0 中的输出：</para>'>

<!ENTITY example.outputs.32bit '<para xmlns="http://docbook.org/ns/docbook">以上例程在 32 位机器上的输出:</para>'>

<!ENTITY example.outputs.64bit '<para xmlns="http://docbook.org/ns/docbook">以上例程在 64 位机器上的输出:</para>'>

<!ENTITY example.outputs.similar '<para xmlns="http://docbook.org/ns/docbook">以上例程的输出类似于：</para>'>


<!ENTITY examples.outputs '<para xmlns="http://docbook.org/ns/docbook">以上例程会输出：</para>'>

<!ENTITY examples.outputs.32bit '<para xmlns="http://docbook.org/ns/docbook">以上例程在 32 位机器上的输出:</para>'>

<!ENTITY examples.outputs.64bit '<para xmlns="http://docbook.org/ns/docbook">以上例程在 64 位机器上的输出:</para>'>

<!ENTITY examples.outputs.similar '<para xmlns="http://docbook.org/ns/docbook">以上例程的输出类似于：</para>'>


<!ENTITY array.resetspointer '<note xmlns="http://docbook.org/ns/docbook"><simpara>使用此函数后会重置（<function>reset</function>）<type>array</type>
指针。</simpara></note>'>


<!ENTITY seealso.array.sorting '<link xmlns="http://docbook.org/ns/docbook" linkend="array.sorting">数组排序函数对比</link>'>

<!ENTITY sort.flags.parameter '<varlistentry xmlns="http://docbook.org/ns/docbook">
  <term><parameter>flags</parameter></term>
  <listitem>
  <para>
    可选的第二个参数 <parameter>flags</parameter>
     可以用以下值改变排序的行为：
  </para>
  <para>
    排序类型标记：
    <itemizedlist>
    <listitem>
      <simpara><constant>SORT_REGULAR</constant>  - 正常比较单元
         详细描述参见 <link linkend="language.operators.comparison">比较运算符</link> 章节
      </simpara>
    </listitem>
    <listitem>
      <simpara><constant>SORT_NUMERIC</constant> - 单元被作为数字来比较</simpara>
    </listitem>
    <listitem>
      <simpara><constant>SORT_STRING</constant> - 单元被作为字符串来比较</simpara>
    </listitem>
    <listitem>
      <simpara>
      <constant>SORT_LOCALE_STRING</constant> -
      根据当前的区域（locale）设置来把单元当作字符串比较，可以用
      <function>setlocale</function> 来改变。
      </simpara>
    </listitem>
    <listitem>
      <simpara>
      <constant>SORT_NATURAL</constant> - 和 <function>natsort</function>
      类似对每个单元以“自然的顺序”对字符串进行排序。
      </simpara>
    </listitem>
    <listitem>
      <simpara>
      <constant>SORT_FLAG_CASE</constant> - 能够与
      <constant>SORT_STRING</constant> 或
         <constant>SORT_NATURAL</constant>
          合并（OR 位运算），不区分大小写排序字符串。
      </simpara>
    </listitem>
    </itemizedlist>
  </para>
  </listitem>
</varlistentry>
'>

<!ENTITY ini.shorthandbytes '<simpara xmlns="http://docbook.org/ns/docbook">当使用  <type>int</type>
时, 其值以字节来衡量。还可以使用在<link linkend="faq.using.shorthandbytes">FAQ</link>中描述的速记符。</simpara>'>



<!ENTITY info.deprecated.alias '为了向下兼容，可以使用下列已废弃的别名：'>


<!ENTITY info.function.alias '此函数是该函数的别名：'>

<!ENTITY info.method.alias '此方法是该方法的别名：'>

<!ENTITY info.function.alias.deprecated '<simpara xmlns="http://docbook.org/ns/docbook">此函数别名已废弃，仅为了向后兼容而保留。不建议使用此函数，因为将来会从 PHP 中移除。</simpara>'>




<!ENTITY ext.windows.path.dll '为了使此扩展生效，
<acronym xmlns="http://docbook.org/ns/docbook">DLL</acronym> 文件必须能在 Windows 系统的
<envar xmlns="http://docbook.org/ns/docbook">PATH</envar> 指示的路径下找到。如何操作的信息，请参见题为“<link
xmlns="http://docbook.org/ns/docbook" linkend="faq.installation.addtopath">如何在 Windows 中将 PHP
目录加到 PATH 中</link>”的<acronym xmlns="http://docbook.org/ns/docbook">FAQ</acronym>。虽然将
DLL 文件从 PHP 文件夹复制到 Windows 系统目录也行，但不建议这样做。
<emphasis xmlns="http://docbook.org/ns/docbook">此扩展需要下列文件在 <envar>PATH</envar> 路径中：</emphasis>'>





<!ENTITY manual.migration.seealso '参见 PHP 版本迁移指南'>

<!ENTITY style.oop '面向对象风格'>
<!ENTITY style.procedural '过程化风格'>

<!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 '<literal xmlns="http://docbook.org/ns/docbook">上下文（context）</literal>的说明请参考手册中的 <link
xmlns="http://docbook.org/ns/docbook" linkend="context">上下文（context）</link>章节.'>

<!ENTITY parameter.use_include_path '值 设为 &true; 时, 也会在
<link xmlns="http://docbook.org/ns/docbook" linkend="ini.include-path">include_path</link>搜索文件名。'>

<!-- Returns -->

<!ENTITY return.falseforfailure ' 或者在失败时返回 &false;'>
<!ENTITY return.falseforfailure.style.procedural '&style.procedural;在失败时返回 &false;。'>

<!ENTITY return.success '成功时返回 &true;，&return.falseforfailure;。'>

<!ENTITY return.nullorfalse '成功时返回 &null;，&return.falseforfailure;。'>

<!ENTITY return.void '没有返回值。'>

<!ENTITY return.callbacksort '在第一个参数小于，等于或大于第二个参数时，该比较函数必须相应地返回一个小于，等于或大于 0 的整数。'>

<!ENTITY return.falseproblem '<warning xmlns="http://docbook.org/ns/docbook"><simpara>此函数可能返回布尔值
&false;，但也可能返回等同于 &false; 的非布尔值。请阅读 <link
linkend="language.types.boolean">布尔类型</link>章节以获取更多信息。应使用
<link linkend="language.operators.comparison">===
运算符</link>来测试此函数的返回值。</simpara></warning>'>



<!-- OpenSSL -->
<!ENTITY openssl.param.x509 '<varlistentry xmlns="http://docbook.org/ns/docbook">
<term><parameter>x509</parameter></term>
<listitem>
 <para>
  参见<link linkend="openssl.certparams">密钥／证书参数</link>以获取有效值列表。
 </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>此函数仅在 PHP
编译时指定了 <option role="configure">--with-t1lib[=DIR]</option> 时可用。</simpara></note>'>


<!ENTITY note.freetype '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数仅在
PHP 编译时加入 freetype 支持时有效（<option role="configure">--with-freetype-dir=DIR</option>）。</simpara></note>'>


<!ENTITY note.gd.notrequired '<note xmlns="http://docbook.org/ns/docbook"><para>此函数不需要 GD 图象库。</para></note>'>

<!ENTITY note.gd.interpolation '<note xmlns="http://docbook.org/ns/docbook"><para>此函数受到 <function>imagesetinterpolation</function> 中设定的插值方法影响。</para></note>'>

<!ENTITY gd.image.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>image</parameter></term>
<listitem><para>由图象创建函数(例如<function>imagecreatetruecolor</function>)返回的图象资源。</para></listitem></varlistentry>'>


<!ENTITY gd.font.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
font</parameter></term><listitem><para>取值对于内建的 latin2 编码字体可以是：1、2、3、4、5(更高的数字对应更大的字体)，或是其他由
<function>imageloadfont</function> 注册的字体标识符。</para></listitem></varlistentry>'>



<!ENTITY gd.psfont.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
font_index</parameter></term><listitem><para>A font resource, returned by <function>imagepsloadfont</function>.
</para></listitem></varlistentry>'>

<!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 '成功后返回图象资源,失败后返回 &false;。'>

<!ENTITY gd.return.trueonerror '<caution xmlns="http://docbook.org/ns/docbook"><simpara>如果 libgd 输出图像失败，函数会返回 &true;。</simpara></caution>'>

<!ENTITY gd.identifier.color "颜色标识符使用 <function xmlns='http://docbook.org/ns/docbook'>imagecolorallocate</function> 创建。">

<!ENTITY gd.value.red '红色成分的值。'>

<!ENTITY gd.value.green '绿色成分的值。'>

<!ENTITY gd.value.blue '蓝色成分的值。'>

<!ENTITY gd.source.height '源图象的高度。'>

<!ENTITY gd.source.width '源图象的宽度。'>

<!ENTITY gd.image.path '文件保存的路径，如果未设置或为 &null;，将会直接输出原始图象流。'>

<!ENTITY gd.image.new '由文件或 URL 创建一个新图象。'>

<!ENTITY gd.image.source '源图象资源。'>

<!ENTITY gd.image.destination '目标图象资源。'>

<!ENTITY gd.image.output '输出图象到浏览器或文件。'>

<!ENTITY gd.image.colors '如果图象由文件创建，只有该图象使用到的颜色会被解析。仅存在于调色板中的颜色不会被解析。'>

<!ENTITY gd.font.size '字体的尺寸，单位：点（磅）。'>

<!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>'>

<!-- DBM notes -->

<!ENTITY dbm.dbm-identifier.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
dbm_identifier</parameter></term><listitem><para>DBM 链接标识符，由 <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 实现了 JSON 的一个超集，参考
   <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>由 <function>curl_init</function> 返回的 cURL 句柄。</para></listitem></varlistentry>'>


<!ENTITY curl.mh.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>multi_handle</parameter>
</term><listitem><para>由 
<function>curl_multi_init</function> 返回的 cURL 多个句柄。</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">
   每个字段都会被转换为对应的 PHP 类型，除了以下场景：
   <itemizedlist>
    <listitem>
     <simpara>
      日期会被转换成字符串。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      DateTime 会被转换成字符串。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      范围之外的整数
      <constant>PHP_INT_MIN</constant>..<constant>PHP_INT_MAX</constant> 将返回字符串。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      dbase 7.0.0 之前的版本， 布尔型 (<literal>L</literal>) 将被转换为 <literal>1</literal> 或
      <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.imap-stream.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
imap</parameter></term><listitem><para>由 <function>imap_open</function> 返回的 IMAP 流。</para></listitem></varlistentry>'>


<!ENTITY imap.pattern '<para xmlns="http://docbook.org/ns/docbook">指定在邮箱层级的何处开始查找。</para>
<para xmlns="http://docbook.org/ns/docbook">在组成 <parameter>pattern</parameter> 的字符中可使用两个特殊字符：
 &apos;<literal>*</literal>&apos; 和 &apos;<literal>&#37;</literal>&apos;。
 &apos;<literal>*</literal>&apos; 是指返回所有邮箱目录. 如果将 &apos;<literal>*</literal>&apos; 作为
 <parameter>pattern</parameter> 参数时, 则会返回整个邮箱层级结构。
 &apos;<literal>&#37;</literal>&apos; 是指只返回当前级次。
 &apos;<literal>&#37;</literal>&apos; 作为 <parameter>pattern</parameter> 参数则只会返回顶层邮箱；
 &apos;<literal>~/mail/&#37;</literal>&apos; 用于 <literal>UW_IMAPD</literal>
 则会返回名为 <filename>~/mail</filename> 的目录, 但不包含其子目录。</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.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.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.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>'>

<!-- mbstring notes -->

<!ENTITY note.mbstring.encoding.internal '<note xmlns="http://docbook.org/ns/docbook"><para><function>mb_regex_encoding</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"><parameter>encoding</parameter>
参数为字符编码。如果省略或是 &null;，则使用内部字符编码。</para>'>

<!ENTITY mbstring.warning.e-modifier '<warning xmlns="http://docbook.org/ns/docbook"><para>处理非信任的输入时从不使用
<literal>e</literal> 修饰符，就不会转码（即调用 <function>preg_replace</function>）。不注意这些会很可能会导致应用程序引发远程代码执行的漏洞。</para></warning>'>

<!ENTITY mbstring.changelog.encoding-nullable '<row xmlns="http://docbook.org/ns/docbook">
  <entry>8.0.0</entry>
  <entry>
   现在 <parameter>encoding</parameter> 可以为 null。
  </entry>
 </row>'>

<!-- mcrypt notes -->

<!ENTITY mcrypt.parameter.cipher '<para xmlns="http://docbook.org/ns/docbook"><constant>MCRYPT_ciphername</constant> 常量中的一个，或者是字符串值的算法名称。</para>'>

<!ENTITY mcrypt.parameter.iv '<para xmlns="http://docbook.org/ns/docbook">在 CBC, CFB, OFB 模式中用于初始化过程，在 STREAM 模式中用于某些算法。如果未提供 IV 并且在某算法中需要，本函数发出一条警告并使用一个全部字节设为 "<literal>\0</literal>" 的 IV。</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"><constant>MCRYPT_MODE_modename</constant> 常量中的一个，或以下字符串中的一个："ecb"，"cbc"，"cfb"，"ofb"，"nofb" 和 "stream"。</para>'>

<!-- MCVE notes -->

<!ENTITY mcve.conn.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
conn</parameter></term><listitem><para>由 <function>m_initengine</function> 返回的 MCVE_CONN 资源。</para></listitem></varlistentry>'>


<!-- memcached notes -->

<!ENTITY memcached.parameter.expiration '到期时间，默认为 0。 更多信息请参见<link
linkend="memcached.expiration" xmlns="http://docbook.org/ns/docbook">到期时间</link>。'>

<!ENTITY memcached.parameter.server_key '本键名用于识别储存和读取值的服务器。没有将实际的键名散列到具体的项目，而是在决定与哪一个 memcached 服务器通信时将其散列为服务器键名。这使得关联的项目在单一的服务上被组合起来以提高多重操作的效率。'>

<!ENTITY memcached.parameter.items '存放在服务器上的键／值对数组。'>

<!ENTITY memcached.parameter.key '用于存储值的键名。'>

<!ENTITY memcached.parameter.value '存储的值。'>

<!ENTITY memcached.result.getresultcode '如需要则使用 <methodname xmlns="http://docbook.org/ns/docbook">Memcached::getResultCode</methodname>。'>

<!-- password notes -->

<!ENTITY password.parameter.algo '一个用来在散列密码时指示算法的<link xmlns="http://docbook.org/ns/docbook" linkend="password.constants">密码算法常量</link>。'>

<!ENTITY password.parameter.hash '一个由 <function xmlns="http://docbook.org/ns/docbook">password_hash</function> 创建的散列值。'>

<!ENTITY password.parameter.options '一个包含有选项的关联数组。详细的参数说明，请参考文档 <link xmlns="http://docbook.org/ns/docbook" linkend="password.constants">密码算法常数</link>。'>

<!ENTITY password.parameter.password '用户的密码。'>

<!-- geaman notes -->

<!ENTITY gearman.parameter.host '任务服务器主机名。'>

<!ENTITY gearman.parameter.port '任务服务器端口号。'>

<!ENTITY gearman.parameter.functionname '由程序自动执行的已注册函数。'>

<!ENTITY gearman.parameter.workload '被处理的序列化数据。'>

<!ENTITY gearman.parameter.data '要完成功能可能需要的附加数据。'>

<!ENTITY gearman.parameter.context '与任务关联的应用程序上下文。'>

<!ENTITY gearman.parameter.unique '用于标识特定任务的唯一性 ID。'>

<!ENTITY gearman.parameter.jobhandle '由 Gearman 服务器指派的工作句柄。'>

<!-- Date and time entities -->
<!ENTITY date.timezone.intro.title '<title xmlns="http://docbook.org/ns/docbook">所支持的时区列表</title>'>

<!ENTITY date.timezone.intro "<para xmlns='http://docbook.org/ns/docbook'>在这你可找到 PHP 所支持的所有时区的列表，可用于诸如
<function>date_default_timezone_set</function> 等函数。<caution><simpara>这里没有列出的时区是未定义的。</simpara></caution>
</para><note xmlns='http://docbook.org/ns/docbook'><simpara>最新版的时区数据库可从
 PECL 的 <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">在此请不要使用任何时区列表（除
UTC 外），仅用于向后兼容，可能会引起某些错误行为。</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">
在每 次调用日期/时间函数时，如果时区无效则会引发 <constant>E_NOTICE</constant> 错误，如果使用系统设定值或 <varname>TZ</varname>
环境变量，则会引发 <constant>E_STRICT</constant> 或 <constant>E_WARNING</constant> 消息。参见
<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>
现在发布 <constant>E_STRICT</constant> 和 <constant>E_NOTICE</constant>
时区错误。</para></entry></row>'>

<!ENTITY date.timestamp.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>timestamp</parameter></term><listitem><para>
可选的 <parameter>timestamp</parameter> 参数是一个 <type>int</type> 的 Unix
时间戳，如未指定或是 &null;，参数值默认为当前本地时间。也就是说，其值默认为
<function>time</function> 的返回值。</para></listitem></varlistentry>'>




<!ENTITY date.datetime.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>object</parameter></term>
<listitem><para>仅为过程化风格：由 <function>date_create</function> 返回的 <classname>DateTime</classname> 类型的对象。</para></listitem></varlistentry>'>


<!ENTITY date.datetime.description.modified '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>object</parameter></term>
<listitem><para>仅过程化风格：由 <function>date_create</function> 返回的 <classname>DateTime</classname> 类型的对象。此函数会修改这个对象。</para></listitem></varlistentry>'>



<!ENTITY date.datetimezone.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
object</parameter></term><listitem><para>仅过程化风格：由 <function>timezone_open</function> 返回的
<classname>DateTimeZone</classname> 对象。</para></listitem></varlistentry>'>

<!ENTITY date.datetime.return.modifiedobjectorfalseforfailure '返回被修改的 DateTime 对象，&return.falseforfailure;.'>

<!ENTITY date.timezone.dbversion '基于时区数据库版本的列表'>

<!ENTITY date.timezone.africa '非洲'>
<!ENTITY date.timezone.america '美洲'>
<!ENTITY date.timezone.antarctica '南极洲'>
<!ENTITY date.timezone.arctic '北极'>
<!ENTITY date.timezone.asia '亚洲'>
<!ENTITY date.timezone.atlantic '大西洋'>
<!ENTITY date.timezone.australia '澳洲'>
<!ENTITY date.timezone.europe '欧洲'>
<!ENTITY date.timezone.indian '印度'>
<!ENTITY date.timezone.pacific '太平洋地区'>
<!ENTITY date.timezone.others '其他'>
<!ENTITY date.timezone.abbreviations '缩略语'>

<!ENTITY date.formats '正确格式的说明详见 <link xmlns="http://docbook.org/ns/docbook" linkend="datetime.formats">日期与时间格式</link>。'>
<!ENTITY date.formats.parameter '日期/时间字符串。&date.formats;'>

<!-- DomXml Notes -->
<!ENTITY node.inserted '此节点出现在文档中，除非是用诸如
<function xmlns="http://docbook.org/ns/docbook">domnode_append_child</function> 等函数来将其插入。'>


<!-- Dom Notes -->
<!ENTITY dom.node.inserted '此节点出现在文档中，除非是用诸如
<function xmlns="http://docbook.org/ns/docbook">DOMNode->appendChild</function> 等函数来将其插入。'>

<!ENTITY dom.allowstatic '<para xmlns="http://docbook.org/ns/docbook">此方法<emphasis>可以</emphasis>被静态调用,但会抛出一个 <constant>E_STRICT</constant> 错误。</para>'>
<!ENTITY dom.malformederror '<para xmlns="http://docbook.org/ns/docbook">尽管非正确格式化的 HTML 仍应该被成功调入，但此函数会在遇到错误标记时产生 <constant>E_WARNING</constant> 错误。<link linkend="function.libxml-use-internal-errors">libxml 错误处理函数</link>可以用来处理这类错误。</para>'>
<!ENTITY dom.note.utf8 '<note xmlns="http://docbook.org/ns/docbook"><para>此 DOM 扩展采用 UTF-8 编码。在 ISO-8859-1 编码下，使用 <function>utf8_encode</function> 和 <function>utf8_decode</function> 来处理，其它编码下使用 <link linkend="ref.iconv">iconv</link> 函数处理。</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">以下范例使用了 <filename>book.xml</filename>，其内容如下：</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">
失败时抛出<constant>E_WARNING</constant>警告。
</para>'>

<!ENTITY fs.validfp.all '<para xmlns="http://docbook.org/ns/docbook">文件指针必须是有效的，必须指向由
<function>fopen</function> 或 <function>fsockopen</function> 成功打开的文件(并还未由 <function>fclose</function> 关闭)。</para>'>



<!ENTITY fs.file.pointer '<para xmlns="http://docbook.org/ns/docbook">文件系统指针，是典型地由
<function>fopen</function> 创建的 <type>resource</type>(资源)。</para>'>

<!ENTITY fs.file.32bit '<note xmlns="http://docbook.org/ns/docbook"><simpara>
因为 PHP 的整数类型是有符号整型而且很多平台使用 32 位整型，对 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">gnupg 标识符，由对
<function>gnupg_init</function> 或 <classname>gnupg</classname> 的调用生成。</para>'>

<!ENTITY gnupg.fingerprint '<para xmlns="http://docbook.org/ns/docbook">指纹键名。</para>'>

<!-- HaruDoc -->
<!ENTITY haru.error '<para xmlns="http://docbook.org/ns/docbook">发生错误时抛出 <classname>HaruException</classname> 异常。</para>'>

<!-- ODBC -->
<!ENTITY odbc.connection.id '<para xmlns="http://docbook.org/ns/docbook">ODBC 连接标识符，详见
<function>odbc_connect</function>。</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 '此参数接受下列查询模式：
<literal xmlns="http://docbook.org/ns/docbook">&#x25;</literal> 来匹配零到多个字符，
<literal xmlns="http://docbook.org/ns/docbook">_</literal> 来匹配单个字符。'>

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

<!-- OAUTH -->
<!ENTITY oauth.callback.error '如回调函数无法被调用或未被指定，会引发一个
<constant xmlns="http://docbook.org/ns/docbook">E_ERROR</constant> 级别的错误。'>

<!ENTITY oauth.changelog.error.null '以前失败时返回 &null;，而不是 &false;。'>

<!-- Oracle -->
<!ENTITY oci.db 
"<para xmlns='http://docbook.org/ns/docbook' xmlns:xlink='http://www.w3.org/1999/xlink'>
包含要连接的
<literal>Oracle 实例</literal>。可以是 <link xlink:href='&url.oracle.oic.connect;'>Easy Connect 串</link>，或是
<filename>tnsnames.ora</filename> 文件中的连接名，或是本地 Oracle 实例名。
</para>

<para xmlns='http://docbook.org/ns/docbook'>
 如果不指定，PHP 使用环境变量来确定连接的 <literal>Oracle 实例</literal>，诸如
 <constant>TWO_TASK</constant>（Linux 下）或  <constant>LOCAL</constant>（Windows 下）与 <constant>ORACLE_SID</constant> 等。
</para>


<para xmlns='http://docbook.org/ns/docbook'>
 要使用 Easy Connect 命名方法，PHP 必须与 Oracle 10<emphasis>g</emphasis> 或更高版本的客户端库进行链接。Oracle 10<emphasis>g</emphasis> 的 Easy Connect
 串格式：<emphasis>[//]host_name[:port][/service_name]</emphasis>。Oracle
 11<emphasis>g</emphasis> 则为：<emphasis>[//]host_name[:port][/service_name][:server_type][/instance_name]</emphasis>。
 在 Oracle 19c 加入类更多选项，例如 timeout 和 keep-alive 设置。
 请参考 Oracle 文档。
 服务名可在数据库服务器机器上运行
 Oracle 实用程序 <literal>lsnrctl status</literal> 找到。
</para>



<para xmlns='http://docbook.org/ns/docbook'>
 <filename>tnsnames.ora</filename> 文件可在 Oracle Net 查找路径中，此路径包括 <filename>/your/path/to/instantclient/network/admin</filename>、<filename>$ORACLE_HOME/network/admin</filename>
 、<filename>/etc</filename>。 另一种方法是设置 <literal>TNS_ADMIN</literal> 以便通过 <filename>$TNS_ADMIN/tnsnames.ora</filename>
 来读取。表确认 web 守护进程可读取此文件。
</para>">




<!ENTITY oci.charset "<para xmlns='http://docbook.org/ns/docbook'>
使用 Oracle
客户端库来确定字符集。字符集不需要与数据库的字符集相匹配。如果不匹配，Oracle
会尽可能地将数据从数据库字符集进行转换。因为依赖于字符集，可能不能给出可用的结果。转换也增加一些时间开销。
</para>


<para xmlns='http://docbook.org/ns/docbook'>
 如果不指定，Oracle 客户端用 <constant>NLS_LANG</constant> 环境变量来决定字符集。
</para>

<para xmlns='http://docbook.org/ns/docbook'>
 传递此参数可减少连接时间。
</para>">

<!ENTITY oci.sessionmode '<para xmlns="http://docbook.org/ns/docbook">
此参数在 PHP 5（PECL OCI8
1.1）版本开始可用，并收受下列值：<constant>OCI_DEFAULT</constant>，<constant>OCI_SYSOPER</constant>
和 <constant>OCI_SYSDBA</constant>。如为
<constant>OCI_SYSOPER</constant> 或 <constant>OCI_SYSDBA</constant>
其中之一，此函数将会使用外部的证书建立有特权的连接。有特权的连接默认是禁用的。需要将
<link linkend="ini.oci8.privileged-connect">oci8.privileged_connect</link>
设为 <literal>On</literal> 来启用。
</para>


<para xmlns="http://docbook.org/ns/docbook">
 PHP 5.3（PECL OCI8 1.3.4）引进了
 <constant>OCI_CRED_EXT</constant> 模式值。使用外部或操作系统认证必需在 Oracle
 数据库中进行配置。<constant>OCI_CRED_EXT</constant>
 标志只可用于用户为 &quot;/&quot;，密码为空的情况。<link
 linkend="ini.oci8.privileged-connect">oci8.privileged_connect</link>
 可为 <literal>On</literal> 或 <literal>Off</literal>。
</para>

<para xmlns="http://docbook.org/ns/docbook">
 <constant>OCI_CRED_EXT</constant> 可与
 <constant>OCI_SYSOPER</constant> 或
 <constant>OCI_SYSDBA</constant> 模式组合使用。
</para>
<para xmlns="http://docbook.org/ns/docbook">
 <constant>OCI_CRED_EXT</constant> 由于安全的原因不支持 Windows 系统。
</para>'>


<!ENTITY oci.datatypes '<para xmlns="http://docbook.org/ns/docbook">要获取 OCI8
扩展进行数据类型映射的细节，请参见<link linkend="oci8.datatypes">驱动所支持的数据类型</link>。</para>'>


<!ENTITY oci.parameter.connection '<para xmlns="http://docbook.org/ns/docbook">Oracle 连接标识，由
<function>oci_connect</function>，<function>oci_pconnect</function>，或
<function>oci_new_connect</function> 返回。</para>'>

<!ENTITY oci.availability.note.10g '<note xmlns="http://docbook.org/ns/docbook"><title>Oracle 版本需求</title>
<para>当 PHP 是与 Oracle 数据库 10<emphasis>g</emphasis> 及更新版本的 扩展库链接时，此函数可用。</para></note>'>


<!ENTITY oci.clientinfo.tip '<tip xmlns="http://docbook.org/ns/docbook"><title>性能</title>
 <para>使用旧版的 OCI8 或 ORACLE 数据库，可使用
 Oracle <literal>DBMS_APPLICATION_INFO</literal> 包来设置客户端信息。这比使用
 <function>oci_set_client_info</function> 较低效。</para></tip>'>

<!ENTITY oci.roundtrip.caution '<caution xmlns="http://docbook.org/ns/docbook"><title>Roundtrip Gotcha</title>
<para>一些 OCI8 函数会导致 Roundtrips. 对数据库来说当启用结果缓存时，查询可能不产生 Roundtrips。</para></caution>'>



<!ENTITY oci.use.setprefetch '<para xmlns="http://docbook.org/ns/docbook">
查询返回巨大数量的数据行时，通过增大
<link linkend="ini.oci8.default-prefetch">oci8.default_prefetch</link>
值或使用 <function>oci_set_prefetch</function> 可显著提高性能。</para>'>




<!ENTITY oci.arg.statement.id
"<para xmlns='http://docbook.org/ns/docbook'>有效的 OCI8 报表标识符
由 <function>oci_parse</function> 创建，被 <function>oci_execute</function>
或 <literal>REF CURSOR</literal> statement 标识执行。</para>">


<!-- PCNTL Notes -->
<!ENTITY pcntl.parameter.status '<para xmlns="http://docbook.org/ns/docbook">参数
<parameter>status</parameter> 是提供给成功调用 <function>pcntl_waitpid</function>
时的状态参数。</para>'>

<!-- PS Notes -->
<!ENTITY ps.note.visible '<para xmlns="http://docbook.org/ns/docbook">此说明在文档被打印或显示时不可见，只在文档用 Acrobat Distiller 或 Ghostview 转换成 PDF 时显示。</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>当启用
<link linkend="features.safe-mode">安全模式</link>时，
PHP 会检查被操作的文件或目录是否与被执行的脚本有相同的 UID（所有者）。</simpara></note>'>


<!-- Not used in EN anymore -->
<!ENTITY note.sm.uidcheck.dir '<note xmlns="http://docbook.org/ns/docbook"><simpara>当启用
<link linkend="features.safe-mode">安全模式</link>时，
PHP 会在执行脚本时检查被脚本操作的目录是否与被执行的脚本有相同的 UID（所有者）。</simpara></note>'>


<!ENTITY note.open-basedir.func '<note xmlns="http://docbook.org/ns/docbook"><para>此函数受
<link linkend="ini.open-basedir">open_basedir</link> 影响。</para></note>'>


<!ENTITY note.language-construct '<note xmlns="http://docbook.org/ns/docbook"><simpara>因为是一个语言构造器而不是一个函数，不能被
<link linkend="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 '检查被操作的文件或目录是否与被执行的脚本有相同的 UID（所有者）。'>


<!-- Not used in EN anymore -->
<!ENTITY warn.sm.exec '<warning xmlns="http://docbook.org/ns/docbook"><simpara><link linkend="features.safe-mode">安全模式</link> 启用时，命令字符串会被
<function>escapeshellcmd</function> 转换。因此，<literal>echo y | echo x</literal> 会变成
<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><link linkend="features.safe-mode">安全模式</link> 启用时，可仅可用
<link linkend="ini.safe-mode-exec-dir">safe_mode_exec_dir</link> 执行文件。实际上，现在不允许在到可执行的路径中存在 <literal>..</literal> 组件。</simpara></note>'>




<!-- Not used in EN anymore -->
<!ENTITY sm.uidcheck.dir '检查被操作的目录是否与被执行的脚本有相同的 UID（所有者）。'>



<!-- Not used in EN anymore -->
<!ENTITY sm.disabled '当 PHP 运行在 <link xmlns="http://docbook.org/ns/docbook" linkend="features.safe-mode">安全模式</link> 时，不能使用此函数。'>


<!-- Common pieces in partintro-sections -->
<!ENTITY no.config '<para xmlns="http://docbook.org/ns/docbook">此扩展没有在 &php.ini; 中定义配置指令。</para>'>
<!ENTITY no.resource '<para xmlns="http://docbook.org/ns/docbook">此扩展没有定义资源类型。</para>'>
<!ENTITY no.constants '<para xmlns="http://docbook.org/ns/docbook">此扩展没有定义常量。</para>'>
<!ENTITY no.requirement '<para xmlns="http://docbook.org/ns/docbook">构建此扩展不需要其他扩展。</para>'>
<!ENTITY no.install '<para xmlns="http://docbook.org/ns/docbook">使用这些函数不需要安装，它们是 PHP 核心的一部分。</para>'>


<!-- Used in every chapter that has directive descriptions -->
<!ENTITY ini.descriptions.title '<para xmlns="http://docbook.org/ns/docbook">这是配置指令的简短说明。</para>'>


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

<!-- Used in reference/$extname/ini.xml -->
<!ENTITY extension.runtime '<simpara xmlns="http://docbook.org/ns/docbook">
这些函数的行为受 &php.ini; 中的设置影响。
</simpara>'>

<!ENTITY ini.php.constants '有关 PHP_INI_* 样式的更多详情与定义，见 <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">下列常量由此扩展定义，且仅在此扩展编译入 PHP 或在运行时动态载入时可用。</simpara>'>





<!-- For STANDARD Constants used in reference/$extname/constants.xml -->
<!ENTITY extension.constants.core '<simpara xmlns="http://docbook.org/ns/docbook">
下列常量作为 PHP 核心的一部分总是可用的。
</simpara>'>

<!-- Used in reference/$extname/classes.xml -->
<!ENTITY extension.classes '<simpara xmlns="http://docbook.org/ns/docbook">
下列类由此扩展定义，且仅在此扩展编译入 PHP 或在运行时动态载入时可用。
</simpara>'>



<!ENTITY note.extension.php5 '<note xmlns="http://docbook.org/ns/docbook"><simpara>
此扩展需要 PHP 5。</simpara></note>'>

<!-- PDO entities -->
<!ENTITY pdo.driver-constants '<simpara xmlns="http://docbook.org/ns/docbook">下列常量由此驱动定义，且仅在扩展编译入 PHP
或在运行时动态载入时可用。另外，使用此驱动时，仅会使用这些驱动特定的常量。使用其他驱动的驱动特定的常量可能会导致不可预见的情况。如果代码可运行于多个驱动，<function>PDO::getAttribute</function>
可被用于获取
<constant>PDO_ATTR_DRIVER_NAME</constant>
属性以检查驱动。</simpara>'>




<!ENTITY pdo.errors.exception-not-errmode '<note xmlns="http://docbook.org/ns/docbook"><simpara><constant>PDO::ATTR_ERRMODE</constant> 属性不是 <constant>PDO::ERRMODE_EXCEPTION</constant> 时会抛出一个异常。</simpara></note>'>

<!-- PECL entities -->
<!ENTITY pecl.moved '此 <link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link> 扩展未与
PHP 捆绑。'>

<!ENTITY pecl.bundled '此 <link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link> 扩展未与
PHP 捆绑。'>

<!ENTITY pecl.info '安装此 PECL 扩展相关的信息可在手册中标题为
<link xmlns="http://docbook.org/ns/docbook" linkend="install.pecl">PECL
扩展的安装</link>章节中找到。更多信息如新的发行版本、下载、源文件、
维护人员信息及变更日志等，都在此处：'>


<!ENTITY pecl.info.dead '此扩展被认为已无人维护及已消亡。然而，此扩展的源代码还可在
<acronym xmlns="http://docbook.org/ns/docbook">PECL</acronym>
<acronym xmlns="http://docbook.org/ns/docbook">SVN</acronym> 找到：'>

<!ENTITY pecl.info.dead.git '此扩展被认为已无人维护及已消亡。然而，此扩展的源代码还可在
<acronym xmlns="http://docbook.org/ns/docbook">PECL</acronym>
<acronym xmlns="http://docbook.org/ns/docbook">GIT</acronym> 找到：'>

<!ENTITY pecl.windows.download '<acronym
xmlns="http://docbook.org/ns/docbook">PECL</acronym> 扩展的
<acronym xmlns="http://docbook.org/ns/docbook">DLL</acronym> 当前不可用。参见
<link xmlns="http://docbook.org/ns/docbook" linkend="install.windows.legacy.building">在 Windows 上构建</link>章节。'>

<!ENTITY pecl.windows.download.avail '此扩展在 Windows 平台的二进制扩展 (<acronym xmlns="http://docbook.org/ns/docbook">DLL</acronym> 文件) 
<acronym xmlns="http://docbook.org/ns/docbook">PECL</acronym> 可以在 PECL 官方网站上下载。'>

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

<!ENTITY pecl.moved-ver '此扩展已被移至
<link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link> 资源库且不再与 PHP 捆绑。'>


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


<!ENTITY windows.builtin '<simpara xmlns="http://docbook.org/ns/docbook">PHP
的 Windows 版本已内建对此扩展的支持。不需要载入额外的扩展来使用这些函数。</simpara>'>


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

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

<!-- APD Notes -->
<!ENTITY apd.debug-level.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
debug_level</parameter></term><listitem><para>由加上 <literal>XXX_TRACE</literal>
常量而形成的整数。</para><para>不建议使用
<constant>MEMORY_TRACE</constant>。这会很慢且似乎不精确。
<constant>ASSIGNMENT_TRACE</constant> 还未被实现。</para><para>要打开所有跟踪功能(TIMING, FUNCTIONS, ARGS SUMMARY (比如 strace -c)) 则使用 99 作为值。</para>
</listitem></varlistentry>'>


<!-- BCMath Notes -->
<!ENTITY bc.scale.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
scale</parameter></term><listitem><para>此可选参数用于设置结果中小数点后的小数位数。也可通过使用
<function>bcscale</function> 来设置全局默认的小数位数，用于所有函数。如果未设置，则默认为 <literal>0</literal>。
</para></listitem></varlistentry>'>


<!-- CTYPE Notes -->
<!ENTITY note.ctype.parameter.integer '<note xmlns="http://docbook.org/ns/docbook"><para>
如果给出一个 -128 到 255 之间(含)的<type>int</type>, 将会被解释为该值对应的ASCII字符 (负值将加上 256 以支持扩展ASCII字符).
其它整数将会被解释为该值对应的十进制字符串.</para></note>'>



<!-- FBSQL Notes -->
<!ENTITY fbsql.link-identifier.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
link_identifier</parameter></term><listitem><para>由
<function>fbsql_connect</function> 或
<function>fbsql_pconnect</function> 返回的 FrontBase 链接标识符.</para>
<para>如可选并未指定，函数会尝试查找一个到 FrontBase 服务器的开放链接，且如没有找到这样的链接，会尝试通过不带参数调用 <function>fbsql_connect</function> 来创建一个。</para>
</listitem></varlistentry>'>



<!ENTITY fbsql.result.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
result</parameter></term><listitem><para>由 <function>fbsql_query</function>
或 <function>fbsql_db_query</function> 返回的结果标识符。</para></listitem></varlistentry>'>


<!-- GMP Notes -->
<!ENTITY gmp.return '<classname xmlns="http://docbook.org/ns/docbook">GMP</classname> 对象。'>
<!ENTITY gmp.parameter '<para xmlns="http://docbook.org/ns/docbook"><classname>GMP</classname> 对象或 &integer; ，或数字&string;。</para>'>

<!-- MySQLi Notes -->
<!ENTITY mysqli.result.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
result</parameter></term><listitem><para>仅以过程化样式：由
<function>mysqli_query</function>、<function>mysqli_store_result</function>、
<function>mysqli_use_result</function>、<function>mysqli_stmt_get_result</function> 返回的结果集标识。</para></listitem></varlistentry>'>
<!ENTITY mysqli.link.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
link</parameter></term><listitem><para>仅以过程化样式：由<function>mysqli_connect</function> 或 <function>mysqli_init</function>
返回的链接标识。</para></listitem></varlistentry>'>

<!ENTITY mysqli.stmt.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
stmt</parameter></term><listitem><para>仅以过程化样式：由
<function>mysqli_stmt_init</function> 返回的 statement 标识。</para></listitem></varlistentry>'>
<!ENTITY mysqli.available.mysqlnd '仅可用于 <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 总是使用服务器的默认字符集。此字符集在连接握手／认证时发送，并被 mysqlnd
使用。</para><para>Libmysqlclient 使用 <filename>my.cnf</filename> 中的默认字符集或者由在调用
<function>mysqli_init</function> 之后，<function>mysqli_real_connect</function>
之前先调用 <function>mysqli_options</function> 来指定。</para></note>'>

<!-- Notes for SAPI/Apache -->
<!ENTITY apache.req.module '<simpara xmlns="http://docbook.org/ns/docbook">仅在
 PHP 以 Apache 模块运行时，才支持此函数。
 
 </simpara>'>

<!-- SimpleXML Notes -->
<!ENTITY simplexml.iteration '<note xmlns="http://docbook.org/ns/docbook"><simpara>SimpleXML
建起了一个给大多数方法添加迭代属性的规则。不能通过使用
<function>var_dump</function> 或任何可检查对象的其它东西来查看。</simpara></note>'>

<!-- SQLite Notes -->
<!ENTITY sqlite.case-fold '<para xmlns="http://docbook.org/ns/docbook">由
<constant>SQLITE_ASSOC</constant> 与 <constant>SQLITE_BOTH</constant>
返回的列名会依照 <link linkend="ini.sqlite.assoc-case">sqlite.assoc_case</link>
配置选项的值决定大小写。</para>'>


<!ENTITY sqlite.decode-bin '<para xmlns="http://docbook.org/ns/docbook">当
<parameter>decode_binary</parameter> 参数设置为 &true;（默认值）时，PHP 会解码那些由
<function>sqlite_escape_string</function>
编码后的二进制数据。通常应保留此值为其默认值，除非要与其他使用 SQLlite 的应用程序建立的数据交互。</para>'>



<!ENTITY sqlite.no-unbuffered '<note xmlns="http://docbook.org/ns/docbook"><para>此函数不能用于未缓冲的结果句柄。</para></note>'>


<!ENTITY sqlite.param-compat '<note xmlns="http://docbook.org/ns/docbook"><simpara>为兼容其他数据库扩展(比如 MySQL)，支持两种可替代的语法。推荐第一种格式，函数的第一个参数是<parameter>dbhandle</parameter>。</simpara></note>'>




<!ENTITY sqlite.result-type '<para xmlns="http://docbook.org/ns/docbook">可选的 <parameter>result_type</parameter>
参数接受常量，且决定返回的数组如何被索引。使用
<constant>SQLITE_ASSOC</constant> 会仅返回关联索引（已命名字段），而
<constant>SQLITE_NUM</constant> 会仅返回数值索引。<constant>SQLITE_BOTH</constant>
会同时返回关联和数值索引。<constant>SQLITE_BOTH</constant> 是此函数的默认值。</para>'>



<!-- Database Notes -->
<!ENTITY database.field-case '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数返回的字段名<emphasis>大小写敏感</emphasis>。</simpara></note>'>


<!ENTITY database.fetch-null '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数将 NULL 字段设置为 PHP &null; 值。</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>mSQL 连接。如果不指定，则使用由
<function>msql_connect</function> 最近打开的连接。如果没有找到该连接，函数会尝试通过调用
<function>msql_connect</function> 建立连接并使用它。
</para></listitem></varlistentry>'>


<!ENTITY msql.result.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
result</parameter></term><listitem><para><type>resource</type>
型的结果集。此结果集来自对 <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>数值型字段偏移量。
<parameter>field_offset</parameter> 从 <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>MySQL
连接。如不指定连接标识，则使用由 <function>mysql_connect</function>
最近打开的连接。如果没有找到该连接，会尝试不带参数调用
<function>mysql_connect</function>
来创建。如没有找到连接或无法建立连接，则会生成
<constant>E_WARNING</constant> 级别的错误。</para></listitem>
</varlistentry>'>

<!ENTITY mysql.linkid-noreopen.description '<varlistentry
xmlns="http://docbook.org/ns/docbook"><term><parameter>
link_identifier</parameter></term><listitem><para> MySQL 连接. 如果该连接标识符未给出, 将使用最近一次<function>mysql_connect</function>建立的连接. 
如果没有找到可使用的连接, 将产生一个 <constant>E_WARNING</constant> 错误.</para></listitem></varlistentry>'>




<!ENTITY mysql.result.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
result</parameter></term><listitem><para><type>resource</type>
型的结果集。此结果集来自对 <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>数值型字段偏移量。
<parameter>field_offset</parameter> 从 <literal>0</literal> 开始。如果
<parameter>field_offset</parameter> 不存在，则会发出一个
<constant>E_WARNING</constant> 级别的错误</para></listitem></varlistentry>'>

<!ENTITY mysql.alternative.note '<para xmlns="http://docbook.org/ns/docbook">本扩展自 PHP 5.5.0
起已废弃，并在自 PHP 7.0.0 开始被移除。应使用 <link linkend="book.mysqli">MySQLi</link>
或 <link linkend="ref.pdo-mysql">PDO_MySQL</link> 扩展来替换之。参见
<link linkend="mysqlinfo.api.choosing">MySQL：选择 API</link> 指南来获取更多信息。
用以替代本函数的有：</para>'>

<!ENTITY mysql.alternative.note.4-3-0 '<para xmlns="http://docbook.org/ns/docbook">本函数自 PHP 4.3.0
 起已废弃，并且它和整个<link linkend="book.mysql">MySQL 扩展</link>自 PHP 7.0.0 开始被移除。
可以选择出于活跃开发中的<link linkend="book.mysqli">MySQLi</link>或<link linkend="ref.pdo-mysql">PDO_MySQL</link>扩展来作为替代。
参见<link linkend="mysqlinfo.api.choosing">MySQL：选择 API</link> 指南
来获取更多信息。用以替代本函数的有：</para>'>

<!ENTITY mysql.alternative.note.5-3-0 '<para xmlns="http://docbook.org/ns/docbook">本函数自 PHP 5.3.0
 起已废弃，并且它和整个<link linkend="book.mysql">MySQL 扩展</link>自 PHP 7.0.0 开始被移除。
可以选择出于活跃开发中的<link linkend="book.mysqli">MySQLi</link>或<link linkend="ref.pdo-mysql">PDO_MySQL</link>扩展来作为替代。
参见<link linkend="mysqlinfo.api.choosing">MySQL：选择 API</link> 指南以及
<link linkend="faq.databases.mysql.deprecated">相关 FAQ</link>来获取更多信息。
用以替代本函数的有：</para>'>

<!ENTITY mysql.alternative.note.5-4-0 '<para xmlns="http://docbook.org/ns/docbook">本函数自 PHP 5.4.0
 起已废弃，并且它和整个<link linkend="book.mysql">MySQL 扩展</link>自 PHP 7.0.0 开始被移除。
可以选择出于活跃开发中的<link linkend="book.mysqli">MySQLi</link>或<link linkend="ref.pdo-mysql">PDO_MySQL</link>扩展来作为替代。
参见<link linkend="mysqlinfo.api.choosing">MySQL：选择 API</link> 指南来获取更多信息。
用以替代本函数的有：</para>'>

<!ENTITY mysql.alternative.note.5-5-0 '<para xmlns="http://docbook.org/ns/docbook">本函数自 PHP 5.5.0
 起已废弃，并且它和整个<link linkend="book.mysql">MySQL 扩展</link>自 PHP 7.0.0 开始被移除。
可以选择出于活跃开发中的<link linkend="book.mysqli">MySQLi</link>或<link linkend="ref.pdo-mysql">PDO_MySQL</link>扩展来作为替代。
参见<link linkend="mysqlinfo.api.choosing">MySQL：选择 API</link> 指南来获取更多信息。
用以替代本函数的有：</para>'>

<!ENTITY mysql.close.connections.result.sets '<para xmlns="http://docbook.org/ns/docbook">
建立非持久性的 MySQL 连接，会在 PHP
执行完毕后自动销毁，所以手动关闭连接，并释放资源是可选的。但是还是推荐你在代码中显性的执行该操作，这对提高代码性能有帮助。参考文档
<link linkend="language.types.resource.self-destruct">资源释放</link></para>'>




<!-- Sybase Notes -->
<!ENTITY sybase.ct.only '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数仅适用于对 Sybase 使用 CT 库接口，而不适用于 DB 库。</simpara></note>'>



<!ENTITY sybase.db.only '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数仅适用于对 Sybase 使用 DB 库接口，而不适用于 CT 库。</simpara></note>'>


<!ENTITY sybase.linkid.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
link_identifier</parameter></term><listitem><para>Sybase
连接。如不指定连接标识，则使用由 <function>sybase_connect</function>
最近打开的连接。如果没有找到该连接，会尝试不带参数调用
<function>sybase_connect</function> 来创建。如没有找到连接或无法建立连接，则会生成
<constant>E_WARNING</constant> 级别的错误。
</para></listitem>
</varlistentry>'>

<!-- CPDF Notes -->
<!ENTITY cpdf.ul '<para xmlns="http://docbook.org/ns/docbook">可选参数 <parameter>mode</parameter>
决定单位长度。如为 <literal>0</literal> 或省略，则为页面使用的默认单位。其他情况下，座标用 postscript 点进行度量，而忽略当前单位。</para>'>



<!ENTITY cpdf.mode.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
mode</parameter></term><listitem><para>可选参数 <parameter>mode</parameter>
决定单位长度。如为 <literal>0</literal> 或省略，则为页面使用的默认单位。其他情况下，座标用 postscript 点进行度量，而忽略当前单位。</para>
</listitem></varlistentry>'>



<!ENTITY cpdf.pdf-document.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
pdf_document</parameter></term><listitem><para>文档句柄，由
<function>cpdf_open</function>返回。</para></listitem></varlistentry>'>

<!-- Xattr entities -->
<!ENTITY xattr.namespace '<para xmlns="http://docbook.org/ns/docbook">扩展的属性有两种 不同的命名空间：user
和 root。user 命名空间对所有用户均有效，而 root
命名空间仅对拥有 root 权限的用户有效。
xattr 默认在 user 命名空间上操作，但可使用
<parameter>flags</parameter> 参数进行更改。</para>'>

<!-- Notes for IPv6 -->
<!ENTITY ipv6.brackets '<note xmlns="http://docbook.org/ns/docbook"><simpara>当指定数值型的 IPv6
地址（例如 <literal>fe80::1</literal>）时必须用方括号将 IP 围起来——例如，
<literal>tcp://[fe80::1]:80</literal>。</simpara></note>'>

<!ENTITY ipv6.php5 '<note xmlns="http://docbook.org/ns/docbook"><simpara>在
PHP 5.0.0 开始加入了对 IPv6 的支持。</simpara></note>'>

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

<!ENTITY tidy.conf-enc '<para xmlns="http://docbook.org/ns/docbook">参数
<parameter>config</parameter> 可传递数组或字符串。如传递字符串，则代表配置文件名，否则代表选项本身。关于每个选项的说明参见
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.tidy.conf;">&url.tidy.conf;</link></para>
<para><parameter>encoding</parameter> 参数设置输入/输出文档的编码。<parameter>encoding</parameter>
 的值可为：
 <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> 和
 <literal>shiftjis</literal>。</para>'>




<!-- Snippets for the installation section -->
<!ENTITY warn.apache2.compat '<warning xmlns="http://docbook.org/ns/docbook"><para>不推荐在使用 Apache 2
的产品中使用线程化 MPM。应使用预分支 MPM，Apache 2.0 和 2.2
默认的 MPM。其原因见 FAQ 中的相关条目<link linkend="faq.installation.apache2">使用线程化 MPM 的
Apache2</link>。</para></warning>'>


<!ENTITY note.apache.slashes '<note xmlns="http://docbook.org/ns/docbook"><simpara>记住当在
Windows 环境下的 Apache 配置文件中添加路径值时，所有的反斜线，如
<filename>c:\directory\file.ext</filename>，应转换为正斜线：
<filename>c:/directory/file.ext</filename>。对目录来说，也必须由斜线结尾。</simpara></note>'>


<!-- Snippets and titles for the contributors section -->
<!ENTITY Credit.Authors.and.Contributors '作者与贡献者'>

<!ENTITY Credit.Introduction '<para xmlns="http://docbook.org/ns/docbook">在手册的首页上仅突出了目前最活跃的人员，但还有更多的贡献者正在帮助我们工作或在过去给项目提供过巨大的帮助。有许多不知名的人帮助在手册中写下用户评论，并不断地包含在参考中，也很感谢他们的努力。下面所提供的列表均以字母顺序排序。</para>'>








<!ENTITY Credit.Authors.and.Editors '作者与编辑'>

<!ENTITY Credit.Past.Authors.Text '下列人员曾经或者目前正在为本手册添砖加瓦：'>



<!ENTITY Credit.Past.Editors.Text '下列人员对本手册做了相当数量的编辑工作：'>


<!ENTITY Credit.Note.Editors.Title '用户评论维护者'>

<!ENTITY Credit.Note.Editors.Active '目前最活跃的维护者是：'>

<!ENTITY Credit.Note.Editors.Inactive '下列人员为维护用户评论作出了巨大的努力:'>


<!ENTITY listendand ' 和 '>

<!-- classkit and runkit entities -->
<!ENTITY note.classkit.selfmanipulation '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数不能用来操作当前正常运行（或运行链上）的方法。</simpara>
</note>'>


<!ENTITY note.runkit.selfmanipulation '<note xmlns="http://docbook.org/ns/docbook"><simpara>此函数不能用来操作当前正常运行（或运行链上）的方法。</simpara>
</note>'>

<!ENTITY note.runkit.sandbox '<note xmlns="http://docbook.org/ns/docbook"><simpara>沙箱支持（是 <function>runkit_lint</function>，<function>runkit_lint_file</function>
函数，与 <classname>Runkit_Sandbox</classname> 类所必需）仅可用于
PHP 5.1.0 或 PHP 5.0 的特别修补版本，并需启用线程安全。更多信息可参见 runkit 包中的
<filename>README</filename> 文件。</simpara></note>'>





<!ENTITY note.runkit.internal-override '<note xmlns="http://docbook.org/ns/docbook"><simpara>默认情况下，仅在用户空间可删除，重命名，或者修改函数。为了覆盖内部函数，必须启用 &php.ini; 中的
<literal>runkit.internal_override</literal> 设置。</simpara>
</note>'>



<!-- SSH2 Extension -->
<!ENTITY note.ssh2.subsystem.publickey '<note xmlns="http://docbook.org/ns/docbook"><simpara>公钥子系统用于管理服务器到<emphasis>已</emphasis>被认证的客户端的公钥。要用公钥认证方法来认证远程系统，应使用
<function>ssh2_auth_pubkey_file</function> 函数。</simpara></note>'>




<!-- Session notes -->
<!ENTITY returns.session.storage.retval '会话存储的返回值（通常成功返回 0，失败返回 1）。'>

<!-- XMLWriter Notes -->
<!ENTITY xmlwriter.xmlwriter.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
xmlwriter</parameter></term><listitem><para>仅用于过程调用。被修改的 <classname>XMLWriter</classname> 实例对象。此资源来自于对 <function>xmlwriter_open_uri</function> 或
<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> 需要 <classname>XMLWriter</classname> 实例，
  之前需要的是 <type>resource</type>。
 </entry>
</row>'>

<!-- SOAP notes -->
<!ENTITY soap.wsdl.mode.only "<note xmlns='http://docbook.org/ns/docbook'><para>此函数仅在 WSDL 模式下生效。</para></note>">

<!-- Stomp notes -->
<!ENTITY stomp.param.link "<varlistentry xmlns='http://docbook.org/ns/docbook'><term><parameter>link</parameter></term><listitem><para>仅对过程化样式：由 <function>stomp_connect</function> 返回的 stomp 连接标识符。</para></listitem></varlistentry>">
<!ENTITY stomp.param.headers "<varlistentry xmlns='http://docbook.org/ns/docbook'><term><parameter>headers</parameter></term><listitem><para>关联数组包含附加的头信息（例如： 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>相对路径将会以PHP执行文件所在目录作为当前工作目录进行解析。如果希望依据脚本所在目录解析, 使用<function>realpath</function> 或 dirname(__FILE__)。</simpara></note>">
<!ENTITY svn.referto.status '参见 <link xmlns="http://docbook.org/ns/docbook" linkend="svn.constants.status">状态常量列表</link> 获得可能的值.'>
<!ENTITY svn.referto.type '参见 <link xmlns="http://docbook.org/ns/docbook" linkend="svn.constants.type">类型常量列表</link> 获取可能的值.'>

<!-- FANN notes -->
<!ENTITY fann.ann.description '<para xmlns="http://docbook.org/ns/docbook">神经网络 <type>资源</type>。</para>'>
<!ENTITY fann.train.description '<para xmlns="http://docbook.org/ns/docbook">神经网络训练数据 <type>资源</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">无返回值。</para>'>
<!ENTITY fann.return.bool '<para xmlns="http://docbook.org/ns/docbook">成功时返回 &true;，其它情况下返回 &false;。</para>'>
<!ENTITY fann.return.ann '<para xmlns="http://docbook.org/ns/docbook"> 成功时返回神经网络 <type>资源</type>，发生错误返回 &false;。</para>'>
<!ENTITY fann.return.train '<para xmlns="http://docbook.org/ns/docbook"> 成功时返回训练数据 <type>资源</type>，发生错误返回 &false;。</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 '成功时返回 &true;。'>
<!ENTITY imagick.imagick.throws '错误时抛出 ImagickException。'>
<!ENTITY imagick.imagickdraw.throws '错误时抛出 ImagickDrawException。'>
<!ENTITY imagick.imagickpixel.throws '错误时抛出 ImagickPixelException。'>
<!ENTITY imagick.imagickpixeliterator.throws '错误时抛出 ImagickPixelIteratorException。'>

<!-- Imagick version infos -->
<!ENTITY imagick.method.available.0x629 '此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x631 '此方法在Imagick基于ImageMagick 6.3.1以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x632 '此方法在Imagick基于ImageMagick 6.3.2以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x636 '此方法在Imagick基于ImageMagick 6.3.6以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x637 '此方法在Imagick基于ImageMagick 6.3.7以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x638 '此方法在Imagick基于ImageMagick 6.3.8以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x639 '此方法在Imagick基于ImageMagick 6.3.9以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x640 '此方法在Imagick基于ImageMagick 6.4.0以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x641 '此方法在Imagick基于ImageMagick 6.4.1以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x642 '此方法在Imagick基于ImageMagick 6.4.2以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x643 '此方法在Imagick基于ImageMagick 6.4.3以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x644 '此方法在Imagick基于ImageMagick 6.4.4以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x645 '此方法在Imagick基于ImageMagick 6.4.5以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x647 '此方法在Imagick基于ImageMagick 6.4.7以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x649 '此方法在Imagick基于ImageMagick 6.4.9以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x653 '此方法在Imagick基于ImageMagick 6.5.3以上版本编译时可用。'>
<!ENTITY imagick.method.available.0x657 '此方法在Imagick基于ImageMagick 6.5.7以上版本编译时可用。'>

<!ENTITY imagick.method.not.available.0x700 '此方法在 Imagick 基于 ImageMagick 7.0.0 或以上版本编译时不可用。'>

<!ENTITY imagick.constant.available '此常量可用仅当Imagick编译于ImageMagick版本'>

<!ENTITY imagick.deprecated.function-3-4-4 '<warning xmlns="http://docbook.org/ns/docbook"><simpara>此函数在 Imagick 3.4.4 中被 <emphasis>废弃</emphasis>，强烈建议不要应用此函数。</simpara></warning>'>

<!-- Imagick default channel information -->
<!ENTITY imagick.default.channel.info '缺省为<constant xmlns="http://docbook.org/ns/docbook">Imagick::CHANNEL_DEFAULT</constant>. 
参考此 <link xmlns="http://docbook.org/ns/docbook" linkend="imagick.constants.channel">通道常数</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 '透明级别：1.0 是完全不透明，0.0 是完全透明。'>

<!ENTITY imagick.imagickexception.throw '错误时抛出
<classname xmlns="http://docbook.org/ns/docbook">ImagickException</classname>。'>

<!ENTITY imagick.bestfit.note '<note xmlns="http://docbook.org/ns/docbook">
<simpara>
 参数 <parameter>bestfit</parameter> 的特性在 Imagick 3.0.0 中已改变。在此版本以前，当目标尺寸设为
 400x400 时，原尺寸为 200x150 的图像将不会被改变。自 Imagick 3.0.0
 起，源图像将会被放大到 400x300 因为这将更好的适合目标尺寸。当使用参数
 <parameter>bestfit</parameter> 时，必须同时给出宽度和高度。
</simpara>
</note>'>


<!ENTITY note.openssl.cnf '<note xmlns="http://docbook.org/ns/docbook">
<simpara>
 必须安装有效的 <filename>openssl.cnf</filename> 以保证此函数正确运行。参考有关<link
 linkend="openssl.installation">安装</link>的说明以获得更多信息。
</simpara>
</note>'>


<!ENTITY note.openssl.param-notext '<para xmlns="http://docbook.org/ns/docbook">
可选参数 <parameter>notext</parameter> 影响输出的冗余度。如果设为
&false;，输出内容将包含附加的人类可读信息。<parameter>notext</parameter> 的缺省值为 &true;。
</para>'>



<!-- COM/Dotnet --> 
<!ENTITY com.variant-arith '<note xmlns="http://docbook.org/ns/docbook">
<para>
 对于所有变量运算函数，本函数的参数可以是 PHP
 内置的类型（整数，字符串，浮点数，布尔型或者
 &null;），或者是一个 COM，VARIANT 或者 DOTNET 类的实例。PHP
 内置类型将会使用和构造<xref
 linkend="class.variant"/>类相同的规则转换成变量。COM 和 DOTNET
 对象的值将会取其默认属性并被当成变量值使用。
</para>
<para>
 变量运算函数是同名函数在 COM
 库中的外包；有关此类函数的更多信息参见 MSDN
 库。PHP 函数命名有少许区别，例如 PHP
 中的 <function>variant_add</function> 对应于
 MSDN 文档中的 <literal>VarAdd()</literal>。
</para>
</note>
'>
<!ENTITY com.use-oo-instead '<note xmlns="http://docbook.org/ns/docbook">
<simpara>
 此函数在 PHP 5 中不再存在. 你应该使用更自然的面向对象语法操作属性及方法。
</simpara>
</note>
'>


<!-- phar -->
<!ENTITY phar.write '<note xmlns="http://docbook.org/ns/docbook"><para>此方法需要
将 &php.ini; 中的 <literal>phar.readonly</literal> 设为
<literal>0</literal> 以适合 <classname>Phar</classname>
对象.  否则, 将抛出<classname>PharException</classname>.</para></note>'>

<!ENTITY phar.removed.pharcompress '<note xmlns="http://docbook.org/ns/docbook"><para>此方法已经从 phar
扩展 2.0.0以上版本中删除。可使用
<function>Phar::compress</function>，<function>Phar::decompress</function>，<function>Phar::compressFiles</function>
和 <function>Phar::decompressFiles</function>替代。</para></note>'>


<!ENTITY phar.removed.pharfileinfocompress '<note xmlns="http://docbook.org/ns/docbook"><para>此方法已经从 phar
扩展 2.0.0以上版本中删除。可使用
<function>PharFileInfo::isCompressed</function>，<function>PharFileInfo::decompress</function> 和
<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">此扩展需要
<link linkend="book.libxml">libxml</link> PHP 扩展。这表示需要使用
<option role="configure">--with-libxml</option>，或在 PHP 7.4 之前的版本中使用
<option role="configure">--enable-libxml</option>，
尽管这将隐式完成因为 libxml 是缺省开启的。
</para>'>


<!-- XMLReader -->
<!ENTITY xmlreader.libxml20620.note '<caution xmlns="http://docbook.org/ns/docbook"><para>此函数仅在 PHP 与 libxml 20620 或以上版本编译时可用。</para></caution>'>

<!-- inotify -->
<!ENTITY inotify.instance.description '<function xmlns="http://docbook.org/ns/docbook">inotify_init</function>返回的资源'>


<!-- User streams -->
<!ENTITY userstream.not.implemented.warning '<para xmlns="http://docbook.org/ns/docbook">调用此方法失败将给出
<constant>E_WARNING</constant>（未实现）。</para>'>
<!ENTITY userstream.updates.context '<note xmlns="http://docbook.org/ns/docbook"><para>当合法的上下文传递给调用函数时，属性
<varname linkend="streamwrapper.props.context">streamWrapper::$context</varname>
会被改变。</para></note>'>


<!-- Gmagick -->
<!ENTITY gmagick.return.success '成功时返回 &true;。'>
<!ENTITY gmagick.gmagickexception.throw '错误时抛出
<classname xmlns="http://docbook.org/ns/docbook">GmagickException</classname>。'>

<!-- Reflection -->
<!ENTITY reflection.export.return '如果参数 <parameter xmlns="http://docbook.org/ns/docbook">return</parameter> 
设为 &true;，导出结果将作为 <type xmlns="http://docbook.org/ns/docbook">string</type>
返回，否则返回 &null;。'>

<!ENTITY reflection.export.param.return '设为 &true; 时返回导出结果，设为 &false;（默认值）则忽略返回。'>


<!ENTITY reflection.invoke.reference '如果函数有参数需为引用，那么它们必须以引用方式传入。'>


<!ENTITY reflection.export.param.name '导出的反射。'>

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

<!ENTITY spl.exceptions.intro.title '<title xmlns="http://docbook.org/ns/docbook">异常</title>'>
<!ENTITY spl.exceptions.intro '<para xmlns="http://docbook.org/ns/docbook">SPL 提供一系列标准异常。</para><para xmlns="http://docbook.org/ns/docbook">可参考<xref linkend="reserved.exceptions" />。</para>'>

<!ENTITY spl.files.intro.title '<title xmlns="http://docbook.org/ns/docbook">文件处理</title>'>
<!ENTITY spl.files.intro '<partintro xmlns="http://docbook.org/ns/docbook"><para>SPL 提供 一些与文件相关的类。</para></partintro>'>

<!ENTITY spl.interfaces.intro.title '<title xmlns="http://docbook.org/ns/docbook">接口</title>'>
<!ENTITY spl.interfaces.intro '<para xmlns="http://docbook.org/ns/docbook">SPL 提供一系列接口。</para><para xmlns="http://docbook.org/ns/docbook">可参考<xref linkend="reserved.interfaces" />。</para>'>
<!ENTITY spl.interfaces.list '<title xmlns="http://docbook.org/ns/docbook">接口列表</title>'>

<!ENTITY spl.iterators.intro.title '<title xmlns="http://docbook.org/ns/docbook">迭代器</title>'>
<!ENTITY spl.iterators.intro '<para xmlns="http://docbook.org/ns/docbook">SPL 提供一系列迭代器以遍历不同的对象。</para>'>

<!ENTITY spl.misc.intro.title '<title xmlns="http://docbook.org/ns/docbook">各种类及接口</title>'>
<!ENTITY spl.misc.intro '<partintro xmlns="http://docbook.org/ns/docbook"><para>无法归入其它 SPL 分类的类和接口。</para></partintro>'>

<!-- ZIP -->
<!ENTITY zip.filename.separator '<note xmlns="http://docbook.org/ns/docbook"><simpara>为了最大限度地提高代码可移植性，建议在 ZIP 文件名中使用斜线 (<literal>/</literal>) 做为目录分隔符。</simpara></note>'>

<!-- Win32Service -->
<!ENTITY win32service.false.error '，参数错误时返回 &false;，或失败时返回一个 <link xmlns="http://docbook.org/ns/docbook" linkend="win32service.constants.errors">Win32 错误码</link>。'>
<!ENTITY win32service.success.false.error ' 成功时返回 &true;&win32service.false.error;'>
<!ENTITY win32service.noerror.false.error ' 成功时返回 <constant xmlns="http://docbook.org/ns/docbook">WIN32_NO_ERROR</constant>&win32service.false.error;'>

<!-- SNMP -->
<!ENTITY snmp.set.type.values '<para xmlns="http://docbook.org/ns/docbook">
<acronym>MIB</acronym> 定义了各个对象 id 的类型。必须是下面列出的单个字符之一。
</para>
<table xmlns="http://docbook.org/ns/docbook">
 <title>类型</title>
 <tgroup cols="2">
  <tbody>
   <row><entry>=</entry><entry>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">
 如果在编译 <acronym>SNMP</acronym> 库时定义了 <constant>OPAQUE_SPECIAL_TYPES</constant>，那么下列值是合法的：
</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">
这些值大都会使用与 ASN.1 相符的类型。&apos;s&apos;，&apos;x&apos;，&apos;d&apos;
以及 &apos;b&apos; 都是指定一个八字节字符串值的方式。并且 &apos;u&apos; 无符号类型也可用于处理 Gauge32 值。
</para>
'>
<!ENTITY snmp.set.type.values.equal.note '<para xmlns="http://docbook.org/ns/docbook">
如果 MIB 文件是用 "snmp_read_mib" 或者通过在 libsnmp config 中指定而加载入 MIB 树时，
&apos;=&apos; 可以被用作为所有对象的 <parameter>type</parameter> 参数，因为 type 可以被自动从 MIB 中读取。
</para>
'>
<!ENTITY snmp.set.type.values.bitset.note '<para xmlns="http://docbook.org/ns/docbook">
注意有两种方式可以设定 BITS 类型的变量，例如
"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>
   使用 "b" 类型以及一个位数的列表。不推荐使用此方法，因为 GET 查询对同一个 OID 将会返回例如 0xF8。
  </simpara>
 </listitem>
 <listitem>
  <simpara>
   使用 "x" 类型以及一个十六进制数但是不需要通常的 "0x" 前缀。
  </simpara>
 </listitem>
</itemizedlist>
<para xmlns="http://docbook.org/ns/docbook">
 更多细节见范例部分。
</para>
'>
<!ENTITY snmp.methods.exceptions_enable.refsect '<refsect1 role="errors" xmlns="http://docbook.org/ns/docbook">
&reftitle.errors;
<para>
 本方法默认不抛出任何异常。如果要在某些库出错时抛出 SNMPException 
 异常，用户需要将 SNMP 类参数 <parameter>exceptions_enabled</parameter> 
 设定为相应的值。更多细节见
 <link linkend="snmp.props.exceptions-enabled">
  <parameter>SNMP::$exceptions_enabled</parameter> 的解释</link>。
</para>
</refsect1>
'>

<!-- Eio -->
<!ENTITY eio.callback.proto '<para xmlns="http://docbook.org/ns/docbook">
<parameter xmlns="http://docbook.org/ns/docbook">callback</parameter>
函数在请求完成时被调用。其应匹配一下原型：<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>传递给请求的用户数据。</para></listitem>
 </varlistentry>
 <varlistentry xmlns="http://docbook.org/ns/docbook">
  <term><parameter>result</parameter></term>
  <listitem><para>针对请求的结果的值。通常是相应的系统调用返回的值。</para></listitem>
 </varlistentry>
 <varlistentry xmlns="http://docbook.org/ns/docbook">
  <term><parameter>req</parameter></term>
  <listitem><para>可选的请求资源，可被 <function>eio_get_last_error</function>
   之类的函数使用。</para></listitem>
 </varlistentry>
</variablelist>
</para>
'>

<!ENTITY eio.request.pri.values '<para
xmlns="http://docbook.org/ns/docbook">请求的优先级：<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> 或 &null;。如果是
&null;，<parameter
xmlns="http://docbook.org/ns/docbook">pri</parameter> 将设为
<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">避免相对路径。</simpara></warning>
'>


<!ENTITY trader.arg.array.of.real '浮点数数组。'>
<!ENTITY trader.arg.array.of.real.high '高价，浮点数数组。'>
<!ENTITY trader.arg.array.of.real.low '低价，浮点数数组。'>
<!ENTITY trader.arg.array.of.real.close '收盘价，浮点数数组。'>
<!ENTITY trader.arg.array.of.real.open '开盘价，浮点数数组。'>
<!ENTITY trader.arg.array.of.real.volume '成交量，浮点数数组。'>
<!ENTITY trader.arg.array.of.real.periods '浮点数数组。'>
<!ENTITY trader.arg.penetration '一个烛台渗入到另一个烛台的百分比。'>
<!ENTITY trader.arg.vfactor '成交量因子。有效值从 0 到 1。'>
<!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> or <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>local</literal> is as follows:
           </para>
           <programlisting role="javascript">
<![CDATA[
local: {
    // The master key used to encrypt/decrypt data keys
    key: <96-byte MongoDB\BSON\Binary with subtype 0>
}
]]>
           </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
-->