Files
doc-fr/reference/info/functions/phpcredits.xml
2023-05-20 23:30:29 +01:00

197 lines
5.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f781803449007bb0e3a96c693e0eee067f7eb466 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.phpcredits" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>phpcredits</refname>
<refpurpose>Affiche les crédits de PHP</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>true</type><methodname>phpcredits</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>CREDITS_ALL</constant></initializer></methodparam>
</methodsynopsis>
<para>
Affiche la liste des développeurs PHP, des modules, etc. Elle génère le
code HTML approprié pour insérer les informations dans une page.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Pour générer une page personnalisée sur les crédits, il faut utiliser le
paramètre <parameter>flags</parameter>.
</para>
<para>
<table>
<title>Paramètres prédéfinis de <function>phpcredits</function></title>
<tgroup cols="2">
<thead>
<row>
<entry>Nom</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>CREDITS_ALL</entry>
<entry>
Tous les crédits, équivalent à : <constant>CREDITS_DOCS</constant> +
<constant>CREDITS_GENERAL</constant> + <constant>CREDITS_GROUP</constant> +
<constant>CREDITS_MODULES</constant> + <constant>CREDITS_FULLPAGE</constant>.
La fonction génère alors une page HTML complète.
</entry>
</row>
<row>
<entry>CREDITS_DOCS</entry>
<entry>Les crédits du groupe de documentation</entry>
</row>
<row>
<entry>CREDITS_FULLPAGE</entry>
<entry>
En général, ce paramètre est utilisé avec d'autres
constantes. Il indique que la page ainsi générée doit
être une page HTML complète, avec toutes les balises
nécessaires.
</entry>
</row>
<row>
<entry>CREDITS_GENERAL</entry>
<entry>
Crédits Généraux : conception et design du langage,
auteurs de PHP et du module SAPI.
</entry>
</row>
<row>
<entry>CREDITS_GROUP</entry>
<entry>Une liste des développeurs principaux</entry>
</row>
<row>
<entry>CREDITS_MODULES</entry>
<entry>
Une liste des extensions de PHP, et leurs auteurs
</entry>
</row>
<row>
<entry>CREDITS_SAPI</entry>
<entry>
Une liste des API serveur pour PHP et leurs auteurs
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.true.always;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>phpcredits</function></title>
<programlisting role="php">
<![CDATA[
<?php
phpcredits(CREDITS_GENERAL);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Affiche les développeurs principaux ansi que le groupe de documentation</title>
<programlisting role="php">
<![CDATA[
<?php
phpcredits(CREDITS_GROUP | CREDITS_DOCS | CREDITS_FULLPAGE);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Affiche tous les crédits</title>
<programlisting role="php">
<![CDATA[
<html>
<head>
<title>Ma page de crédits</title>
</head>
<body>
<?php
// Un peu de votre code
phpcredits(CREDITS_ALL - CREDITS_FULLPAGE);
// Encore un peu de votre code
?>
</body>
</html>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
La fonction <function>phpcredits</function> affiche du texte plein
au lieu du HTML lorsqu'elle est utilisée en mode CLI.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>phpversion</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
-->