sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 08:58:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added description for phpcredits

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@30536 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jesus M. Castagnetto 2000-08-19 22:01:20 +00:00
parent 293495cf8a
commit 043b0b1793
1 changed files with 126 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

128
functions/info.xml
View file

@ -634,6 +634,126 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds)
</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 @@ echo $dat["ru_utime.tv_usec"]; # user time used (microseconds)
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 @@ echo "Current PHP version: ".phpversion();
</example>
</para>
<para>
See also <function>phpinfo</function>.
See also <function>phpinfo</function>,
<function>phpcredits</function>,
<function>php_logo_guid</function>
</para>
</refsect1>
</refentry>