[phpdoc-zh] r230 committed - 翻译函数：ini-get、ini-set、phpcredits、phpinfo、phpversion

2 views

Skip to first unread message

phpd...@googlecode.com

unread,

May 22, 2012, 4:17:18 AM5/22/12

to phpd...@googlegroups.com

Revision: 230
Author: ice.shiny
Date: Tue May 22 01:16:59 2012
Log: 翻译函数：ini-get、ini-set、phpcredits、phpinfo、phpversion
http://code.google.com/p/phpdoc-zh/source/detail?r=230

Added:
/trunk/xml/reference/info/functions/ini-get.xml
/trunk/xml/reference/info/functions/ini-set.xml
/trunk/xml/reference/info/functions/phpcredits.xml
/trunk/xml/reference/info/functions/phpinfo.xml
/trunk/xml/reference/info/functions/phpversion.xml

=======================================
--- /dev/null
+++ /trunk/xml/reference/info/functions/ini-get.xml Tue May 22 01:16:59 2012
@@ -0,0 +1,151 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<refentry xml:id="function.ini-get" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+ <refname>ini_get</refname>
+ <refpurpose>获取配置选项的值</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>ini_get</methodname>
+
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ 成功时返回配置选项的值。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>varname</parameter></term>
+ <listitem>
+ <para>
+ 配置选项名称。
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ 成功时作为字符串形式返回配置选项的值，或者值为 <literal>null</literal>
时返回空字符串。配置选项不存在时则返回 &false;。
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>A few <function>ini_get</function> 示例</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+/*
+php.ini 包含了以下设置：
+
+display_errors = On
+register_globals = Off
+post_max_size = 8M
+*/
+
+echo 'display_errors = ' . ini_get('display_errors') . "\n";
+echo 'register_globals = ' . ini_get('register_globals') . "\n";
+echo 'post_max_size = ' . ini_get('post_max_size') . "\n";
+echo 'post_max_size+1 = ' . (ini_get('post_max_size')+1) . "\n";
+echo 'post_max_size in bytes = ' . return_bytes(ini_get('post_max_size'));
+
+function return_bytes($val) {
+ $val = trim($val);
+ $last = strtolower($val[strlen($val)-1]);
+ switch($last) {
+ // The 'G' modifier is available since PHP 5.1.0
+ case 'g':
+ $val *= 1024;
+ case 'm':
+ $val *= 1024;
+ case 'k':
+ $val *= 1024;
+ }
+
+ return $val;
+}
+
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+
+display_errors = 1
+register_globals = 0
+post_max_size = 8M
+post_max_size+1 = 9
+post_max_size in bytes = 8388608
+
+]]>
+ </screen>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <title>当查询一个boolean值</title>
+ <para>
+ Boolean的ini值：<literal>off</literal> 会作为一个空字符串或者是“0”来返
回。如果值是 <literal>on</literal> 则会返回“1”。此函数也能返回INI值的文本字
符串。
+ </para>
+ </note>
+ <note>
+ <title>当查询一个内存尺寸的值</title>
+ <para>
+ 很多INI配置里内存大小的值，例如 <link
linkend="ini.upload-max-filesize">upload_max_filesize</link>，在 &php.ini;
文件里以简写形式储存。
+ <function>ini_get</function> 会返回 &php.ini; 文件里确切的字符值而
<emphasis>不是</emphasis>它的 <type>integer</type> 量。
+ 用普通的算术函数将无法得到预期的效果。不过以下的例子显示了如何像PHP源码
一样把简写形式转换成字节。
+ </para>
+ </note>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>get_cfg_var</function></member>
+ <member><function>ini_get_all</function></member>
+ <member><function>ini_restore</function></member>
+ <member><function>ini_set</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/info/functions/ini-set.xml Tue May 22 01:16:59 2012
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<refentry xml:id="function.ini-set" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+ <refname>ini_set</refname>
+ <refpurpose>设置一个配置选项的值</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>ini_set</methodname>
+
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
+
<methodparam><type>string</type><parameter>newvalue</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ 设置指定配置选项的值。该新的值将在脚本执行时保持不变，直到脚本结束，恢复
原有的设置。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>varname</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ <para>
+ 不是所有的有效选项都能用 <function>ini_set</function> 来修改的。在
<link linkend="ini.list">附录</link> 里有一个所有有效配置选项的列表。
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>newvalue</parameter></term>
+ <listitem>
+ <para>
+ 选项新的值。
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ 成功时返回旧的值，失败时返回 &false;。
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>设置一个ini选项</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+echo ini_get('display_errors');
+
+if (!ini_get('display_errors')) {
+ ini_set('display_errors', 1);
+}
+
+echo ini_get('display_errors');
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>get_cfg_var</function></member>
+ <member><function>ini_get</function></member>
+ <member><function>ini_get_all</function></member>
+ <member><function>ini_restore</function></member>
+ <member>
+ <link linkend="configuration.changes">如何修改配置选项</link>
+ </member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/info/functions/phpcredits.xml Tue May 22 01:16:59
2012
@@ -0,0 +1,179 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<refentry xml:id="function.phpcredits"
xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+ <refname>phpcredits</refname>
+ <refpurpose>打印PHP贡献者名单</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>phpcredits</methodname>
+ <methodparam
choice="opt"><type>int</type><parameter>flag</parameter><initializer>CREDITS_ALL</initializer></methodparam>
+ </methodsynopsis>
+ <para>
+ 本函数列出了PHP核心、PHP模块及其他开发者的贡献名单。它生成了适合的HTML代
码将信息插入到一个页面中。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>flag</parameter></term>
+ <listitem>
+ <para>
+ 要定制一个贡献名单页面，可以使用 <parameter>flag</parameter>参数。
+ </para>
+ <para>
+ <table>
+ <title>预定义的 <function>phpcredits</function> flags</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>名称</entry>
+ <entry>描述</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>CREDITS_ALL</entry>
+ <entry>
+ 所有的贡献名单，相当于使用: <constant>CREDITS_DOCS</constant> +
+ <constant>CREDITS_GENERAL</constant> +
<constant>CREDITS_GROUP</constant> +
+ <constant>CREDITS_MODULES</constant> +
<constant>CREDITS_FULLPAGE</constant>。它以适当的标签产生了一个完整的独立
HTML页面。
+ </entry>
+ </row>
+ <row>
+ <entry>CREDITS_DOCS</entry>
+ <entry>文档小组贡献名单</entry>
+ </row>
+ <row>
+ <entry>CREDITS_FULLPAGE</entry>
+ <entry>
+ 常与其他flag组合，表示需要打印一个包含其他flag所表示信息的完整HTML页
面。
+ </entry>
+ </row>
+ <row>
+ <entry>CREDITS_GENERAL</entry>
+ <entry>
+ 主要贡献者：语言和理念的设计，PHP和SAPI模块的作者们。
+ </entry>
+ </row>
+ <row>
+ <entry>CREDITS_GROUP</entry>
+ <entry>内核开发者名单</entry>
+ </row>
+ <row>
+ <entry>CREDITS_MODULES</entry>
+ <entry>
+ PHP扩展以及各自开发者的名单。
+ </entry>
+ </row>
+ <row>
+ <entry>CREDITS_SAPI</entry>
+ <entry>
+ PHP的服务器API模块以及各自的开发者。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>打印主要贡献者名单</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+phpcredits(CREDITS_GENERAL);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ <example>
+ <title>打印核心开发者和文档组名单。</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+phpcredits(CREDITS_GROUP | CREDITS_DOCS | CREDITS_FULLPAGE);
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ <example>
+ <title>打印所有贡献者名单</title>
+ <programlisting role="php">
+<![CDATA[
+<html>
+ <head>
+ <title>你自己的credits页面</title>
+ </head>
+ <body>
+<?php
+// 一些你自己的代码
+phpcredits(CREDITS_ALL - CREDITS_FULLPAGE);
+// 其他一些代码
+?>
+ </body>
+</html>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>phpversion</function></member>
+ <member><function>php_logo_guid</function></member>
+ <member><function>phpinfo</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/info/functions/phpinfo.xml Tue May 22 01:16:59 2012
@@ -0,0 +1,222 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<refentry xml:id="function.phpinfo" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>phpinfo</refname>
+ <refpurpose>输出PHP配置的信息</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>phpinfo</methodname>
+ <methodparam
choice="opt"><type>int</type><parameter>what</parameter><initializer>INFO_ALL</initializer></methodparam>
+ </methodsynopsis>
+ <para>
+ 输出PHP当前状态的大量信息，包括PHP编译选项和扩展，PHP版本、服务器信息和
环境(作为模块编译的话)、PHP运行环境、操作系统版本信息、路径、配置选项、
HTTP头和PHP License。
+ </para>
+ <para>
+ 由于每个系统配置有差异，<function>phpinfo</function> 常用于检查系统的
<link
+ linkend="configuration">配置选项</link> 和有效的
+ <link linkend="language.variables.predefined">预定义变量</link>。
+ </para>
+ <para>
+ <function>phpinfo</function> 也是一个包含所有EGPCS (Environment, GET,
POST, Cookie, Server)数据的有用的调试工具。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>what</parameter></term>
+ <listitem>
+ <para>
+ 可以用以下的一个或多个<emphasis>常量</emphasis>用位运算传递给可选的
<parameter>what</parameter>参数来定制输出的信息。
+ 该参数可以把常量相加或者用 <link
linkend="language.operators.bitwise">or</link> 操作符按位运算。
+ </para>
+ <para>
+ <table>
+ <title><function>phpinfo</function> 选项</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>常量名</entry>
+ <entry>值</entry>
+ <entry>描述</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>INFO_GENERAL</entry>
+ <entry>1</entry>
+ <entry>配置行、 &php.ini; 的位置、安装时间、Web服务器、系统及其
他。
+ </entry>
+ </row>
+ <row>
+ <entry>INFO_CREDITS</entry>
+ <entry>2</entry>
+ <entry>
+ PHP贡献者。参见 <function>phpcredits</function>。
+ </entry>
+ </row>
+ <row>
+ <entry>INFO_CONFIGURATION</entry>
+ <entry>4</entry>
+ <entry>
+ 当前PHP指令的局部值和全局值。参见
<function>ini_get</function>。
+ </entry>
+ </row>
+ <row>
+ <entry>INFO_MODULES</entry>
+ <entry>8</entry>
+ <entry>
+ 已加载的模块和各自的设置。参见
<function>get_loaded_extensions</function>。
+ </entry>
+ </row>
+ <row>
+ <entry>INFO_ENVIRONMENT</entry>
+ <entry>16</entry>
+ <entry>环境变量信息，在 <varname>$_ENV</varname> 中同样有效。
+ </entry>
+ </row>
+ <row>
+ <entry>INFO_VARIABLES</entry>
+ <entry>32</entry>
+ <entry>
+ 显示所有来自EGPCS(Environment, GET,
+ POST, Cookie, Server)的 <link
linkend="language.variables.predefined">
+ 预定义变量</link>。
+ </entry>
+ </row>
+ <row>
+ <entry>INFO_LICENSE</entry>
+ <entry>64</entry>
+ <entry>
+ PHP版权信息。参见<link
+ xlink:href="&url.php.license;">license FAQ</link>。
+ </entry>
+ </row>
+ <row>
+ <entry>INFO_ALL</entry>
+ <entry>-1</entry>
+ <entry>
+ 显示以上所有信息。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>5.2.2</entry>
+ <entry>
+ 在配置文件路径前添加“已加载的配置文件”信息。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>phpinfo</function> 示例</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+// 显示所有信息，默认是INFO_ALL。
+phpinfo();
+
+// 仅仅显示模块信息。
+// 其结果相当于phpinfo(8)
+phpinfo(INFO_MODULES);
+
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <para>
+ 当 <link linkend="ini.expose-php">expose_php</link> 设置为
<literal>off</literal> 部分信息将不会被显示。包括PHP和Zend的标志与贡献者名
单。
+ </para>
+ </note>
+ <note>
+ <para>
+ 在命令行（CLI）模式下 <function>phpinfo</function> 仅会输出纯文本，而不
是HTML。
+ </para>
+ </note>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>phpversion</function></member>
+ <member><function>phpcredits</function></member>
+ <member><function>php_logo_guid</function></member>
+ <member><function>ini_get</function></member>
+ <member><function>ini_set</function></member>
+ <member><function>get_loaded_extensions</function></member>
+ <member><link linkend="language.variables.predefined">预定义变量
</link></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
+
+
=======================================
--- /dev/null
+++ /trunk/xml/reference/info/functions/phpversion.xml Tue May 22 01:16:59
2012
@@ -0,0 +1,143 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<refentry xml:id="function.phpversion"
xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+ <refname>phpversion</refname>
+ <refpurpose>获取当前PHP的版本</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>phpversion</methodname>
+ <methodparam
choice="opt"><type>string</type><parameter>extension</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ 返回当前运行的PHP解析器或者扩展的版本字符串。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>extension</parameter></term>
+ <listitem>
+ <para>
+ 可选的扩展名称。
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ 如果指定了可选的 <parameter>extension</parameter>参
数，<function>phpversion</function> 会返回该扩展的版本。如果扩展未启用，或者
无相关的版本信息则会返回 &false;。
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>phpversion</function> 示例</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+// 打印输出类似 'Current PHP version: 4.1.1'
+echo 'Current PHP version: ' . phpversion();
+
+// 打印输出类似 '2.0'，如果扩展未启用则什么都不会显示
+echo phpversion('tidy');
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ <example>
+ <title><constant>PHP_VERSION_ID</constant> 示例与用法</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+// PHP_VERSION_ID自PHP 5.2.7有效，如果我们的版本, if our
+// 较低，则模拟这个常量
+if (!defined('PHP_VERSION_ID')) {
+ $version = explode('.', PHP_VERSION);
+
+ define('PHP_VERSION_ID', ($version[0] * 10000 + $version[1] * 100 +
$version[2]));
+}
+
+// PHP_VERSION_ID 定义为一个数字，版本越是新的PHP，数字越大。
+// 它用以下的表达式来定义的：
+//
+// $version_id = $major_version * 10000 + $minor_version * 100 +
$release_version;
+//
+// 现在我们可以用 PHP_VERSION_ID 来检查该PHP版本可能具有的功能
+// 使得不需要每次都用 version_compare() 来检查当前PHP版本是否支持一个功能
+//
+// 举例，在版本5.2.7之前我们可以自己定义 PHP_VERSION_* 常量。
+
+if (PHP_VERSION_ID < 50207) {
+ define('PHP_MAJOR_VERSION', $version[0]);
+ define('PHP_MINOR_VERSION', $version[1]);
+ define('PHP_RELEASE_VERSION', $version[2]);
+
+ // 等等……
+}
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <para>
+ 本信息在预定义常量 <constant>PHP_VERSION</constant> 中同样有效。更多的
版本信息可以通过 <constant>PHP_VERSION_*</constant> 系列常量获取。
+ </para>
+ </note>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><link linkend="reserved.constants.core">PHP_VERSION
constants</link></member>
+ <member><function>version_compare</function></member>
+ <member><function>phpinfo</function></member>
+ <member><function>phpcredits</function></member>
+ <member><function>php_logo_guid</function></member>
+ <member><function>zend_version</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
+
+

Reply all

Reply to author

Forward

0 new messages