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

Miscellaneous updates. This commit spans en/language/predefined/variables/* and

Browse source 
includes updates for content, markup, and see also links.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@257948 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2008-04-20 07:50:01 +00:00
parent d126c9f976
commit cd4e1f61d5
11 changed files with 125 additions and 179 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
language/predefined/variables/argc.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.argc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -15,13 +15,14 @@
</para>
<note>
<simpara>
The script's filename is always passed as an argument to the script.
The script's filename is always passed as an argument to the script, therefore
the minimum value of <varname>$argc</varname> is <literal>1</literal>.
</simpara>
</note>
<note>
<simpara>
This variable is only available when <link linkend="ini.register-argc-argv">register_argc_argv</link>
is enabled in <filename>php.ini</filename>.
is enabled.
</simpara>
</note>
</refsect1>

7
language/predefined/variables/argv.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.argv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -15,13 +15,14 @@
</para>
<note>
<simpara>
The first argument is always the current script's filename.
The first argument is always the current script's filename, therefore
<varname>$argv[0]</varname> is the script's name.
</simpara>
</note>
<note>
<simpara>
This variable is only available when <link linkend="ini.register-argc-argv">register_argc_argv</link>
is enabled in <filename>php.ini</filename>.
is enabled.
</simpara>
</note>
</refsect1>

27
language/predefined/variables/cookie.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.cookies" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>$_COOKIE</refname>
<refname>$HTTP_COOKIE_VARS</refname>
<refname>$HTTP_COOKIE_VARS [deprecated]</refname>
<refpurpose>HTTP Cookies</refpurpose>
</refnamediv>
@ -17,22 +17,11 @@
<simpara>
<varname>$HTTP_COOKIE_VARS</varname> contains the same initial
information, but is not a superglobal. (Note that
<varname>$HTTP_COOKIE_VARS</varname> and <varname>$_COOKIE</varname>
information, but is not a <link linkend="language.variables.superglobals">superglobal</link>.
(Note that <varname>$HTTP_COOKIE_VARS</varname> and <varname>$_COOKIE</varname>
are different variables and that PHP handles them as such)
</simpara>
<simpara>
If the <link
linkend="ini.register-globals">register_globals</link> directive
is set, then these variables will also be made available in the
global scope of the script; i.e., separate from the
<varname>$_COOKIE</varname> and <varname>$HTTP_COOKIE_VARS</varname>
arrays. For related information, see the security chapter titled
<link linkend="security.globals">Using Register Globals</link>.
These individual globals are not superglobals.
</simpara>
</refsect1>
@ -51,9 +40,8 @@
<row>
<entry>4.1.0</entry>
<entry>
Introduced <varname>$_COOKIE</varname>.
Note that the deprecated <varname>$HTTP_COOKIE_VARS</varname>
did exist previously.
Introduced <varname>$_COOKIE</varname> that deprecated
<varname>$HTTP_COOKIE_VARS</varname>.
</entry>
</row>
</tbody>
@ -96,8 +84,9 @@ Hello Hannes!
&reftitle.seealso;
<para>
<simplelist>
<member>setcookie</member>
<member><function>setcookie</function></member>
<member><link linkend="language.variables.external">Handling external variables</link></member>
<member><link linkend="book.filter">The filter extension</link></member>
</simplelist>
</para>
</refsect1>

25
language/predefined/variables/env.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.environment" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>$_ENV</refname>
<refname>$HTTP_ENV_VARS</refname>
<refname>$HTTP_ENV_VARS [deprecated]</refname>
<refpurpose>Environment variables</refpurpose>
</refnamediv>
@ -32,22 +32,11 @@
<simpara>
<varname>$HTTP_ENV_VARS</varname> contains the same initial
information, but is not a superglobal. (Note that
<varname>$HTTP_ENV_VARS</varname> and <varname>$_ENV</varname>
information, but is not a <link linkend="language.variables.superglobals">superglobal</link>.
(Note that <varname>$HTTP_ENV_VARS</varname> and <varname>$_ENV</varname>
are different variables and that PHP handles them as such)
</simpara>
<simpara>
If the <link
linkend="ini.register-globals">register_globals</link> directive
is set, then these variables will also be made available in the
global scope of the script; i.e., separate from the
<varname>$_ENV</varname> and <varname>$HTTP_ENV_VARS</varname>
arrays. For related information, see the security chapter titled
<link linkend="security.globals">Using Register Globals</link>.
These individual globals are not superglobals.
</simpara>
</refsect1>
@ -66,9 +55,8 @@
<row>
<entry>4.1.0</entry>
<entry>
Introduced <varname>$_ENV</varname>.
Note that the deprecated <varname>$HTTP_ENV_VARS</varname>
did exist previously.
Introduced <varname>$_ENV</varname> that deprecated
<varname>$HTTP_ENV_VARS</varname>.
</entry>
</row>
</tbody>
@ -112,6 +100,7 @@ My username is bjori!
<para>
<simplelist>
<member><function>getenv</function></member>
<member><link linkend="book.filter">The filter extension</link></member>
</simplelist>
</para>
</refsect1>

24
language/predefined/variables/files.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.files" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>$_FILES</refname>
<refname>$HTTP_POST_FILES</refname>
<refname>$HTTP_POST_FILES [deprecated]</refname>
<refpurpose>HTTP File Upload variables</refpurpose>
</refnamediv>
@ -17,22 +17,11 @@
<simpara>
<varname>$HTTP_POST_FILES</varname> contains the same initial
information, but is not a superglobal. (Note that
<varname>$HTTP_POST_FILES</varname> and <varname>$_FILES</varname>
information, but is not a <link linkend="language.variables.superglobals">superglobal</link>.
(Note that <varname>$HTTP_POST_FILES</varname> and <varname>$_FILES</varname>
are different variables and that PHP handles them as such)
</simpara>
<simpara>
If the <link
linkend="ini.register-globals">register_globals</link> directive
is set, then these variables will also be made available in the
global scope of the script; i.e., separate from the
<varname>$_FILES</varname> and <varname>$HTTP_POST_FILES</varname>
arrays. For related information, see the security chapter titled
<link linkend="security.globals">Using Register Globals</link>.
These individual globals are not superglobals.
</simpara>
</refsect1>
@ -51,9 +40,8 @@
<row>
<entry>4.1.0</entry>
<entry>
Introduced <varname>$_FILES</varname>.
Note that the deprecated <varname>$HTTP_POST_FILES</varname>
did exist previously.
Introduced <varname>$_FILES</varname> that deprecated
<varname>$HTTP_POST_FILES</varname>.
</entry>
</row>
</tbody>

25
language/predefined/variables/get.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>$_GET</refname>
<refname>$HTTP_GET_VARS</refname>
<refname>$HTTP_GET_VARS [deprecated]</refname>
<refpurpose>HTTP GET variables</refpurpose>
</refnamediv>
@ -17,22 +17,11 @@
<simpara>
<varname>$HTTP_GET_VARS</varname> contains the same initial
information, but is not a superglobal. (Note that
<varname>$HTTP_GET_VARS</varname> and <varname>$_GET</varname>
information, but is not a <link linkend="language.variables.superglobals">superglobal</link>.
(Note that <varname>$HTTP_GET_VARS</varname> and <varname>$_GET</varname>
are different variables and that PHP handles them as such)
</simpara>
<simpara>
If the <link
linkend="ini.register-globals">register_globals</link> directive
is set, then these variables will also be made available in the
global scope of the script; i.e., separate from the
<varname>$_GET</varname> and <varname>$HTTP_GET_VARS</varname>
arrays. For related information, see the security chapter titled
<link linkend="security.globals">Using Register Globals</link>.
These individual globals are not superglobals.
</simpara>
</refsect1>
@ -51,9 +40,8 @@
<row>
<entry>4.1.0</entry>
<entry>
Introduced <varname>$_GET</varname>.
Note that the deprecated <varname>$HTTP_GET_VARS</varname>
did exist previously.
Introduced <varname>$_GET</varname> that deprecated
<varname>$HTTP_GET_VARS</varname>.
</entry>
</row>
</tbody>
@ -97,6 +85,7 @@ Hello Hannes!
<para>
<simplelist>
<member><link linkend="language.variables.external">Handling external variables</link></member>
<member><link linkend="book.filter">The filter extension</link></member>
</simplelist>
</para>
</refsect1>

13
language/predefined/variables/globals.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="variable.globals" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xml:id="reserved.variables.globals" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>$GLOBALS</refname>
<refpurpose>References all variables available in global scope</refpurpose>
@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<para>
An associative array containing references to all variables which
An associative <type>array</type> containing references to all variables which
are currently defined in the global scope of the script. The
variable names are the keys of the array.
</para>
@ -50,6 +50,13 @@ $foo in current scope: local variable
<refsect1 role="notes">
&reftitle.notes;
&note.is-superglobal;
<note>
<title>Variable availability</title>
<para>
Unlike all of the other <link linkend="language.variables.superglobals">superglobals</link>,
<varname>$GLOBALS</varname> has essentially always been available in PHP.
</para>
</note>
</refsect1>
</refentry>

25
language/predefined/variables/post.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.post" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>$_POST</refname>
<refname>$HTTP_POST_VARS</refname>
<refname>$HTTP_POST_VARS [deprecated]</refname>
<refpurpose>HTTP POST variables</refpurpose>
</refnamediv>
@ -17,22 +17,11 @@
<simpara>
<varname>$HTTP_POST_VARS</varname> contains the same initial
information, but is not a superglobal. (Note that
<varname>$HTTP_POST_VARS</varname> and <varname>$_POST</varname>
information, but is not a <link linkend="language.variables.superglobals">superglobal</link>.
(Note that <varname>$HTTP_POST_VARS</varname> and <varname>$_POST</varname>
are different variables and that PHP handles them as such)
</simpara>
<simpara>
If the <link
linkend="ini.register-globals">register_globals</link> directive
is set, then these variables will also be made available in the
global scope of the script; i.e., separate from the
<varname>$_POST</varname> and <varname>$HTTP_POST_VARS</varname>
arrays. For related information, see the security chapter titled
<link linkend="security.globals">Using Register Globals</link>.
These individual globals are not superglobals.
</simpara>
</refsect1>
@ -51,9 +40,8 @@
<row>
<entry>4.1.0</entry>
<entry>
Introduced <varname>$_POST</varname>.
Note that the deprecated <varname>$HTTP_POST_VARS</varname>
did exist previously.
Introduced <varname>$_POST</varname> that deprecated
<varname>$HTTP_POST_VARS</varname>.
</entry>
</row>
</tbody>
@ -97,6 +85,7 @@ Hello Hannes!
<para>
<simplelist>
<member><link linkend="language.variables.external">Handling external variables</link></member>
<member><link linkend="book.filter">The filter extension</link></member>
</simplelist>
</para>
</refsect1>

70
language/predefined/variables/request.xml
View file

@ -1,47 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.request" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>$_REQUEST</refname>
<refpurpose>Request variables</refpurpose>
<refpurpose>HTTP Request variables</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
An associative array consisting of the contents of
<varname>$_GET</varname>, <varname>$_POST</varname>,
and <varname>$_COOKIE</varname>.
An associative <type>array</type> that by default contains the contents of
<link linkend="reserved.variables.get">$_GET</link>,
<link linkend="reserved.variables.post">$_POST</link>&listendand;
<link linkend="reserved.variables.cookies">$_COOKIE</link>.
</para>
<simpara>
Variables provided to the script via the GET, POST, and COOKIE input
mechanisms, and which therefore cannot be trusted. The presence and
order of variable inclusion in this array is defined according to the
PHP <link linkend="ini.variables-order">variables_order</link>
configuration directive. This array has no direct analogue in versions
of PHP prior to 4.1.0.
</simpara>
<simpara>
When running on the <link linkend="features.commandline">command line
</link>, this will <emphasis>not</emphasis> include the
<varname>argv</varname> and <varname>argc</varname> entries; these are
present in the <varname>$_SERVER</varname> array.
</simpara>
<simpara>
If the <link
linkend="ini.register-globals">register_globals</link> directive
is set, then these variables will also be made available in the
global scope of the script; i.e., separate from the
<varname>$_REQUEST</varname> array. For related information, see
the security chapter titled <link
linkend="security.globals">Using Register
Globals</link>. These individual globals are not superglobals.
</simpara>
</refsect1>
@ -57,11 +30,18 @@
</row>
</thead>
<tbody>
<row>
<entry>5.3.0</entry>
<entry>
Introduced <link linkend="ini.request-order">request_order</link>.
This directive affects the contents of <varname>$_REQUEST</varname>.
</entry>
</row>
<row>
<entry>4.3.0</entry>
<entry>
<varname>$_FILES</varname> information was removed from
<varname>$_REQUEST</varname>.
<link linkend="reserved.variables.files">$_FILES</link> information
was removed from <varname>$_REQUEST</varname>.
</entry>
</row>
<row>
@ -79,6 +59,25 @@
<refsect1 role="notes">
&reftitle.notes;
&note.is-superglobal;
<note>
<para>
When running on the <link linkend="features.commandline">command line
</link>, this will <emphasis>not</emphasis> include the
<link linkend="reserved.variables.argv">argv</link> and
<link linkend="reserved.variables.argc">argc</link> entries; these are
present in the <link linkend="reserved.variables.server">$_SERVER</link>
<type>array</type>.
</para>
</note>
<note>
<para>
Variables provided to the script via the GET, POST, and COOKIE input
mechanisms, and which therefore cannot be trusted. The presence and
order of variable inclusion in this array is defined according to the
PHP <link linkend="ini.variables-order">variables_order</link>
configuration directive.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
@ -86,6 +85,7 @@
<simplelist>
<member><function>import_request_variables</function></member>
<member><link linkend="language.variables.external">Handling external variables</link></member>
<member><link linkend="book.filter">The filter extension</link></member>
</simplelist>
</refsect1>

46
language/predefined/variables/server.xml
View file

@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.server" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>$_SERVER</refname>
<refname>$HTTP_SERVER_VARS</refname>
<refpurpose>Server and execution enviroment information</refpurpose>
<refname>$HTTP_SERVER_VARS [deprecated]</refname>
<refpurpose>Server and execution environment information</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -23,26 +23,16 @@
<simpara>
<varname>$HTTP_SERVER_VARS</varname> contains the same initial
information, but is not a superglobal. (Note that
<varname>$HTTP_SERVER_VARS</varname> and <varname>$_SERVER</varname>
information, but is not a <link linkend="language.variables.superglobals">superglobal</link>.
(Note that <varname>$HTTP_SERVER_VARS</varname> and <varname>$_SERVER</varname>
are different variables and that PHP handles them as such)
</simpara>
<simpara>
If the <link
linkend="ini.register-globals">register_globals</link> directive
is set, then these variables will also be made available in the
global scope of the script; i.e., separate from the
<varname>$_SERVER</varname> and <varname>$HTTP_SERVER_VARS</varname>
arrays. For related information, see the security chapter titled
<link linkend="security.globals">Using Register Globals</link>.
These individual globals are not superglobals.
</simpara>
<simpara>
You may or may not find any of the following elements in
$_SERVER. Note that few, if any, of these will be available (or
indeed have any meaning) if running PHP on the command line.
<varname>$_SERVER</varname>. Note that few, if any, of these will be
available (or indeed have any meaning) if running PHP on the
<link linkend="features.commandline">command line</link>.
</simpara>
<para>
@ -68,7 +58,7 @@
</varlistentry>
<varlistentry>
<term>'<varname>argv</varname>'</term>
<term>'<link linkend="reserved.variables.argv">$argv</link>'</term>
<listitem>
<simpara>
Array of arguments passed to the script. When the script is
@ -80,7 +70,7 @@
</varlistentry>
<varlistentry>
<term>'<varname>argc</varname>'</term>
<term>'<link linkend="reserved.variables.argc">$argc</link>'</term>
<listitem>
<simpara>
Contains the number of command line parameters passed to the
@ -497,9 +487,8 @@
<row>
<entry>4.1.0</entry>
<entry>
Introduced <varname>$_SERVER</varname>.
Note that the deprecated <varname>$HTTP_SERVER_VARS</varname>
did exist previously.
Introduced <varname>$_SERVER</varname> that the deprecated
<varname>$HTTP_SERVER_VARS</varname>.
</entry>
</row>
</tbody>
@ -534,7 +523,16 @@ www.example.com
&reftitle.notes;
&note.is-superglobal;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="book.filter">The filter extension</link></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
language/predefined/variables/session.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="reserved.variables.session" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>$_SESSION</refname>
<refname>$HTTP_SESSION_VARS</refname>
<refname>$HTTP_SESSION_VARS [deprecated]</refname>
<refpurpose>Session variables</refpurpose>
</refnamediv>
@ -19,25 +19,12 @@
<simpara>
<varname>$HTTP_SESSION_VARS</varname> contains the same initial
information, but is not a superglobal. (Note that
<varname>$HTTP_SESSION_VARS</varname> and <varname>$_SESSION</varname>
information, but is not a <link linkend="language.variables.superglobals">superglobal</link>.
(Note that <varname>$HTTP_SESSION_VARS</varname> and <varname>$_SESSION</varname>
are different variables and that PHP handles them as such)
</simpara>
<simpara>
If the <link
linkend="ini.register-globals">register_globals</link> directive
is set, then these variables will also be made available in the
global scope of the script; i.e., separate from the
<varname>$_SESSION</varname> and <varname>$HTTP_SESSION_VARS</varname>
arrays. For related information, see the security chapter titled
<link linkend="security.globals">Using Register Globals</link>.
These individual globals are not superglobals.
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
@ -53,9 +40,8 @@
<row>
<entry>4.1.0</entry>
<entry>
Introduced <varname>$_SESSION</varname>.
Note that the deprecated <varname>$HTTP_SESSION_VARS</varname>
did exist previously.
Introduced <varname>$_SESSION</varname> that the deprecated
<varname>$HTTP_SESSION_VARS</varname>.
</entry>
</row>
</tbody>
@ -69,6 +55,15 @@
&note.is-superglobal;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>session_start</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file