File: get-defined-constants.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 (151 lines) | stat: -rw-r--r-- 3,835 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/info.xml, last change in rev 1.71 -->
  <refentry id="function.get-defined-constants">
   <refnamediv>
    <refname>get_defined_constants</refname>
    <refpurpose>
     Returns an associative array with the names of all the constants
     and their values
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>get_defined_constants</methodname>
      <methodparam choice="opt"><type>mixed</type><parameter>categorize</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function returns the names and values of all the constants
     currently defined.  This includes those created by extensions as
     well as those created with the <function>define</function>
     function.
    </para>
    <para>
     For example the line below:
     <informalexample>
      <programlisting role="php">
<![CDATA[
<?php
print_r(get_defined_constants());
?>
]]>
      </programlisting>
      <para>
       will print a list like:
      </para>
      <screen>
<![CDATA[
Array
(
    [E_ERROR] => 1
    [E_WARNING] => 2
    [E_PARSE] => 4
    [E_NOTICE] => 8
    [E_CORE_ERROR] => 16
    [E_CORE_WARNING] => 32
    [E_COMPILE_ERROR] => 64
    [E_COMPILE_WARNING] => 128
    [E_USER_ERROR] => 256
    [E_USER_WARNING] => 512
    [E_USER_NOTICE] => 1024
    [E_ALL] => 2047
    [TRUE] => 1
)
]]>
      </screen>
     </informalexample>
    </para>
    <para>
     As of PHP 5, an additional parameter, <parameter>categorize</parameter>,
     may be passed, causing this function to return a multi-dimensional array
     with categories in the keys of the first dimension and
     constants and their values in the second dimension.
     <informalexample>
      <programlisting role="php">
<![CDATA[
<?php
define("MY_CONSTANT", 1);
print_r(get_defined_constants(true));
?>
]]>
      </programlisting>
      &example.outputs.similar;
      <screen>
<![CDATA[
Array
(
    [internal] => Array
        (
            [E_ERROR] => 1
            [E_WARNING] => 2
            [E_PARSE] => 4
            [E_NOTICE] => 8
            [E_CORE_ERROR] => 16
            [E_CORE_WARNING] => 32
            [E_COMPILE_ERROR] => 64
            [E_COMPILE_WARNING] => 128
            [E_USER_ERROR] => 256
            [E_USER_WARNING] => 512
            [E_USER_NOTICE] => 1024
            [E_ALL] => 2047
            [TRUE] => 1
        )

    [pcre] => Array
        (
            [PREG_PATTERN_ORDER] => 1
            [PREG_SET_ORDER] => 2
            [PREG_OFFSET_CAPTURE] => 256
            [PREG_SPLIT_NO_EMPTY] => 1
            [PREG_SPLIT_DELIM_CAPTURE] => 2
            [PREG_SPLIT_OFFSET_CAPTURE] => 4
            [PREG_GREP_INVERT] => 1
        )

    [user] => Array
        (
            [MY_CONSTANT] => 1
        )

)
]]>
      </screen>
     </informalexample>
     <note>
      <para>
       The value of the <parameter>categorize</parameter> parameter is irrelevant,
       only its presence is considered.
      </para>
     </note>
    </para>
    <para>
     See also 
     <function>defined</function>,
     <function>get_loaded_extensions</function>,
     <function>get_defined_functions</function>, and
     <function>get_defined_vars</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
-->