get-class-vars.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1debc76060f0c33222789a299df72d0addd7fce3 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes Maintainer: pmartin -->
<refentry xml:id="function.get-class-vars" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>get_class_vars</refname>
  <refpurpose>Retourne les valeurs par défaut des propriétés d'une classe</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>get_class_vars</methodname>
   <methodparam><type>string</type><parameter>class</parameter></methodparam>
  </methodsynopsis>
  <para>
   Retourne les valeurs par défaut des propriétés d'une classe.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>class</parameter></term>
     <listitem>
      <para>
       Le nom de la classe
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau associatif contenant les noms/valeurs des
   propriétés visibles dans le scope courant, avec leurs
   valeurs par défaut. Les éléments du tableau résultant sont
   sous la forme <literal>varname =&gt; value</literal>.
   En cas d'erreur, la fonction retournera &false;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>get_class_vars</function></title>
    <programlisting role="php">
<![CDATA[
<?php

class MyClass
{
    public $var1; // This has no explicit default value (technically it has NULL as a default)...
    public $var2 = "xyz";
    public $var3 = 100;

    // constructeur
    function __construct()
    {
        // changement de quelques propriétés
        $this->var1 = "foo";
        $this->var2 = "bar";
        return true;
    }

}

$my_class = new MyClass();

$class_vars = get_class_vars(get_class($my_class));

foreach ($class_vars as $name => $value) {
     echo "{$name}: ", var_export($value, true), "\n";
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
var1: NULL
var2: 'xyz'
var3: 100
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Exemple avec <function>get_class_vars</function> et les contextes</title>
    <programlisting role="php">
<![CDATA[
<?php

function format($array)
{
    return implode('|', array_keys($array)) . "\r\n";
}

class TestCase
{
    public $a = 1;
    protected $b = 2;
    private $c = 3;

    public static function expose()
    {
        echo format(get_class_vars(__CLASS__));
    }
}

TestCase::expose();
echo format(get_class_vars('TestCase'));

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
// 5.0.0
a| * b| TestCase c
a| * b| TestCase c

// 5.0.1 - 5.0.2
a|b|c
a|b|c

// 5.0.3 +
a|b|c
a
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>get_class_methods</function></member>
    <member><function>get_object_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
-->