get-defined-constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b8758b0605e80c4e3610137b7502a6abeea5c69b Maintainer: andresdzphp Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.get-defined-constants" xmlns="http://docbook.org/ns/docbook">
 <refnamediv> 
  <refname>get_defined_constants</refname>
  <refpurpose>Devuelve un array asociativo con los nombres de todas las constantes y sus valores</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>get_defined_constants</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>categorize</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Devuelve los nombres y valores de todas las constantes definidas actualmente.
   Esto incluye las creadas por las extensiones, así como las creadas con 
   la función <function>define</function>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>categorize</parameter></term>
     <listitem>
      <para>
       Provoca que la función retorne un array multi-dimensional 
       con categorias en las claves de la primera dimensión y constantes 
       y sus valores en la segunda dimensión.
       <informalexample>
        <programlisting role="php">
<![CDATA[
<?php
define("MI_CONSTANTE", 1);
print_r(get_defined_constants(true));
?>
]]>
        </programlisting>
        &example.outputs.similar;
        <screen>
<![CDATA[
Array
(
    [Core] => 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
        (
            [MI_CONSTANTE] => 1
        )

)
]]>
        </screen>
       </informalexample>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un array de arrays nombre_constante => valor_constante, opcionalmente
   agrupados por nombre de extensión registrando la constante.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.1</entry>
       <entry>
        Sólo para Windows: las constantes fundamentales se clasifican en <literal>Core</literal>, 
        previamente <literal>mhash</literal>.
       </entry>
      </row>
      <row>
       <entry>5.3.0</entry>
       <entry>
        Constantes fundamentales se clasifican en <literal>Core</literal>, 
        antes <literal>internal</literal>. En Windows, las constantes fundamentales se clasifican en <literal>mhash</literal>.
       </entry>
      </row>
      <row>
       <entry>5.2.11</entry>
       <entry>
        El parámetro <parameter>categorize</parameter> ahora funciona correctamente.
        Anteriormente, el parámetro <parameter>categorize</parameter> era interpretado
        como <literal>!is_null($categorize)</literal>, por lo que cualquier valor distinto de &null;
        fuerza a las constantes a ser clasificadas.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>get_defined_constants</function></title>
    <programlisting role="php">
<![CDATA[
<?php
print_r(get_defined_constants());
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <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>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>defined</function></member>
    <member><function>get_loaded_extensions</function></member>
    <member><function>get_defined_functions</function></member>
    <member><function>get_defined_vars</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
-->