get-declared-classes.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.get-declared-classes" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>get_declared_classes</refname>
  <refpurpose>Returns an array with the name of the defined classes</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>get_declared_classes</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Gets the declared classes.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array of the names of the declared classes in the current
   script.
  </para>
  <note>
   <para>
    Note that depending on what extensions you have compiled or
    loaded into PHP, additional classes could be present. This means that
    you will not be able to define your own classes using these
    names. There is a list of predefined classes in the <link
    linkend="reserved.classes">Predefined Classes</link> section of
    the appendices.
   </para>
  </note>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>7.4.0</entry>
      <entry>
       Previously <function>get_declared_classes</function> always returned parent classes before
       child classes. This is no longer the case. No particular order is guaranteed
       for the <function>get_declared_classes</function> return value.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>get_declared_classes</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
print_r(get_declared_classes());
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [0] => stdClass
    [1] => __PHP_Incomplete_Class
    [2] => Directory
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>class_exists</function></member>
    <member><function>get_declared_interfaces</function></member>
    <member><function>get_defined_functions</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
-->