Overloading Classes in PHP 5 - Overloading multiple member accesses: combining the “__set()” and “__get()” method in the same class

(Page 4 of 5 )

Assuming that you already understand the logic for triggering the “__set()” and “__get()” methods individually, combining them into the same class is just a matter of including the signature for each of them within the class you’re going to use. After adding these two methods, the definition of the “DataSaver” class looks like this:

class DataSaver{
    private $data=array('Element1'=>1,'Element2'=>2,'Element3'=>3);
    private $dataFile='default_data_file.txt';
    // define __set() method
    public function __set($index,$value){
        echo 'Assigning value '.'''.$value.'''. ' to element
with index='.$index.'<br />';
        if(!$this->data[$index]){
            throw new Exception('The referenced element is not
valid');
        }
        $this->data[$index]=$value;
    }
    // define __get() method
    public function __get($index){
        echo 'Retrieving element of $data property with
index='.$index.'<br />';
        if(!$this->data[$index]){
            throw new Exception('The referenced element is not
valid');
        }
        return $this->data[$index];
    }
    // save data to file
    public function save(){
        if(!$fp=fopen($this->dataFile,'a+')){
            throw new Exception('Error opening data file');
        }
        fwrite($fp,serialize($this->data));
        fclose($fp);
    }
    // fetch data from file
    public function open(){
        if(!$contents=file_get_contents($this->dataFile)){
            throw new Exception('Error reading from data file');
        }
        return unserialize($contents);
    }
}

At this point, the above class exposes the “__set()” and “__get()” method conjunctly, which comes in very handy for being triggered when overloading two property accesses. This process is illustrated below:

// example of __set() and __get() overloading
try{
    // instantiate 'DataSaver' object
    $dataSaver=new DataSaver();
    // change one element of $data property (calls the __set()
method)
    $dataSaver->Element2='This is element 2';
    // fetch element of $data property (calls the __get() method)
    echo 'The value of the following element property is
'.$dataSaver->Element1;
}
catch(Exception $e){
    echo $e->getMessage();
    exit();
}

In this example, I overloaded two property accesses, in order to trigger in turn the “__set()” and “__get()” methods. I deliberately kept the code simple and readable, so you can see clearly how both methods are called in the script’s context, in addition to examining what type of output is generated by each of them.

All right, after executing the previous code snippet, the following messages are displayed sequentially:

Assigning value 'This is element 2' to element with
index=Element2
Retrieving element of $data property with index=Element1
The value of the following property is 1

Even when the example you saw before is rather trivial, it does demonstrate how two specific property accesses can be overloaded, resulting in the execution of the “__set()” and “__get()” methods respectively.

Do you think we’re done now? Not yet. I want to conclude this article showing you a simple example of how to overload a method call in PHP 5, which can be useful for triggering custom code wrapped into a “__call()” method. Therefore, go ahead and read the next few lines to see how this will be achieved.

Next: Overloading a method call: triggering the “__call()” method >>
 

More PHP Articles
More By Alejandro Gervasio

Comments On: Overloading Classes in PHP 5

· Over this last part of the series, you'll learn how to overload classes in PHP 5....   >>> Post your comment now!