php-doc-en/reference/info/functions/get-defined-constants.xml

<?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
-->