 |
 |
 |
 |
|
|
Date: 08/31/00
- Next message: Martin Kraemer: "[PHP-DOC] cvs: phpdoc / configure.in"
- Previous message: Luca Perugini: "[PHP-DOC] cvs: phpdoc /it/functions imap.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
perugini Thu Aug 31 09:42:29 2000 EDT
Modified files:
/phpdoc/it/functions info.xml
Log:
Sync with en tree.
Index: phpdoc/it/functions/info.xml
diff -u phpdoc/it/functions/info.xml:1.7 phpdoc/it/functions/info.xml:1.8
--- phpdoc/it/functions/info.xml:1.7 Sun Jul 16 09:24:53 2000
+++ phpdoc/it/functions/info.xml Thu Aug 31 09:42:29 2000
@@ -1,7 +1,130 @@
<reference id="ref.info">
<title>PHP options & information</title>
<titleabbrev>PHP options/info</titleabbrev>
+
+ <refentry id="function.assert">
+ <refnamediv>
+ <refname>assert</refname>
+ <refpurpose>Checks if assertion is false</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>assert</function></funcdef>
+ <paramdef>string|bool <parameter>assertion</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ <function>assert</function> will check the given
+ <parameter>assertion</parameter> and take appropriate
+ action if its result is <literal>false</literal>.
+ </para>
+ <para>
+ If the <parameter>assertion</parameter> is given as a string it
+ will be evaluated as PHP code by <function>assert</function>.
+ The advantages of a string <parameter>assertion</parameter>
+ are less overhead when assertion checking is off and messages
+ containing the <parameter>assertion</parameter> expression when
+ an assertion failes.
+ </para>
+ <para>
+ Assertion should be used as a debugging feature only. You may
+ use them for sanity-checks that test for conditions that should
+ always be true and that indicate some programming errors if not
+ or to check for the presence of certain features like extension
+ functions or certain system limits and features.
+ </para>
+ <para>
+ Assertions should not be used for normal runtime operations
+ like input parameter checks. As a rule of thumb your code
+ should always be able to work correct if assertion checking
+ is not activated.
+ </para>
+ <para>
+ The behavior of <function>assert</function> may be configured
+ by <function>assert_options</function> or by .ini-settings
+ described in that functions manual page.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="function.assert_options">
+ <refnamediv>
+ <refname>assert-options</refname>
+ <refpurpose>Set/get the various assert flags</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>mixed <function>assert_options</function></funcdef>
+ <paramdef>int <parameter>what</parameter></paramdef>
+ <paramdef>mixed
+ <parameter><optional>value</optional></parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Using <function>assert_options</function> you may set the various
+ <function>assert</function> control options or just query their
+ current settings.
+ </para>
+ <table>
+ <title>assert options</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>option</entry>
+ <entry>ini-parameter</entry>
+ <entry>default</entry>
+ <entry>description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>ASSERT_ACTIVE</entry>
+ <entry>assert.active</entry>
+ <entry>1</entry>
+ <entry>enable <function>assert</function> evaluation</entry>
+ </row>
+ <row>
+ <entry>ASSERT_WARNING</entry>
+ <entry>assert.warning</entry>
+ <entry>1</entry>
+ <entry>issue a PHP warning for each failed assertion</entry>
+ </row>
+ <row>
+ <entry>ASSERT_BAIL</entry>
+ <entry>assert.bail</entry>
+ <entry>0</entry>
+ <entry>terminate execution on failed assertions</entry>
+ </row>
+ <row>
+ <entry>ASSERT_QUIET_EVAL</entry>
+ <entry>assert.quiet_eval</entry>
+ <entry>0</entry>
+ <entry>
+ disable error_reporting during assertion expression
+ evaluation
+ </entry>
+ </row>
+ <row>
+ <entry>ASSERT_CALLBACK</entry>
+ <entry>assert_callback</entry>
+ <entry>(null)</entry>
+ <entry>user function to call on failed assertions</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>
+ <function>assert_options</function> will return the original
+ setting of any option or <literal>false</literal> on errors.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.error-log">
<refnamediv>
<refname>error_log</refname>
@@ -24,7 +147,7 @@
</funcsynopsis>
<para>
Sends an error message to the web server's error log, a
- <acronym>TCP</acronym> port or to a file. The first parameter,
+ <acronym>TCP</acronym> port or to a file. The first parameter,
<parameter>message</parameter>, is the error message that should
be logged. The second parameter,
<parameter>message_type</parameter> says where the message should
@@ -33,49 +156,50 @@
<title><function>error_log</function> log types</title>
<tgroup cols="2">
<tbody>
- <row>
- <entry>0</entry>
- <entry>
- <parameter>message</parameter> is sent to PHP's system
- logger, using the Operating System's system logging
- mechanism or a file, depending on what the <link
- linkend="ini.error-log">error_log</link> configuration
- directive is set to.
- </entry>
- </row>
- <row>
- <entry>1</entry>
- <entry>
- <parameter>message</parameter> is sent by email to the
- address in the <parameter>destination</parameter> parameter.
- This is the only message type where the fourth parameter,
- <parameter>extra_headers</parameter> is used. This message
- type uses the same internal function as
- <function>Mail</function> does.
- </entry>
- </row>
- <row>
- <entry>2</entry>
- <entry>
- <parameter>message</parameter> is sent through the PHP
- debugging connection. This option is only available if
- <link linkend="enable-debugger">remote debugging has been
- enabled</link>. In this case, the
- <parameter>destination</parameter> parameter specifies the
- host name or IP address and optionally, port number, of the
- socket receiving the debug information.
- </entry>
- </row>
- <row>
- <entry>3</entry>
- <entry>
- <parameter>message</parameter> is appended to the file
- <parameter>destination</parameter>.
- </entry>
- </row>
+ <row>
+ <entry>0</entry>
+ <entry>
+ <parameter>message</parameter> is sent to PHP's system
+ logger, using the Operating System's system logging
+ mechanism or a file, depending on what the <link
+ linkend="ini.error-log">error_log</link> configuration
+ directive is set to.
+ </entry>
+ </row>
+ <row>
+ <entry>1</entry>
+ <entry>
+ <parameter>message</parameter> is sent by email to the
+ address in the <parameter>destination</parameter> parameter.
+ This is the only message type where the fourth parameter,
+ <parameter>extra_headers</parameter> is used. This message
+ type uses the same internal function as
+ <function>Mail</function> does.
+ </entry>
+ </row>
+ <row>
+ <entry>2</entry>
+ <entry>
+ <parameter>message</parameter> is sent through the PHP
+ debugging connection. This option is only available if
+ <link linkend="enable-debugger">remote debugging has been
+ enabled</link>. In this case, the
+ <parameter>destination</parameter> parameter specifies the
+ host name or IP address and optionally, port number, of the
+ socket receiving the debug information.
+ </entry>
+ </row>
+ <row>
+ <entry>3</entry>
+ <entry>
+ <parameter>message</parameter> is appended to the file
+ <parameter>destination</parameter>.
+ </entry>
+ </row>
</tbody>
</tgroup>
- </table></para>
+ </table>
+ </para>
<para>
<example role="php">
<title><function>error_log</function> examples</title>
@@ -88,14 +212,14 @@
// Notify administrator by email if we run out of FOO
if (!($foo = allocate_new_foo()) {
- error_log("Big trouble, we're all out of FOOs!", 1,
- "operator <email protected>");
+ error_log ("Big trouble, we're all out of FOOs!", 1,
+ "operator <email protected>");
}
// other ways of calling error_log():
-error_log("You messed up!", 2, "127.0.0.1:7000");
-error_log("You messed up!", 2, "loghost");
-error_log("You messed up!", 3, "/var/tmp/my-errors.log");
+error_log ("You messed up!", 2, "127.0.0.1:7000");
+error_log ("You messed up!", 2, "loghost");
+error_log ("You messed up!", 3, "/var/tmp/my-errors.log");
</programlisting>
</example>
</para>
@@ -112,65 +236,116 @@
<funcsynopsis>
<funcprototype>
<funcdef>int <function>error_reporting</function></funcdef>
- <paramdef>int
+ <paramdef>mixed
<parameter><optional>level</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
Sets PHP's error reporting level and returns the old level. The
- error reporting level is a bitmask of the following values
- (follow the links for the internal values to get their meanings):
+ error reporting level is either a bitmask or text string. Using
+ text strings is strongly encouraged to ensure compatibility for
+ future versions. As error levels are added, the range of integers
+ increases, so older integer-based error levels will not always
+ behave as expected.
+ <example role="php">
+ <title>Error Integer changes</title>
+ <programlisting role="php">
+error_reporting(55); // PHP 3 equivalent to E_ALL ^ E_NOTICE
+
+/* ...in PHP 4, '55' would mean (E_ERROR | E_WARNING | E_PARSE |
+E_CORE_ERROR | E_CORE_WARNING) */
+
+error_reporting(2039); // PHP 4 equivalent to E_ALL ^ E_NOTICE
+
+error_reporting(E_ALL ^ E_NOTICE); // The same in both PHP 3 and 4
+ </programlisting>
+ </example>
+
+ Follow the links for the internal values to get their meanings:
<table>
<title><function>error_reporting</function> bit values</title>
<tgroup cols="2">
<thead>
- <row>
- <entry>value</entry>
- <entry>internal name</entry>
- </row>
+ <row>
+ <entry>value</entry>
+ <entry>internal name</entry>
+ </row>
</thead>
<tbody>
- <row>
- <entry>1</entry>
- <entry>
- <link linkend="internal.e-error">E_ERROR</link>
- </entry>
- </row>
- <row>
- <entry>2</entry>
- <entry>
- <link linkend="internal.e-warning">E_WARNING</link>
- </entry>
- </row>
- <row>
- <entry>4</entry>
- <entry>
- <link linkend="internal.e-parse">E_PARSE</link>
- </entry>
- </row>
- <row>
- <entry>8</entry>
- <entry>
- <link linkend="internal.e-notice">E_NOTICE</link>
- </entry>
- </row>
- <row>
- <entry>16</entry>
- <entry>
- <link linkend="internal.e-core-error">E_CORE_ERROR</link>
- </entry>
- </row>
- <row>
- <entry>32</entry>
- <entry>
- <link linkend="internal.e-core-warning">E_CORE_WARNING</link>
- </entry>
- </row>
+ <row>
+ <entry>1</entry>
+ <entry>
+ <link linkend="internal.e-error">E_ERROR</link>
+ </entry>
+ </row>
+ <row>
+ <entry>2</entry>
+ <entry>
+ <link linkend="internal.e-warning">E_WARNING</link>
+ </entry>
+ </row>
+ <row>
+ <entry>4</entry>
+ <entry>
+ <link linkend="internal.e-parse">E_PARSE</link>
+ </entry>
+ </row>
+ <row>
+ <entry>8</entry>
+ <entry>
+ <link linkend="internal.e-notice">E_NOTICE</link>
+ </entry>
+ </row>
+ <row>
+ <entry>16</entry>
+ <entry>
+ <link linkend="internal.e-core-error">E_CORE_ERROR</link>
+ </entry>
+ </row>
+ <row>
+ <entry>32</entry>
+ <entry>
+ <link linkend="internal.e-core-warning">E_CORE_WARNING</link>
+ </entry>
+ </row>
+ <row>
+ <entry>64</entry>
+ <entry>
+ <link linkend="internal.e-compile-error">E_COMPILE_ERROR</link>
+ </entry>
+ </row>
+ <row>
+ <entry>128</entry>
+ <entry>
+ <link linkend="internal.e-compile-warning">E_COMPILE_WARNING</link>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
</para>
+ <para>
+ <example role="php">
+ <title><function>error_reporting</function> examples</title>
+ <programlisting role="php">
+error_reporting(0);
+/* Turn off all reporting */
+
+error_reporting(7); // Old syntax, PHP 2/3
+error_reporting(E_ERROR | E_WARNING | E_PARSE); // New syntax for PHP 3/4
+/* Good to use for simple running errors */
+
+error_reporting(15); // Old syntax, PHP 2/3
+error_reporting(E_ERROR | E_WARNING | E_PARSE | E_NOTICE); // New syntax for PHP 3/4
+/* good for code authoring to report uninitialized or (possibly mis-spelled) variables */
+
+error_reporting(63); // Old syntax, PHP 2/3
+error_reporting(E_ALL); // New syntax for PHP3/4
+/* report all PHP errors */
+ </programlisting>
+ </example>
+ </para>
</refsect1>
</refentry>
@@ -222,7 +397,7 @@
<informalexample>
<programlisting>
-$ip = getenv("REMOTE_ADDR"); // get the ip number of the user
+$ip = getenv ("REMOTE_ADDR"); // get the ip number of the user
</programlisting>
</informalexample>
</para>
@@ -376,7 +551,7 @@
<title>getlastmod() example</title>
<programlisting role="php">
// outputs e.g. 'Last modified: March 04 1998 20:43:59.'
-echo "Last modified: ".date( "F d Y H:i:s.", getlastmod() );
+echo "Last modified: ".date ("F d Y H:i:s.", getlastmod());
</programlisting>
</example>
</para>
@@ -500,8 +675,8 @@
<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_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>
@@ -510,7 +685,234 @@
</para>
</refsect1>
</refentry>
+
+ <refentry id="function.ini-alter">
+ <refnamediv>
+ <refname>ini_alter</refname>
+ <refpurpose>Change the value of a configuration option</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ini_alter</function></funcdef>
+ <paramdef>string <parameter>varname</parameter></paramdef>
+ <paramdef>string <parameter>newvalue</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Changes the value of a configuration option, returns
+ <literal>false</literal> on failure, and the previous value of the
+ configuration option on success.
+ </para>
+ <note>
+ <para>
+ This is an alias of <function>ini_set</function>
+ </para>
+ </note>
+ <para>
+ See also <function>ini_get</function>,
+ <function>ini_restore</function>,
+ <function>ini_set</function>
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ini-get">
+ <refnamediv>
+ <refname>ini_get</refname>
+ <refpurpose>Get the value of a configuration option</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ini_get</function></funcdef>
+ <paramdef>string <parameter>varname</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Returns the value of the configuration option on success,
+ <literal>false</literal> on failure.
+ </para>
+ <para>
+ See also <function>ini_alter</function>,
+ <function>ini_restore</function>,
+ <function>ini_set</function>
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ini-restore">
+ <refnamediv>
+ <refname>ini_restore</refname>
+ <refpurpose>Restore the value of a configuration option</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ini_restore</function></funcdef>
+ <paramdef>string <parameter>varname</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Restores a given configuration option to its original value.
+ </para>
+ <para>
+ See also <function>ini_alter</function>,
+ <function>ini_get</function>,
+ <function>ini_set</function>
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ini-set">
+ <refnamediv>
+ <refname>ini_set</refname>
+ <refpurpose>Set the value of a configuration option</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ini_set</function></funcdef>
+ <paramdef>string <parameter>varname</parameter></paramdef>
+ <paramdef>string <parameter>newvalue</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Sets the value of the given configuration option. Returns the old
+ value on success, <literal>false</literal> on failure.
+ </para>
+ <para>
+ See also <function>ini_alter</function>,
+ <function>ini_get</function>,
+ <function>ini_restore</function>
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="function.phpcredits">
+ <refnamediv>
+ <refname>phpcredits</refname>
+ <refpurpose>Prints out the credits for PHP.</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>phpcredits</function></funcdef>
+ <paramdef>int <parameter>flag</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function prints out the credits listing the PHP developers,
+ modules, etc. It generates the appropriate HTML codes to insert
+ the information in a page. A parameter indicating what will be
+ printed (a pre-defined constant flag, see table below) needs
+ to be passed. For example to print the general credits, you will
+ use somewhere in your code:
+ <informalexample>
+ <programlisting role="php">
+...
+phpcredits(CREDITS_GENERAL);
+...
+ </programlisting>
+ </informalexample>
+ And if you want to print the core developers and the documentation
+ group, in a page of its own, you will use:
+ <informalexample>
+ <programlisting role="php">
+<?php
+ phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
+?>
+ </programlisting>
+ </informalexample>
+ And if you feel like embedding all the credits in your page, then
+ code like the one below will do it:
+ <informalexample>
+ <programlisting role="php">
+<html>
+ <head>
+ <title>My credits page</title>
+ </head>
+ <body>
+ <?php
+ // some code of your own
+ phpcredits(CREDITS_ALL + CREDITS_FULLPAGE);
+ // some more code
+ ?>
+ </body>
+</html>
+ </programlisting>
+ </informalexample>
+ </para>
+ <para>
+ </para>
+ <para>
+ <table>
+ <title>Pre-defined <function>phpcredits</function> flags</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>name</entry>
+ <entry>description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>CREDITS_ALL</entry>
+ <entry>
+ All the credits, equivalent to using: CREDITS_DOCS + CREDITS_GENERAL +
+ CREDITS_GROUP + CREDITS_MODULES + CREDITS_FULLPAGE. It generates a
+ complete stand-alone HTML page with the appropriate tags.
+ </entry>
+ </row>
+ <row>
+ <entry>CREDITS_DOCS</entry>
+ <entry>The credits for the documentation team</entry>
+ </row>
+ <row>
+ <entry>CREDITS_FULLPAGE</entry>
+ <entry>
+ Usually used in combination with the other flags.
+ Indicates that the a complete stand-alone HTML page
+ needs to be printed including the information indicated
+ by the other flags.
+ </entry>
+ </row>
+ <row>
+ <entry>CREDITS_GENERAL</entry>
+ <entry>
+ General credits: Language design and concept, PHP 4.0 authors
+ and SAPI module.
+ </entry>
+ </row>
+ <row>
+ <entry>CREDITS_GROUP</entry>
+ <entry>A list of the core developers</entry>
+ </row>
+ <row>
+ <entry>CREDITS_MODULES</entry>
+ <entry>A list of the extension modules for PHP, and their authors</entry>
+ </row>
+ <row>
+ <entry>CREDITS_SAPI</entry>
+ <entry>This flag is defined but, as of PHP 4.0.1pl2, it is not used</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ <para>
+ See also <function>phpinfo</function>,
+ <function>phpversion</function>,
+ <function>php_logo_guid</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.phpinfo">
<refnamediv>
<refname>phpinfo</refname>
@@ -533,7 +935,9 @@
options, HTTP headers, and the GNU Public License.
</para>
<para>
- See also <function>phpversion</function>.
+ See also <function>phpversion</function>,
+ <function>phpcredits</function>,
+ <function>php_logo_guid</function>
</para>
</refsect1>
</refentry>
@@ -563,7 +967,9 @@
</example>
</para>
<para>
- See also <function>phpinfo</function>.
+ See also <function>phpinfo</function>,
+ <function>phpcredits</function>,
+ <function>php_logo_guid</function>
</para>
</refsect1>
</refentry>
@@ -588,6 +994,11 @@
</para>
</note>
</para>
+ <para>
+ See also <function>phpinfo</function>.
+ <function>phpversion</function>,
+ <function>phpcredits</function>
+ </para>
</refsect1>
</refentry>
@@ -603,7 +1014,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>string <function>php_sapi_name</function></funcdef>
- <paramdef>void</paramdef>
+ <void/>
</funcprototype>
</funcsynopsis>
<simpara>
@@ -627,6 +1038,38 @@
</refsect1>
</refentry>
+ <refentry id="function.php-uname">
+ <refnamediv>
+ <refname>php_uname</refname>
+ <refpurpose>
+ Returns information about the operating system PHP was built on
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>php_uname</function></funcdef>
+ <void/>
+ </funcprototype>
+ </funcsynopsis>
+ <simpara>
+ <function>php_uname</function> returns a string with a description
+ of the operating system PHP is built on.
+ </simpara>
+ <para>
+ <example>
+ <title><function>php_uname</function> Example</title>
+ <programlisting role="php">
+if (substr(php_uname(), 0, 7) == "Windows") {
+ die("Sorry, this script doesn't run on Windows.\n");
+}
+</programlisting>
+ </example>
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.putenv">
<refnamediv>
<refname>putenv</refname>
@@ -641,13 +1084,13 @@
</funcprototype>
</funcsynopsis>
<para>
- Adds <parameter>setting</parameter> to the environment.
+ Adds <parameter>setting</parameter> to the server environment.
</para>
<para>
<example>
<title>Setting an Environment Variable</title>
<programlisting role="php">
-putenv("UNIQID=$uniqid");
+putenv ("UNIQID=$uniqid");
</programlisting>
</example>
</para>
@@ -748,9 +1191,9 @@
<refnamediv>
<refname>get_loaded_extensions</refname>
<refpurpose>
- Returns an array with the names of all modules compiled and
- loaded
- </refpurpose>
+ Returns an array with the names of all modules compiled and
+ loaded
+ </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -761,19 +1204,19 @@
</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_loadedextensions());
- </programlisting>
- </informalexample>
- will print a list like:
- <informalexample>
- <programlisting>
+ 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_loadedextensions());
+ </programlisting>
+ </informalexample>
+ will print a list like:
+ <informalexample>
+ <programlisting>
Array
(
[0] => xml
@@ -789,12 +1232,12 @@
[10] => Calendar
[11] => bcmath
)
- </programlisting>
- </informalexample>
+ </programlisting>
+ </informalexample>
</para>
- <para>
- See also: <function>get_extension_funcs</function>
- </para>
+ <para>
+ See also: <function>get_extension_funcs</function>.
+ </para>
</refsect1>
</refentry>
@@ -802,8 +1245,8 @@
<refnamediv>
<refname>get_extension_funcs</refname>
<refpurpose>
- Returns an array with the names of the function of a module
- </refpurpose>
+ Returns an array with the names of the functions of a module
+ </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -813,24 +1256,24 @@
<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>
- 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>
+ 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>
@@ -838,8 +1281,9 @@
<refnamediv>
<refname>get_required_files</refname>
<refpurpose>
- Returns an array with the names of the files require_once()'d in a script
- </refpurpose>
+ Returns an array with the names of the files require_once()'d in
+ a script
+ </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -849,36 +1293,37 @@
<paramdef>void </paramdef>
</funcprototype>
</funcsynopsis>
+ <para>
+ This function returns an associtative array of the names of all
+ the files that have been loaded into a script using
+ <function>require_once</function>. The indexes of the array are
+ the file names as used in the <function>require_once</function>
+ without the ".php" extension.
+ </para>
<para>
- This function returns an associtative array of the names of all the files
- that have been loaded into a script using
- <function>require_once</function>. The indexes of the array are the file
- names as used in the <function>require_once</function> without the
- ".php" extension.
- </para>
- <para>
- The example below
- <example>
- <title>Printing the required and included files</title>
- <programlisting>
+ The example below
+ <example>
+ <title>Printing the required and included files</title>
+ <programlisting>
<?php
-require_once("local.php");
-require_once("../inc/global.php");
+require_once ("local.php");
+require_once ("../inc/global.php");
for ($i=1; $i<5; $i++)
- include "util".$i."php";
+ include "util".$i."php";
echo "Required_once files\n";
-print_r(get_required_files());
+print_r (get_required_files());
echo "Included_once files\n";
-print_r(get_included_files());
- </programlisting>
- </example>
- will generate the following output:
+print_r (get_included_files());
+?>
+ </programlisting>
+ </example>
+ will generate the following output:
<informalexample>
- <programlisting>
+ <programlisting>
Required_once files
Array
(
@@ -894,23 +1339,23 @@
[util3] => util3.php
[util4] => util4.php
)
- </programlisting>
+ </programlisting>
</informalexample>
+ </para>
+ <para>
+ <note>
+ <para>
+ As of PHP 4.0.1pl2 this function assumes that the
+ <varname>required_once</varname> files end in the extension
+ ".php", other extensions do not work.
+ </para>
+ </note>
</para>
- <para>
- <note>
- <para>
- As of PHP 4.0.1pl2 this function assumes that the
- <varname>required_once</varname> files end in the extension
- ".php", other extensions do not work.
- </para>
- </note>
- </para>
- <para>
- See also: <function>require_once</function>,
+ <para>
+ See also: <function>require_once</function>,
<function>include_once</function>,
- <function>get_included_files</function>
- </para>
+ <function>get_included_files</function>
+ </para>
</refsect1>
</refentry>
@@ -918,8 +1363,9 @@
<refnamediv>
<refname>get_included_files</refname>
<refpurpose>
- Returns an array with the names of the files include_once()'d in a script
- </refpurpose>
+ Returns an array with the names of the files include_once()'d in
+ a script
+ </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -929,31 +1375,29 @@
<paramdef>void </paramdef>
</funcprototype>
</funcsynopsis>
+ <para>
+ This function returns an associtative array of the names of all
+ the files that have been loaded into a script using
+ <function>include_once</function>. The indexes of the array are
+ the file names as used in the <function>include_once</function>
+ without the ".php" extension.
+ </para>
+ <para>
+ <note>
+ <para>
+ As of PHP 4.0.1pl2 this function assumes that the
+ <varname>include_once</varname> files end in the extension
+ ".php", other extensions do not work.
+ </para>
+ </note>
+ </para>
<para>
- This function returns an associtative array of the names of all the files
- that have been loaded into a script using
- <function>include_once</function>. The indexes of the array are the file
- names as used in the <function>include_once</function> without the
- ".php" extension.
- </para>
- <para>
- <note>
- <para>
- As of PHP 4.0.1pl2 this function assumes that the
- <varname>include_once</varname> files end in the extension
- ".php", other extensions do not work.
- </para>
- </note>
- </para>
- <para>
- See also: <function>require_once</function>,
+ See also: <function>require_once</function>,
<function>include_once</function>,
- <function>get_required_files</function>
- </para>
+ <function>get_required_files</function>
+ </para>
</refsect1>
</refentry>
-
-
</reference>
- Next message: Martin Kraemer: "[PHP-DOC] cvs: phpdoc / configure.in"
- Previous message: Luca Perugini: "[PHP-DOC] cvs: phpdoc /it/functions imap.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]