[PHP-DOC] cvs: phpdoc /en/functions info.xml From: Jesus M. Castagnetto (jesusmc <email protected>)
Date: 08/19/00

jmcastagnetto Sat Aug 19 15:01:20 2000 EDT

  Modified files:
    /phpdoc/en/functions info.xml
  Log:
  Added description for phpcredits
  
  
Index: phpdoc/en/functions/info.xml
diff -u phpdoc/en/functions/info.xml:1.17 phpdoc/en/functions/info.xml:1.18
--- phpdoc/en/functions/info.xml:1.17 Fri Aug 18 23:13:31 2000
+++ phpdoc/en/functions/info.xml Sat Aug 19 15:01:20 2000
@@ -634,6 +634,126 @@
    </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 somwhere in your code:
+ <informalexample>
+ <programlisting role="php">
+...
+phpversion(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">
+&lt;?php
+ phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
+?&gt;
+ </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">
+&lt;html&gt;
+ &lt;head&gt;
+ &lt;title&gt;My credits page&lt;/title&gt;
+ &lt;/head&gt;
+ &lt;body&gt;
+ &lt;?php
+ // some code of your own
+ phpversion(CREDITS_ALL + CREDITS_FULLPAGE);
+ // some more code
+ ?&gt;
+ &lt;/body&gt;
+&lt;/html&gt;
+ </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>
@@ -656,7 +776,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>
@@ -686,7 +808,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>