goba Sun Nov 11 07:13:02 2001 EDT
Modified files:
/phpdoc/en/functions info.xml
Log:
Moving things around, to get alphabetical order
Index: phpdoc/en/functions/info.xml
diff -u phpdoc/en/functions/info.xml:1.70 phpdoc/en/functions/info.xml:1.71
--- phpdoc/en/functions/info.xml:1.70 Sat Nov 10 16:49:36 2001
+++ phpdoc/en/functions/info.xml Sun Nov 11 07:13:02 2001
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.70 $ -->
+<!-- $Revision: 1.71 $ -->
<reference id="ref.info">
<title>PHP options & information</title>
<titleabbrev>PHP options/info</titleabbrev>
@@ -328,6 +328,229 @@
</refsect1>
</refentry>
+ <refentry id="function.get-defined-constants">
+ <refnamediv>
+ <refname>get_defined_constants</refname>
+ <refpurpose>
+ Returns an associative array with the names of all the constants
+ and their values.
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>array <function>get_defined_constants</function></funcdef>
+ <void/>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function returns the names and values of all the constants
+ currently defined. This includes those created by extensions as
+ well as those created with the <function>define</function>
+ function.
+ </para>
+ <para>
+ For example the line below
+ <informalexample>
+ <programlisting>
+print_r (get_defined_constants());
+ </programlisting>
+ </informalexample>
+ will print a list like:
+ <informalexample>
+ <programlisting>
+Array
+(
+ [E_ERROR] => 1
+ [E_WARNING] => 2
+ [E_PARSE] => 4
+ [E_NOTICE] => 8
+ [E_CORE_ERROR] => 16
+ [E_CORE_WARNING] => 32
+ [E_COMPILE_ERROR] => 64
+ [E_COMPILE_WARNING] => 128
+ [E_USER_ERROR] => 256
+ [E_USER_WARNING] => 512
+ [E_USER_NOTICE] => 1024
+ [E_ALL] => 2047
+ [TRUE] => 1
+)
+ </programlisting>
+ </informalexample>
+ </para>
+ <para>
+ See also
+ <function>get_loaded_extensions</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.get-extension-funcs">
+ <refnamediv>
+ <refname>get_extension_funcs</refname>
+ <refpurpose>
+ Returns an array with the names of the functions of a module
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>array <function>get_extension_funcs</function></funcdef>
+ <paramdef>string <parameter>module_name</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function returns the names of all the functions defined in
+ the module indicated by <parameter>module_name</parameter>.
+ </para>
+ <para>
+ For example the lines below
+ <informalexample>
+ <programlisting>
+print_r (get_extension_funcs ("xml"));
+print_r (get_extension_funcs ("gd"));
+ </programlisting>
+ </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>
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.get-included-files">
+ <refnamediv>
+ <refname>get_included_files</refname>
+ <refpurpose>
+ Returns an array with the names of included or required files
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>array <function>get_included_files</function></funcdef>
+ <void/>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Returns an array of the names of all files that have been
+ included using <function>include</function>,
+ <function>include_once</function>, <function>require</function>
+ or <function>require_once</function>.
+ </para>
+ <para>
+ Files that are included or required multiple times only show up
+ once in the returned array.
+ </para>
+ <para>
+ <example>
+ <title><function>get_included_files</function> Example</title>
+ <programlisting role="php">
+<?php
+
+include("test1.php");
+include_once("test2.php");
+require("test3.php");
+require_once("test4.php");
+
+$included_files = get_included_files();
+
+foreach($included_files as $filename) {
+ echo "$filename\n";
+}
+
+?>
+ </programlisting>
+ </example>
+ will generate the following output:
+ <informalexample>
+ <programlisting>
+test1.php
+test2.php
+test3.php
+test4.php
+ </programlisting>
+ </informalexample>
+ </para>
+ <note>
+ <para>
+ In PHP 4.0.1pl2 and previous versions
+ <function>get_included_files</function> assumed that the
+ required files ended in the extension <literal>.php</literal>;
+ other extensions would not be returned. The array returned by
+ <function>get_included_files</function> was an associative array
+ and only listed files included by <function>include</function>
+ and <function>include_once</function>.
+ </para>
+ </note>
+ <para>
+ See also: <function>include</function>,
+ <function>include_once</function>, <function>require</function>,
+ <function>require_once</function> and
+ <function>get_required_files</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.get-loaded-extensions">
+ <refnamediv>
+ <refname>get_loaded_extensions</refname>
+ <refpurpose>
+ Returns an array with the names of all modules compiled and
+ loaded
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>array <function>get_loaded_extensions</function></funcdef>
+ <void/>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function returns the names of all the modules compiled and
+ loaded in the PHP interpreter.
+ </para>
+ <para>
+ For example the line below
+ <informalexample>
+ <programlisting>
+print_r (get_loaded_extensions());
+ </programlisting>
+ </informalexample>
+ will print a list like:
+ <informalexample>
+ <programlisting>
+Array
+(
+ [0] => xml
+ [1] => wddx
+ [2] => standard
+ [3] => session
+ [4] => posix
+ [5] => pgsql
+ [6] => pcre
+ [7] => gd
+ [8] => ftp
+ [9] => db
+ [10] => Calendar
+ [11] => bcmath
+)
+ </programlisting>
+ </informalexample>
+ </para>
+ <para>
+ See also: <function>get_extension_funcs</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.get-magic-quotes-gpc">
<refnamediv>
<refname>get_magic_quotes_gpc</refname>
@@ -442,11 +665,7 @@
<function>getmypid</function>, and
<function>getlastmod</function>.
</para>
- <note>
- <simpara>
- This function is not supported on Windows systems.
- </simpara>
- </note>
+ ¬e.no.windows;
</refsect1>
</refentry>
@@ -507,42 +726,79 @@
</refsect1>
</refentry>
- <refentry id="function.getrusage">
+ <refentry id="function.get-required-files">
<refnamediv>
- <refname>getrusage</refname>
- <refpurpose>Get the current resource usages.</refpurpose>
+ <refname>get_required_files</refname>
+ <refpurpose>
+ Returns an array with the names of included or required files
+ </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>array <function>getrusage</function></funcdef>
- <paramdef>int
- <parameter><optional>who</optional></parameter>
- </paramdef>
+ <funcdef>array <function>get_required_files</function></funcdef>
+ <void/>
</funcprototype>
</funcsynopsis>
<para>
- This is an interface to getrusage(2). It returns an associative
- array containing the data returned from the system call. If who
- is 1, getrusage will be called with RUSAGE_CHILDREN.
+ As of PHP 4.0.4, this function is an alias for
+ <function>get_included_files</function>
</para>
<para>
- All entries are accessible by using their documented field names.
- <example>
- <title>Getrusage Example</title>
- <programlisting role="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>
- See your system's man page on getrusage(2) for more details.
- </para>
- </refsect1>
- </refentry>
+ In PHP 4.0.1pl2 and previous versions
+ <function>get_required_files</function> assumed that the required
+ files ended in the extension <literal>.php</literal>, other
+ extensions would not be returned. The array returned by
+ <function>get_required_files</function> was an associative array
+ and only listed files included by <function>require</function> and
+ <function>require_once</function>.
+ </para>
+ <para>
+ See also: <function>require</function>,
+ <function>require_once</function>, <function>include</function>,
+ <function>include_once</function> and
+ <function>get_included_files</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.getrusage">
+ <refnamediv>
+ <refname>getrusage</refname>
+ <refpurpose>Get the current resource usages.</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>array <function>getrusage</function></funcdef>
+ <paramdef>int
+ <parameter><optional>who</optional></parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This is an interface to getrusage(2). It returns an associative
+ array containing the data returned from the system call. If who
+ is 1, getrusage will be called with RUSAGE_CHILDREN.
+ </para>
+ <para>
+ All entries are accessible by using their documented field names.
+ <example>
+ <title>Getrusage Example</title>
+ <programlisting role="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>
+ See your system's man page on getrusage(2) for more details.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="function.ini-alter">
<refnamediv>
@@ -1486,266 +1742,6 @@
This funcionality was added in PHP 4 Beta 4.
</para>
</note>
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.get-defined-constants">
- <refnamediv>
- <refname>get_defined_constants</refname>
- <refpurpose>
- Returns an associative array with the names of all the constants
- and their values.
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>array <function>get_defined_constants</function></funcdef>
- <void/>
- </funcprototype>
- </funcsynopsis>
- <para>
- This function returns the names and values of all the constants
- currently defined. This includes those created by extensions as
- well as those created with the <function>define</function>
- function.
- </para>
- <para>
- For example the line below
- <informalexample>
- <programlisting>
-print_r (get_defined_constants());
- </programlisting>
- </informalexample>
- will print a list like:
- <informalexample>
- <programlisting>
-Array
-(
- [E_ERROR] => 1
- [E_WARNING] => 2
- [E_PARSE] => 4
- [E_NOTICE] => 8
- [E_CORE_ERROR] => 16
- [E_CORE_WARNING] => 32
- [E_COMPILE_ERROR] => 64
- [E_COMPILE_WARNING] => 128
- [E_USER_ERROR] => 256
- [E_USER_WARNING] => 512
- [E_USER_NOTICE] => 1024
- [E_ALL] => 2047
- [TRUE] => 1
-)
- </programlisting>
- </informalexample>
- </para>
- <para>
- See also
- <function>get_loaded_extensions</function>.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.get-loaded-extensions">
- <refnamediv>
- <refname>get_loaded_extensions</refname>
- <refpurpose>
- Returns an array with the names of all modules compiled and
- loaded
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>array <function>get_loaded_extensions</function></funcdef>
- <void/>
- </funcprototype>
- </funcsynopsis>
- <para>
- This function returns the names of all the modules compiled and
- loaded in the PHP interpreter.
- </para>
- <para>
- For example the line below
- <informalexample>
- <programlisting>
-print_r (get_loaded_extensions());
- </programlisting>
- </informalexample>
- will print a list like:
- <informalexample>
- <programlisting>
-Array
-(
- [0] => xml
- [1] => wddx
- [2] => standard
- [3] => session
- [4] => posix
- [5] => pgsql
- [6] => pcre
- [7] => gd
- [8] => ftp
- [9] => db
- [10] => Calendar
- [11] => bcmath
-)
- </programlisting>
- </informalexample>
- </para>
- <para>
- See also: <function>get_extension_funcs</function>.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.get-extension-funcs">
- <refnamediv>
- <refname>get_extension_funcs</refname>
- <refpurpose>
- Returns an array with the names of the functions of a module
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>array <function>get_extension_funcs</function></funcdef>
- <paramdef>string <parameter>module_name</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- <para>
- This function returns the names of all the functions defined in
- the module indicated by <parameter>module_name</parameter>.
- </para>
- <para>
- For example the lines below
- <informalexample>
- <programlisting>
-print_r (get_extension_funcs ("xml"));
-print_r (get_extension_funcs ("gd"));
- </programlisting>
- </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>
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.get-required-files">
- <refnamediv>
- <refname>get_required_files</refname>
- <refpurpose>
- Returns an array with the names of included or required files
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>array <function>get_required_files</function></funcdef>
- <void/>
- </funcprototype>
- </funcsynopsis>
- <para>
- As of PHP 4.0.4, this function is an alias for
- <function>get_included_files</function>
- </para>
- <para>
- In PHP 4.0.1pl2 and previous versions
- <function>get_required_files</function> assumed that the required
- files ended in the extension <literal>.php</literal>, other
- extensions would not be returned. The array returned by
- <function>get_required_files</function> was an associative array
- and only listed files included by <function>require</function> and
- <function>require_once</function>.
- </para>
- <para>
- See also: <function>require</function>,
- <function>require_once</function>, <function>include</function>,
- <function>include_once</function> and
- <function>get_included_files</function>.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.get-included-files">
- <refnamediv>
- <refname>get_included_files</refname>
- <refpurpose>
- Returns an array with the names of included or required files
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>array <function>get_included_files</function></funcdef>
- <void/>
- </funcprototype>
- </funcsynopsis>
- <para>
- Returns an array of the names of all files that have been
- included using <function>include</function>,
- <function>include_once</function>, <function>require</function>
- or <function>require_once</function>.
- </para>
- <para>
- Files that are included or required multiple times only show up
- once in the returned array.
- </para>
- <para>
- <example>
- <title><function>get_included_files</function> Example</title>
- <programlisting role="php">
-<?php
-
-include("test1.php");
-include_once("test2.php");
-require("test3.php");
-require_once("test4.php");
-
-$included_files = get_included_files();
-
-foreach($included_files as $filename) {
- echo "$filename\n";
-}
-
-?>
- </programlisting>
- </example>
- will generate the following output:
- <informalexample>
- <programlisting>
-test1.php
-test2.php
-test3.php
-test4.php
- </programlisting>
- </informalexample>
- </para>
- <note>
- <para>
- In PHP 4.0.1pl2 and previous versions
- <function>get_included_files</function> assumed that the
- required files ended in the extension <literal>.php</literal>;
- other extensions would not be returned. The array returned by
- <function>get_included_files</function> was an associative array
- and only listed files included by <function>include</function>
- and <function>include_once</function>.
- </para>
- </note>
- <para>
- See also: <function>include</function>,
- <function>include_once</function>, <function>require</function>,
- <function>require_once</function> and
- <function>get_required_files</function>.
</para>
</refsect1>
</refentry>
