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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<reference id="ref.classobj">
<title>Objets</title>
<titleabbrev>Classes et Objets</titleabbrev>
<partintro>
<sect1 id="classobj.partintro">
<title>Introduction</title>
<sect2 id="classobj.intro">
<title>About</title>
<para>
Ces fonctions permettent de gérer les classes et les objets.
Vous pouvez notamment connaître le nom de la classe d'un
objet, ses membres et ses méthodes, et tous les objets
parents (les classes qui sont étendues par la classe d'un objet).
</para>
</sect2>
<sect2 id="classobj.example">
<title>Exemple d'utilisation</title>
<para>
Dans cet exemple, on définit une classe de base, et une
extension. La classe de base définit un légume, s'il est
mangeable ou pas, et sa couleur. La sous-classe
<varname>epinard</varname> ajoute une méthode pour le cuisiner,
et une autre pour savoir s'il est cuisiné.
</para>
<para>
<example>
<title>classes.inc</title>
<programlisting role="php">
<?php
// classe de base, avec ses membres et ses méthodes
class Legume {
var $mangeable;
var $couleur;
function legume( $mangeable, $couleur="green" ) {
$this->mangeable = $mangeable;
$this->couleur = $couleur;
}
function est_mangeable() {
return $this->mangeable;
}
function quelle_couleur() {
return $this->couleur;
}
} // fin de la classe Legume
// extend la classe de base
class Epinard extends Legume {
var $cuit = <literal>FALSE</literal>;
function Epinard() {
$this->Legume( <literal>TRUE</literal>, "green" );
}
function cuisine() {
$this->cuit = <literal>TRUE</literal>;
}
function est_cuit() {
return $this->cuit;
}
} // fin de la classe Epinard
?>
</programlisting>
</example>
</para>
<para>
Lorsqu'on instantie deux objets de ces classes, et qu'on affiche
leurs informations, on affiche aussi leur héritage. On définit ici
des utilitaires qui servent essentiellement à afficher ces
informations proprement.
</para>
<para>
<example>
<title>test_script.php</title>
<programlisting role="php">
<pre>
<?php
include "classes.inc";
// utilitaires
function print_vars($obj) {
$arr = get_object_vars($obj);
while (list($prop, $val) = each($arr))
echo "\t$prop = $val\n";
}
function print_methods($obj) {
$arr = get_class_methods(get_class($obj));
foreach ($arr as $method)
echo "\tfunction $method()\n";
}
function class_parentage($obj, $class) {
global $$obj;
if (is_subclass_of($$obj, $class)) {
echo "L'objet $obj belongs to class ".get_class($$obj);
echo " est une sous-classe de $class\n";
} else {
echo "L'objet $obj n'est pas une sous classe $class\n";
}
}
// instantie 2 objets
$legume = new Legume(TRUE,"blue");
$feuilles = new Epinard();
// affiche les informations sur ces objets
echo "legume: CLASS ".get_class($legume)."\n";
echo "feuilles: CLASS ".get_class($feuilles);
echo ", PARENT ".get_parent_class($feuilles)."\n";
// affiche les propriétés du légume
echo "\nlégume: Propriétés \n";
print_vars($legume);
// et les méthodes de "feuilles"
echo "\nfeuilles: Methods\n";
print_methods($feuilles);
echo "\nParentée:\n";
class_parentage("feuilles", "Epinard");
class_parentage("feuilles", "Legume");
?>
</pre>
</programlisting>
</example>
</para>
<para>
Il est important de noter que dans les exemples ci-dessus, les objets
<varname>$feuilles</varname> sont une instance de
<classname>Epinard</classname> qui est une sous-classe de
<classname>Legume</classname>, donc la dernière partie du script
va afficher :
</para>
<para>
<informalexample>
<screen>
[...]
Parentée:
L'objet feuilles n'est pas une sous classe Spinach
L'objet feuilles est une sous-classe de Legume
</screen>
</informalexample>
</para>
</sect2>
</sect1>
</partintro>
<refentry id="function.call-user-method">
<refnamediv>
<refname>call_user_method</refname>
<refpurpose>
Appelle une méthode utilisateur d'un objet
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>call_user_method</methodname>
<methodparam><type>string</type><parameter>method_name</parameter></methodparam>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>parameter</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
Appelle la méthode <parameter>method_name</parameter> depuis l'objet
<parameter>obj</parameter>. Un exemple d'utilisation de cet objet
est présenté ci-dessous, où une classe est définie, puis instantiée.
On utilise alors <function>call_user_method</function> pour appeler
indirectement les méthodes <varname>print_info</varname>.
<informalexample>
<programlisting role="php">
<?php
class Pays {
var $NOM;
var $TLD;
function Pays($nom, $tld) {
$this->NOM = $nom;
$this->TLD = $tld;
}
function print_info($prestr="") {
echo $prestr."Pays: ".$this->NOM."\n";
echo $prestr."Nom de domaine: ".$this->TLD."\n";
}
}
$unPays = new Pays("Pérou","pe");
echo "* Appel de la méthode directement\n";
$unPays->print_info();
echo "\n* Appel de la méthode indirectement\n";
call_user_method ("print_info", $unPays, "\t");
?>
</programlisting>
</informalexample>
</para>
<simpara>
Voir aussi
<function>call_user_func_array</function>.
<function>call_user_func</function> et
<function>call_user_method_array</function>.
</simpara>
</refsect1>
</refentry>
<refentry id="function.call-user-method-array">
<refnamediv>
<refname>call_user_method_array</refname>
<refpurpose>
Appelle une méthode utilisateur avec un tableau de paramètres
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>call_user_method_array</methodname>
<methodparam><type>string</type><parameter>method_name</parameter></methodparam>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>paramarr</parameter></methodparam>
</methodsynopsis>
<para>
<function>call_user_method_array</function> appelle la méthode
<parameter>method_name</parameter> de l'object <parameter>obj</parameter>,
en utilisant les paramètres <parameter>paramarr</parameter>, rassemblés
sous forme de tableau.
</para>
<para>
Voir aussi
<function>call_user_func_array</function>,
<function>call_user_func</function> et
<function>call_user_method</function>.
</para>
<note>
<para>
<function>call_user_method_array</function> a été ajoutée en version
PHP 4.05.
</para>
</note>
</refsect1>
</refentry>
<refentry id="function.class-exists">
<refnamediv>
<refname>class_exists</refname>
<refpurpose>Vérifie qu'une classe a été définie</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>class_exists</methodname>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
</methodsynopsis>
<para>
<function>class_exists</function> retourne <literal>TRUE</literal> si la classe
<parameter>class_name</parameter> a été définie, et <literal>FALSE</literal> sinon.
</para>
</refsect1>
</refentry>
<refentry id="function.get-class">
<refnamediv>
<refname>get_class</refname>
<refpurpose>Retourne la classe d'un objet</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>get_class</methodname>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
</methodsynopsis>
<para>
<function>get_class</function> retourne la classe de l'objet
<parameter>obj</parameter>.
</para>
<simpara>
Voir aussi
<function>get_parent_class</function> et
<function>is_subclass_of</function>
</simpara>
</refsect1>
</refentry>
<refentry id="function.get-class-methods">
<refnamediv>
<refname>get_class_methods</refname>
<refpurpose>Retourne les noms des méthodes d'une classe.</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>get_class_methods</methodname>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
</methodsynopsis>
<para>
<function>get_class_methods</function> retourne un tableau contenant les
noms des méthodes de la classe <parameter>class_name</parameter>.
</para>
<note>
<para>
A partir de PHP 4.0.6, vous pouvez spécifier l'objet lui-même, au lieu
de sa classe <parameter>class_name</parameter>. Par exemple :
<informalexample>
<programlisting role="php">
<?php
$class_methods = get_class_methods($my_class);
?>
</programlisting>
</informalexample>
</para>
</note>
<para>
<example>
<title>Exemple avec <function>get_class_methods</function></title>
<programlisting role="php">
<?php
class myclass {
// constructeur
function maclasse() {
return(TRUE);
}
// méthode 1
function myfunc1() {
return(TRUE);
}
// méthode 2
function mafunc2() {
return(TRUE);
}
}
$ma_classe = new maclasse();
$class_methods = get_class_methods(get_class($ma_class));
foreach ($class_methods as $method_name) {
echo "$method_name\n";
}
?>
</programlisting>
</example>
</para>
<para>
Va afficher :
<informalexample>
<programlisting>
maclass
mafunc1
mafunc2
</programlisting>
</informalexample>
</para>
<simpara>
Voir aussi
<function>get_class_vars</function> et
<function>get_object_vars</function>
</simpara>
</refsect1>
</refentry>
<refentry id="function.get-class-vars">
<refnamediv>
<refname>get_class_vars</refname>
<refpurpose>
Retourne les valeurs par défaut des attributs d'une classe.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>get_class_vars</methodname>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
</methodsynopsis>
<para>
<function>get_class_vars</function> retourne un tableau contenant les
valeurs par défaut des attributs de la classe
<parameter>class_name</parameter>.
</para>
<note>
<para>
Les variables de classe qui ne sont pas encore initialisées ne seront pas
retournées par <function>get_class_vars</function>.
</para>
</note>
<para>
<example>
<title>Exemple <function>get_class_vars</function></title>
<programlisting role="php">
<?php
class maclasse {
var $var1; // Pas de valeur par défaut
var $var2 = "xyz";
var $var3 = 100;
// constructeur
function maclasse() {
return(TRUE);
}
}
$ma_classe = new maclasse();
$class_vars = get_class_vars(get_class($ma_classe));
foreach ($class_vars as $name => $value) {
echo "$name : $value\n";
}
?>
</programlisting>
</example>
</para>
<para>
va afficher :
<informalexample>
<programlisting>
var2 : xyz
var3 : 100
</programlisting>
</informalexample>
</para>
</refsect1>
</refentry>
<refentry id="function.get-declared-classes">
<refnamediv>
<refname>get_declared_classes</refname>
<refpurpose>Liste toutes les classes définies</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>get_declared_classes</methodname>
<void/>
</methodsynopsis>
<para>
<function>get_declared_classes</function> retourne un tableau contenant
la liste des fonctions déclarées dans le script courant.
</para>
<note>
<para>
En PHP 4.0.1pl2, trois classes supplémentaires sont retournées, au
début de ce tableau : <classname>stdClass</classname> (définie dans
<filename>Zend/zend.c</filename>),
<classname>OverloadedTestClass</classname> (définie dans
<filename>ext/standard/basic_functions.c</filename>)
et <classname>Directory</classname>
(définie dans <filename>ext/standard/dir.c</filename>).
</para>
</note>
</refsect1>
</refentry>
<refentry id="function.get-object-vars">
<refnamediv>
<refname>get_object_vars</refname>
<refpurpose>
Retourne un tableau associatif des propriétés d'un objet
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>get_object_vars</methodname>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
</methodsynopsis>
<para>
<function>get_object_vars</function> retourne un tableau associatif
contenant les propriétés de l'objet <parameter>obj</parameter>.
Les clés du tableau sont les noms des propriétés
de l'objet.Si des variables déclarées dans la classe de
l'objet <parameter>obj</parameter>, n'ont pas été
assignées, elles ne seront pas retournées dans le tableau.
<example>
<title>Exemple avec <function>get_object_vars</function></title>
<programlisting role="php">
<?php
class Point2D {
var $x, $y;
var $nom;
function Point2D($x, $y) {
$this->x = $x;
$this->y = $y;
}
function donne_nom($nom) {
$this->nom = $nom;
}
function LitPoint() {
return array("x" -> $this->x,
"y" -> $this->y,
"nom" -> $this->nom);
}
}
$p1 = new Point2D(1.233, 3.445);
print_r(get_object_vars($p1));
// "$nom" est déclaré, mais non défini
// Array
// (
// [x] -> 1.233
// [y] -> 3.445
// )
$p1->setnom("point #1");
print_r(get_object_vars($p1));
// Array
// (
// [x] -> 1.233
// [y] -> 3.445
// [nom] -> point #1
// )
?>
</programlisting>
</example>
</para>
<simpara>
Voir aussi
<function>get_class_methods</function> et
<function>get_class_vars</function>
</simpara>
</refsect1>
</refentry>
<refentry id="function.get-parent-class">
<refnamediv>
<refname>get_parent_class</refname>
<refpurpose>Retourne le nom de la classe d'un objet</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>get_parent_class</methodname>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
</methodsynopsis>
<para>
<function>get_parent_class</function> retourne le nom de la classe
de l'objet <parameter>obj</parameter>.
</para>
<simpara>
Voir aussi
<function>get_class</function> et
<function>is_subclass_of</function>
</simpara>
</refsect1>
</refentry>
<refentry id="function.is-subclass-of">
<refnamediv>
<refname>is_subclass_of</refname>
<refpurpose>
Détermine si un objet est une sous-classe
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>is_subclass_of</methodname>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
<methodparam><type>string</type><parameter>superclass</parameter></methodparam>
</methodsynopsis>
<para>
<function>is_subclass_of</function> retourne <literal>TRUE</literal> si l'objet
<parameter>obj</parameter> est une sous-classe de
<parameter>superclass</parameter>, <literal>FALSE</literal> sinon.
</para>
<simpara>
Voir aussi
<function>get_class</function> et
<function>get_parent_class</function>
</simpara>
</refsect1>
</refentry>
<refentry id="function.method-exists">
<refnamediv>
<refname>method_exists</refname>
<refpurpose>
Vérifie que la méthode existe pour une classe.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>method_exists</methodname>
<methodparam><type>object</type><parameter>object</parameter></methodparam>
<methodparam><type>string</type><parameter>method_name</parameter></methodparam>
</methodsynopsis>
<para>
<function>method_exists</function> retourne <literal>TRUE</literal>
si la méthode <parameter>method_name</parameter> a
été définie pour la classe
<parameter>object</parameter>, et sinon, retourne <literal>FALSE</literal>.
</para>
</refsect1>
</refentry>
</reference>
<!-- 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:
-->
|