 |
 |
 |
 |
|
|
Date: 08/28/00
- Next message: Jesus M. Castagnetto: "[PHP-DOC] cvs: phpdoc /en/functions info.xml"
- Previous message: Zeev Suraski: "[PHP-DOC] Re: [PHP-DEV] Re: "waldschrotts guide to nifty references" - manual page draft, version 0.9b"
- Next in thread: Jesus M. Castagnetto: "[PHP-DOC] cvs: phpdoc /en/functions info.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
jmcastagnetto Mon Aug 28 03:37:03 2000 EDT
Modified files:
/phpdoc/en/functions info.xml
Log:
very basic documentation of ini_alter, ini_get, ini_restore, ini_set
examples and more info later
Index: phpdoc/en/functions/info.xml
diff -u phpdoc/en/functions/info.xml:1.22 phpdoc/en/functions/info.xml:1.23
--- phpdoc/en/functions/info.xml:1.22 Sun Aug 27 03:09:29 2000
+++ phpdoc/en/functions/info.xml Mon Aug 28 03:37:03 2000
@@ -75,47 +75,47 @@
<tgroup cols="4">
<thead>
<row>
- <entry>option</entry>
- <entry>ini-parameter</entry>
- <entry>default</entry>
- <entry>description</entry>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <entry>ASSERT_CALLBACK</entry>
+ <entry>assert_callback</entry>
+ <entry>(null)</entry>
+ <entry>user function to call on failed assertions</entry>
</row>
- </tbody>
+ </tbody>
</tgroup>
</table>
<para>
@@ -147,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
@@ -156,46 +156,46 @@
<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>
@@ -213,7 +213,7 @@
// 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>");
+ "operator <email protected>");
}
// other ways of calling error_log():
@@ -249,48 +249,48 @@
<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>
</tbody>
</tgroup>
</table>
@@ -645,8 +645,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>
@@ -655,6 +655,957 @@
</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>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>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.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.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.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.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.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.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.phpcredits">
<refnamediv>
@@ -670,32 +1621,32 @@
</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">
+ 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">
+ </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">
+ </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>
@@ -708,66 +1659,66 @@
?>
</body>
</html>
- </programlisting>
- </informalexample>
+ </programlisting>
+ </informalexample>
</para>
- <para>
- </para>
- <para>
- <table>
+ <para>
+ </para>
+ <para>
+ <table>
<title>Pre-defined <function>phpcredits</function> flags</title>
<tgroup cols="2">
<thead>
- <row>
- <entry>name</entry>
- <entry>description</entry>
- </row>
+ <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>
+ <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>
<para>
See also <function>phpinfo</function>,
<function>phpversion</function>,
@@ -799,8 +1750,8 @@
</para>
<para>
See also <function>phpversion</function>,
- <function>phpcredits</function>,
- <function>php_logo_guid</function>
+ <function>phpcredits</function>,
+ <function>php_logo_guid</function>
</para>
</refsect1>
</refentry>
@@ -831,8 +1782,8 @@
</para>
<para>
See also <function>phpinfo</function>,
- <function>phpcredits</function>,
- <function>php_logo_guid</function>
+ <function>phpcredits</function>,
+ <function>php_logo_guid</function>
</para>
</refsect1>
</refentry>
@@ -860,7 +1811,7 @@
<para>
See also <function>phpinfo</function>.
<function>phpversion</function>,
- <function>phpcredits</function>
+ <function>phpcredits</function>
</para>
</refsect1>
</refentry>
@@ -1097,7 +2048,7 @@
<programlisting>
print_r (get_extension_funcs ("xml"));
print_r (get_extension_funcs ("gd"));
- </programlisting>
+ </programlisting>
</informalexample>
will print a list of the functions in the modules
<varname>xml</varname> and <varname>gd</varname> respectively.
- Next message: Jesus M. Castagnetto: "[PHP-DOC] cvs: phpdoc /en/functions info.xml"
- Previous message: Zeev Suraski: "[PHP-DOC] Re: [PHP-DEV] Re: "waldschrotts guide to nifty references" - manual page draft, version 0.9b"
- Next in thread: Jesus M. Castagnetto: "[PHP-DOC] cvs: phpdoc /en/functions info.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]