File: phpcredits.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (161 lines) | stat: -rw-r--r-- 4,426 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- 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>bool</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 - CREDITS_FULLPAGE);
// 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 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
-->