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

- Consistency and structure

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@132049 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Derick Rethans 2003-06-16 19:33:51 +00:00
parent 74710b2968
commit 64a89e0101
24 changed files with 146 additions and 120 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
reference/info/functions/dl.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.29 -->
<refentry id="function.dl">
<refnamediv>
@ -82,7 +82,7 @@ if (!extension_loaded('gd')) {
</listitem>
</itemizedlist>
Taking into account the above, the directory then defaults to
<literal>&lt;php-install-directory&gt;/lib/php/extension/&lt;debug-or-not&gt;-&lt;zts-or-not&gt;-ZEND_MODULE_API_NO</literal>,
<literal>&lt;install-dir&gt;/lib/php/extensions/ &lt;debug-or-not&gt;-&lt;zts-or-not&gt;-ZEND_MODULE_API_NO</literal>,
e.g.
<filename>/usr/local/php/lib/php/extensions/debug-non-zts-20010901</filename>
or

20
reference/info/functions/get-defined-constants.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.71 -->
<refentry id="function.get-defined-constants">
<refnamediv>
@ -22,17 +22,19 @@
function.
</para>
<para>
For example the line below
For example the line below:
<informalexample>
<programlisting>
<programlisting role="php">
<![CDATA[
print_r (get_defined_constants());
<?php
print_r(get_defined_constants());
?>
]]>
</programlisting>
</informalexample>
will print a list like:
<informalexample>
<programlisting>
<para>
will print a list like:
</para>
<screen>
<![CDATA[
Array
(
@ -51,7 +53,7 @@ Array
[TRUE] => 1
)
]]>
</programlisting>
</screen>
</informalexample>
</para>
<para>

14
reference/info/functions/get-extension-funcs.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.71 -->
<refentry id="function.get-extension-funcs">
<refnamediv>
@ -23,13 +23,17 @@
<informalexample>
<programlisting>
<![CDATA[
print_r (get_extension_funcs ("xml"));
print_r (get_extension_funcs ("gd"));
<?php
print_r(get_extension_funcs("xml"));
print_r(get_extension_funcs("gd"));
?>
]]>
</programlisting>
<para>
will print a list of the functions in the modules
<varname>xml</varname> and <varname>gd</varname> respectively.
</para>
</informalexample>
will print a list of the functions in the modules
<varname>xml</varname> and <varname>gd</varname> respectively.
</para>
<para>
See also: <function>get_loaded_extensions</function>

4
reference/info/functions/get-include-path.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.get-include-path">
<refnamediv>
<refname>get_include_path</refname>
@ -19,7 +19,7 @@
</simpara>
<para>
<example>
<title>Example use of <function>get_include_path</function></title>
<title><function>get_include_path</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

16
reference/info/functions/get-included-files.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.71 -->
<refentry id="function.get-included-files">
<refnamediv>
@ -32,7 +32,7 @@
</note>
<para>
<example>
<title><function>get_included_files</function> Example</title>
<title><function>get_included_files</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -51,18 +51,18 @@ foreach($included_files as $filename) {
?>
]]>
</programlisting>
</example>
will generate the following output:
<informalexample>
<programlisting>
<para>
will generate the following output:
</para>
<screen>
<![CDATA[
test1.php
test2.php
test3.php
test4.php
]]>
</programlisting>
</informalexample>
</screen>
</example>
</para>
<note>
<para>

14
reference/info/functions/get-loaded-extensions.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.71 -->
<refentry id="function.get-loaded-extensions">
<refnamediv>
@ -25,14 +25,14 @@
<programlisting>
<![CDATA[
<?php
print_r (get_loaded_extensions());
print_r(get_loaded_extensions());
?>
]]>
</programlisting>
</informalexample>
will print a list like:
<informalexample>
<programlisting>
<para>
will print a list like:
</para>
<screen>
<![CDATA[
Array
(
@ -50,7 +50,7 @@ Array
[11] => bcmath
)
]]>
</programlisting>
</screen>
</informalexample>
</para>
<para>

4
reference/info/functions/get-magic-quotes-gpc.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.2 -->
<refentry id="function.get-magic-quotes-gpc">
<refnamediv>
@ -36,7 +36,7 @@
</simpara>
<para>
<example>
<title>Example use of <function>get_magic_quotes_gpc</function></title>
<title><function>get_magic_quotes_gpc</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

8
reference/info/functions/getenv.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.2 -->
<refentry id="function.getenv">
<refnamediv>
@ -16,9 +16,11 @@
Returns the value of the environment variable
<parameter>varname</parameter>, or &false; on an error.
<informalexample>
<programlisting>
<programlisting role="php">
<![CDATA[
<?php
$ip = getenv ("REMOTE_ADDR"); // get the ip number of the user
?>
]]>
</programlisting>
</informalexample>
@ -29,6 +31,8 @@ $ip = getenv ("REMOTE_ADDR"); // get the ip number of the user
mean by taking a look at the <ulink url="&url.cgispecs;">CGI
specification</ulink>, specifically the <ulink
url="&url.cgispec;">page on environmental variables</ulink>.
</para>
<para>
<note>
<para>
This function does not work in ISAPI mode.

6
reference/info/functions/getlastmod.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.2 -->
<refentry id="function.getlastmod">
<refnamediv>
@ -16,8 +16,10 @@
Returns the time of the last modification of the current
page. The value returned is a Unix timestamp, suitable for
feeding to <function>date</function>. Returns &false; on error.
</para>
<para>
<example>
<title>getlastmod() example</title>
<title><function>getlastmod</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

11
reference/info/functions/getopt.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.getopt">
<refnamediv>
<refname>getopt</refname>
@ -15,10 +15,15 @@
Returns an associative array of option / argument pairs based on the
options format specified in <parameter>options</parameter>, or &false;
on an error.
</para>
<para>
<informalexample>
<programlisting>
<![CDATA[
$options = getopt("f:hp:"); // parse the command line ($GLOBALS['argv'])
<?php
// parse the command line ($GLOBALS['argv'])
$options = getopt("f:hp:");
?>
]]>
</programlisting>
</informalexample>
@ -36,7 +41,7 @@ $options = getopt("f:hp:"); // parse the command line ($GLOBALS['argv'])
This function will return an array of option / argument pairs. If an
option does not have an argument, the value will be set to &false;.
</para>
<note><simpara>This function is currently not available on Windows</simpara></note>
&note.no-windows;
</refsect1>
</refentry>

8
reference/info/functions/getrusage.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.2 -->
<refentry id="function.getrusage">
<refnamediv>
@ -19,15 +19,19 @@
</para>
<para>
All entries are accessible by using their documented field names.
</para>
<para>
<example>
<title>Getrusage Example</title>
<title><function>getrusage</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dat = getrusage();
echo $dat["ru_nswap"]; # number of swaps
echo $dat["ru_majflt"]; # number of page faults
echo $dat["ru_utime.tv_sec"]; # user time used (seconds)
echo $dat["ru_utime.tv_usec"]; # user time used (microseconds)
?>
]]>
</programlisting>
</example>

3
reference/info/functions/ini-get-all.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.23 -->
<refentry id="function.ini-get-all">
<refnamediv>
@ -28,7 +28,6 @@
for information on what access levels mean.
</para>
<note>
<title>Access level note:</title>
<para>
It's possible for a directive to have multiple access levels, which is
why <literal>access</literal> shows the appropriate bitmask values.

39
reference/info/functions/php-ini-scanned-files.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.php-ini-scanned-files">
<refnamediv>
<refname>php_ini_scanned_files</refname>
@ -12,24 +12,25 @@
<void/>
</methodsynopsis>
<simpara>
<function>php_ini_scanned_files</function> returns a comma-separated
list of configuration files parsed after &php.ini;. These files are found
in a directory defined by the <literal>--with-config-file-scan-dir</literal>.
option which is set during compilation.
<function>php_ini_scanned_files</function> returns a comma-separated
list of configuration files parsed after &php.ini;. These files are
found in a directory defined by the
<literal>--with-config-file-scan-dir</literal>. option which is set
during compilation.
</simpara>
<simpara>
Returns a comma-separated string of .ini files on success. If
the directive <literal>--with-config-files-scan-dir</literal> wasn't
set, &false; is returned. If it was set and the directory was empty,
an empty string is returned. If a file is unreconizable, the file
will still make it into the returned string but a PHP error will
also result. This PHP error will be seen both at compile time and
while using <function>php_ini_scanned_files</function>.
Returns a comma-separated string of .ini files on success. If the
directive <literal>--with-config-files-scan-dir</literal> wasn't set,
&false; is returned. If it was set and the directory was empty, an
empty string is returned. If a file is unreconizable, the file will
still make it into the returned string but a PHP error will also result.
This PHP error will be seen both at compile time and while using
<function>php_ini_scanned_files</function>.
</simpara>
<simpara>
The returned configuration files also include the path as declared
in the <literal>--with-config-file-scan-dir</literal> directive. Also,
each comma is followed by a newline.
The returned configuration files also include the path as declared in
the <literal>--with-config-file-scan-dir</literal> directive. Also, each
comma is followed by a newline.
</simpara>
<para>
<example>
@ -37,13 +38,10 @@
<programlisting role="php">
<![CDATA[
<?php
if ($filelist = php_ini_scanned_files()) {
if (strlen($filelist) > 0) {
$files = explode(',', $filelist);
foreach ($files as $file) {
echo "<li>" . trim($file) . "</li>\n";
}
@ -55,8 +53,7 @@ if ($filelist = php_ini_scanned_files()) {
</example>
</para>
<simpara>
See also <function>ini_set</function>
and <function>phpinfo</function>.
See also <function>ini_set</function> and <function>phpinfo</function>.
</simpara>
</refsect1>
</refentry>

11
reference/info/functions/php-logo-guid.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.3 -->
<refentry id="function.php-logo-guid">
<refnamediv>
@ -12,11 +12,10 @@
<type>string</type><methodname>php_logo_guid</methodname>
<void/>
</methodsynopsis>
<note>
<para>
This functionality was added in PHP 4.0.0.
</para>
</note>
<para>
This function returns the ID which can be used to display the PHP logo
using the built-in image.
</para>
<para>
See also
<function>phpinfo</function>,

4
reference/info/functions/php-sapi-name.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.25 -->
<refentry id="function.php-sapi-name">
<refnamediv>
@ -22,7 +22,7 @@
</simpara>
<para>
<example>
<title><function>php_sapi_name</function> Example</title>
<title><function>php_sapi_name</function> example</title>
<programlisting role="php">
<![CDATA[
$sapi_type = php_sapi_name();

4
reference/info/functions/php-uname.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.7 -->
<refentry id="function.php-uname">
<refnamediv>
@ -20,7 +20,7 @@
</simpara>
<para>
<example>
<title><function>php_uname</function> Example</title>
<title><function>php_uname</function> example</title>
<programlisting role="php">
<![CDATA[
if (substr(php_uname(), 0, 7) == "Windows") {

18
reference/info/functions/phpcredits.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.18 -->
<refentry id="function.phpcredits">
<refnamediv>
@ -20,17 +20,23 @@
To generate a custom credits page, you may want to use the
<parameter>flag</parameter> parameter. For example to print
the general credits, you will use somewhere in your code:
</para>
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
...
<?php
phpcredits(CREDITS_GENERAL);
...
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
And if you want to print the core developers and the
documentation group, in a page of its own, you will use:
</para>
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
@ -40,8 +46,12 @@ phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
]]>
</programlisting>
</informalexample>
</para>
<para>
And if you feel like embedding all the credits in your page, then
code like the one below will do it:
</para>
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
@ -61,8 +71,6 @@ phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
</programlisting>
</informalexample>
</para>
<para>
</para>
<para>
<table>
<title>Pre-defined <function>phpcredits</function> flags</title>

5
reference/info/functions/phpinfo.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.2 -->
<refentry id="function.phpinfo">
<refnamediv>
@ -37,7 +37,8 @@
One can also combine the respective constants or bitwise values
together with the <link
linkend="language.operators.bitwise">or</link> operator.
</para>
<para>
<table>
<title><function>phpinfo</function> options</title>
<tgroup cols="3">

40
reference/info/functions/putenv.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.2 -->
<refentry id="function.putenv">
<refnamediv>
@ -13,29 +13,27 @@
<methodparam><type>string</type><parameter>setting</parameter></methodparam>
</methodsynopsis>
<para>
Adds <parameter>setting</parameter> to the server environment.
The environment variable will only exist for the duration of the
current request. At the end of the request the environment is
restored to its original state.
Adds <parameter>setting</parameter> to the server environment. The
environment variable will only exist for the duration of the current
request. At the end of the request the environment is restored to its
original state.
</para>
<para>
Setting certain environment variables may be a potential security
breach. The <literal>safe_mode_allowed_env_vars</literal>
directive contains a comma-delimited list of prefixes. In Safe
Mode, the user may only alter environment variables whose names
begin with the prefixes supplied by this directive. By default,
users will only be able to set environment variables that begin
with <literal>PHP_</literal>
(e.g. <literal>PHP_FOO=BAR</literal>). Note: if this directive is
empty, PHP will let the user modify ANY environment variable!
Setting certain environment variables may be a potential security breach.
The <literal>safe_mode_allowed_env_vars</literal> directive contains a
comma-delimited list of prefixes. In Safe Mode, the user may only alter
environment variables whose names begin with the prefixes supplied by
this directive. By default, users will only be able to set environment
variables that begin with <literal>PHP_</literal> (e.g.
<literal>PHP_FOO=BAR</literal>). Note: if this directive is empty, PHP
will let the user modify ANY environment variable!
</para>
<para>
The <literal>safe_mode_protected_env_vars</literal> directive
contains a comma-delimited list of environment variables, that
the end user won't be able to change using
<function>putenv</function>. These variables will be protected
even if <literal>safe_mode_allowed_env_vars</literal> is set to
allow to change them.
The <literal>safe_mode_protected_env_vars</literal> directive contains a
comma-delimited list of environment variables, that the end user won't be
able to change using <function>putenv</function>. These variables will
be protected even if <literal>safe_mode_allowed_env_vars</literal> is set
to allow to change them.
</para>
<warning>
<para>
@ -45,7 +43,7 @@
</warning>
<para>
<example>
<title>Setting an Environment Variable</title>
<title>Setting an environment variable</title>
<programlisting role="php">
<![CDATA[
putenv ("UNIQID=$uniqid");

4
reference/info/functions/restore-include-path.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.restore-include-path">
<refnamediv>
<refname>restore_include_path</refname>
@ -20,7 +20,7 @@
</simpara>
<para>
<example>
<title>Example use of <function>restore_include_path</function></title>
<title><function>restore_include_path</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

4
reference/info/functions/set-include-path.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.set-include-path">
<refnamediv>
<refname>set_include_path</refname>
@ -21,7 +21,7 @@
</simpara>
<para>
<example>
<title>Example use of <function>set_include_path</function></title>
<title><function>set_include_path</function> example</title>
<programlisting role="php">
<![CDATA[
<?php

6
reference/info/functions/version-compare.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.2 -->
<refentry id="function.version-compare">
<refnamediv>
@ -60,15 +60,17 @@
</para>
<para>
<example>
<title><function>version_compare</function> Example</title>
<title><function>version_compare</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// prints -1
echo version_compare("4.0.4", "4.0.6");
// these all print 1
echo version_compare("4.0.4", "4.0.6", "<");
echo version_compare("4.0.6", "4.0.6", "eq");
?>
]]>
</programlisting>
</example>

11
reference/info/functions/zend-logo-guid.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.39 -->
<refentry id="function.zend-logo-guid">
<refnamediv>
@ -12,11 +12,10 @@
<type>string</type><methodname>zend_logo_guid</methodname>
<void/>
</methodsynopsis>
<note>
<para>
This functionality was added in PHP 4.0.0.
</para>
</note>
<para>
This function returns the ID which can be used to display the Zend logo
using the built-in image.
</para>
</refsect1>
</refentry>

8
reference/info/functions/zend-version.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.11 -->
<refentry id="function.zend-version">
<refnamediv>
@ -14,9 +14,11 @@
</methodsynopsis>
<para>
Returns a string containing the version of the currently running
PHP parser.
Zend Engine.
</para>
<para>
<example>
<title><function>zend_version</function> Example</title>
<title><function>zend_version</function> example</title>
<programlisting role="php">
<![CDATA[
// prints e.g. 'Zend engine version: 1.0.4'