mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 11:28:55 +00:00
201dc3748c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@291313 c90b9560-bf6c-de11-be94-00142212c4b1
187 lines
4.7 KiB
XML
187 lines
4.7 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.phpcredits" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>phpcredits</refname>
|
|
<refpurpose>Prints out the credits for PHP</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>phpcredits</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>flag</parameter><initializer>CREDITS_ALL</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<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.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>flag</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
To generate a custom credits page, you may want to use the
|
|
<parameter>flag</parameter> parameter.
|
|
</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: <constant>CREDITS_DOCS</constant> +
|
|
<constant>CREDITS_GENERAL</constant> + <constant>CREDITS_GROUP</constant> +
|
|
<constant>CREDITS_MODULES</constant> + <constant>CREDITS_FULLPAGE</constant>.
|
|
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 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>
|
|
A list of the server API modules for PHP, and their authors
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Prints the general credits</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
phpcredits(CREDITS_GENERAL);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Prints the core developers and the documentation group</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Printing all the credits</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<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>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>phpversion</function></member>
|
|
<member><function>php_logo_guid</function></member>
|
|
<member><function>phpinfo</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|