mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-22 03:48:55 +00:00
64a89e0101
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@132049 c90b9560-bf6c-de11-be94-00142212c4b1
161 lines
4.3 KiB
XML
161 lines
4.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<!-- splitted from ./en/functions/info.xml, last change in rev 1.18 -->
|
|
<refentry id="function.phpcredits">
|
|
<refnamediv>
|
|
<refname>phpcredits</refname>
|
|
<refpurpose>Prints out the credits for PHP</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>phpcredits</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>flag</parameter></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. <parameter>flag</parameter> is
|
|
optional, and it defaults to <constant>CREDITS_ALL</constant>.
|
|
To generate a custom credits page, you may want to use the
|
|
<parameter>flag</parameter> parameter. For example to print
|
|
the general credits, you will use somewhere in your code:
|
|
</para>
|
|
<para>
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
phpcredits(CREDITS_GENERAL);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
<para>
|
|
And if you want to print the core developers and the
|
|
documentation group, in a page of its own, you will use:
|
|
</para>
|
|
<para>
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
<para>
|
|
And if you feel like embedding all the credits in your page, then
|
|
code like the one below will do it:
|
|
</para>
|
|
<para>
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<html>
|
|
<head>
|
|
<title>My credits page</title>
|
|
</head>
|
|
<body>
|
|
<?php
|
|
// some code of your own
|
|
phpcredits(CREDITS_ALL);
|
|
// some more code
|
|
?>
|
|
</body>
|
|
</html>
|
|
]]>
|
|
</programlisting>
|
|
</informalexample>
|
|
</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>
|
|
A list of the server API modules for PHP, and their authors
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
See also: <function>phpinfo</function>,
|
|
<function>phpversion</function>, and
|
|
<function>php_logo_guid</function>.
|
|
</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:"../../../../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
|
|
-->
|