PHP.nl

Overloading

Overloading

Overloading in PHP provides means to dynamically properties and methods. These dynamic entities are processed via magic methods one can establish in a class for various action types.

The overloading methods are invoked when interacting with properties or methods that have not been declared or are not in the current scope. The rest of this section will use the terms and to refer to this combination of declaration and visibility. visible

All overloading methods must be defined as . public

Opmerking: > None of the arguments of these magic methods can be . passed by reference

Opmerking: > PHP's interpretation of is different than most object-oriented languages. Overloading traditionally provides the ability to have multiple methods with the same name but different quantities and types of arguments.

Property overloading

void **__set** string $name mixed $value
mixed **__get** string $name
bool **__isset** string $name
void **__unset** string $name
 is run when writing data to
inaccessible (protected or private) or non-existing properties.

__set()

 is utilized for reading data from
inaccessible (protected or private) or non-existing properties.

__get()

 is triggered by calling
 or 
on inaccessible (protected or private) or non-existing properties.

__isset()isset``empty

 is invoked when
 is used on inaccessible (protected or private)
or non-existing properties.

__unset()unset

The  argument is the name of the
property being interacted with. The 
method's  argument specifies the
value the 'ed property should be set
to.

$name__set()$value``$name

Property overloading only works in object context. These magic
methods will not be triggered in static context. Therefore
these methods should not be declared
.
A warning is issued if one of the magic overloading 
methods is declared .

staticstatic

Opmerking: > The return value of is ignored because of the way PHP processes the assignment operator. Similarly, is never called when chaining assignments together like this:

__set()__get()`$a = $obj->b = 8;`

Opmerking: > PHP will not call an overloaded method from within the same overloaded method. That means, for example, writing inside of will return and raise an if there is no property defined, rather than calling a second time. However, overload methods may invoke other overload methods implicitly (such as triggering ). return $this->foo__get()null``E_WARNING``foo__get()__set()__get()

**Voorbeeld: Overloading properties via the , , and methods **

<?php
class PropertyTest
{
    /**  Location for overloaded data.  */
    private $data = array();

    /**  Overloading not used on declared properties.  */
    public $declared = 1;

    /**  Overloading only used on this when accessed outside the class.  */
    private $hidden = 2;

    public function __set($name, $value)
    {
        echo "Setting '$name' to '$value'\n";
        $this->data[$name] = $value;
    }

    public function __get($name)
    {
        echo "Getting '$name'\n";
        if (array_key_exists($name, $this->data)) {
            return $this->data[$name];
        }

        $trace = debug_backtrace();
        trigger_error(
            'Undefined property via __get(): ' . $name .
            ' in ' . $trace[0]['file'] .
            ' on line ' . $trace[0]['line'],
            E_USER_NOTICE);
        return null;
    }

    public function __isset($name)
    {
        echo "Is '$name' set?\n";
        return isset($this->data[$name]);
    }

    public function __unset($name)
    {
        echo "Unsetting '$name'\n";
        unset($this->data[$name]);
    }

    /**  Not a magic method, just here for example.  */
    public function getHidden()
    {
        return $this->hidden;
    }
}


$obj = new PropertyTest;

$obj->a = 1;
echo $obj->a . "\n\n";

var_dump(isset($obj->a));
unset($obj->a);
var_dump(isset($obj->a));
echo "\n";

echo $obj->declared . "\n\n";

echo "Let's experiment with the private property named 'hidden':\n";
echo "Privates are visible inside the class, so __get() not used...\n";
echo $obj->getHidden() . "\n";
echo "Privates not visible outside of class, so __get() is used...\n";
echo $obj->hidden . "\n";
?>
Setting 'a' to '1'
Getting 'a'
1

Is 'a' set?
bool(true)
Unsetting 'a'
Is 'a' set?
bool(false)

1

Let's experiment with the private property named 'hidden':
Privates are visible inside the class, so __get() not used...
2
Privates not visible outside of class, so __get() is used...
Getting 'hidden'


Notice:  Undefined property via __get(): hidden in <file> on line 70 in <file> on line 29

Method overloading

mixed **__call** string $name array $arguments
mixed **__callStatic** string $name array $arguments
 is triggered when invoking
inaccessible methods in an object context.

__call()

 is triggered when invoking
inaccessible methods in a static context.

__callStatic()

The  argument is the name of the
method being called. The 
argument is an enumerated array containing the parameters
passed to the 'ed method.

$name``$arguments``$name

**Voorbeeld: Overloading methods via the and methods **

<?php
class MethodTest
{
    public function __call($name, $arguments)
    {
        // Note: value of $name is case sensitive.
        echo "Calling object method '$name' "
             . implode(', ', $arguments). "\n";
    }

    public static function __callStatic($name, $arguments)
    {
        // Note: value of $name is case sensitive.
        echo "Calling static method '$name' "
             . implode(', ', $arguments). "\n";
    }
}

$obj = new MethodTest;
$obj->runTest('in object context');

MethodTest::runTest('in static context');
?>
Calling object method 'runTest' in object context
Calling static method 'runTest' in static context