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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- State: deprecated -->
<reference id="ref.overload">
<title>Object property and method call overloading</title>
<titleabbrev>Object overloading</titleabbrev>
<partintro>
<section id="overload.intro">
&reftitle.intro;
<para>
The purpose of this extension is to allow overloading of object
property access and method calls. Only one function is defined
in this extension, <function>overload</function> which
takes the name of the class that should have this functionality
enabled. The class named has to define appropriate methods if
it wants to have this functionality: <literal>__get()</literal>,
<literal>__set()</literal> and <literal>__call()</literal>
respectively for getting/setting a property, or calling a method.
This way overloading can be selective. Inside these handler
functions the overloading is disabled so you can access object
properties normally.
</para>
&warn.experimental;
<warning>
<para>
This extension is not a part of PHP 5. PHP 5 supports <literal>__get()</literal>, <literal>__set()</literal> and
<literal>__call()</literal> natively. See the <link
linkend="language.oop5.overloading">Overloading in PHP 5</link> page
for more information.
</para>
</warning>
</section>
<section id="overload.requirements">
&reftitle.required;
&no.requirement;
</section>
&reference.overload.configure;
<section id="overload.configuration">
&reftitle.runtime;
&no.config;
</section>
<section id="overload.resources">
&reftitle.resources;
&no.resource;
</section>
<section id="overload.constants">
&reftitle.constants;
&no.constants;
</section>
<section id="overload.examples">
&reftitle.examples;
<para>
Some simple examples on using the <function>overload</function>
function:
<example>
<title>Overloading a PHP class</title>
<programlisting role="php">
<![CDATA[
<?php
class OO {
var $a = 111;
var $elem = array('b' => 9, 'c' => 42);
// Callback method for getting a property
function __get($prop_name, &$prop_value)
{
if (isset($this->elem[$prop_name])) {
$prop_value = $this->elem[$prop_name];
return true;
} else {
return false;
}
}
// Callback method for setting a property
function __set($prop_name, $prop_value)
{
$this->elem[$prop_name] = $prop_value;
return true;
}
}
// Here we overload the OO object
overload('OO');
$o = new OO;
echo "\$o->a: $o->a\n"; // print: $o->a: 111
echo "\$o->b: $o->b\n"; // print: $o->b: 9
echo "\$o->c: $o->c\n"; // print: $o->c: 42
echo "\$o->d: $o->d\n"; // print: $o->d:
// add a new item to the $elem array in OO
$o->x = 56;
// instantiate stdclass (it is built-in in PHP 4)
// $val is not overloaded!
$val = new stdclass;
$val->prop = 555;
// Set "a" to be an array with the $val object in it
// But __set() will put this in the $elem array
$o->a = array($val);
var_dump($o->a[0]->prop);
?>
]]>
</programlisting>
</example>
</para>
</section>
</partintro>
&reference.overload.functions;
</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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|