PHP中的Magic Methods

 

下面我将对 PHP 所有的魔术方法进行介绍说明。其实下面的大多数方法，对于一个合格的 PHP 程序员来说，都是很熟悉的东西了。我在这里作个总结，自己作个记录学习，同时也给还未熟悉这些方法的同学们做个介绍。如有疏漏和错误，希望各位能指出。下面所提到的，大多数是 PHP5 所增加的魔术方法，少部分在 PHP4 里就已经存在，少部分则是 PHP5.1.0 之后才出现的，这个在下面我将会提到。

__construct() 和 __destruct()
构造函数 __construct() 和析构函数 __destruct() ，这两个不用我多说了吧，是个程序员都知道。 __construct() 会在实例创建的时候被调用 ,__destruct() 在实例销毁的时候被调用。需要注意的时候，即使你不显式地调用 unset 去销毁一个实例，它也会在脚本运行结束的时候被销毁。这两个方法都可以传递 0 个或者多个参数。

<?php

class o

{

    public function __construct()

    {

        echo 'building instance';

    }

    public function __destruct()

    {

        echo 'destroy instance';

    }

}

$i = new o;

unset($i);// 这句有无都不影响最后的输出。__destruct()总是会被调用的

// 输出

//building instance

//destroy instance

?>

__get, __set, __isset, __unset
当对一个属性进行操作的时候，如果该属性不可获得（不存在，或者当前环境不可调用该属性，例如在子类中调用一个父类的 private 属性），则调用以上方法的其中一个。调用什么方法是依据对属性所进行的操作。注：在 php 5.0.* 里，这 4 个方法必须为 public 。
__get
触发事件：调用属性
参数 1 ：所调用的属性名
例子：

<?php

class o

{

     protected function __get($var)

     {

         return 'No Member:'.$var;

     }

}

$i=new o();

echo $i->name; // 输出 No Member:name

?>

<?php

class o

{

     private   $name='surfchen';// 注意这里的private

     protected function __get($var)

     {

         return 'No Member:'.$var;

     }

}

class child extends o

{

        function test()

        {

               echo $this->name;

        }

}

$c=new child();

echo $c->test(); // 输出 No Member:name

?>

__set
触发事件：对一个属性进行赋值
参数 1 ：所调用的属性名
参数 2 ：所赋予的值
例子：

<?php

class o

{

        protected function __set($var,$val)

        {

               echo 'setting '.$var.' to '.$val."/n";

        }

}

$c=new o();

echo $c->name='wolfzeus';

/*

输出：

setting name to wolfzeus

wolfzeus

*/

?>

__isset
触发事件：用 isset 检测属性是否存在
参数 1 ：所调用的属性名
例子：

<?php

class o

{

        protected function __isset($var)

        {

               echo $var.' have not been set';

        }

}

$c=new o();

isset($c->name);

/*

输出：name have not been set

*/

?>

__unset
触发事件： unset 一个属性（无论这个属性是否存在）
参数 1 ：所调用的属性名
例子：

<?php

class o

{

        protected function __unset($var)

        {

               echo $var.' is unset';

        }

}

$c=new o();

unset($c->name);

/*

输出：

name is unset

*/

?>

__call($func,$para)
当尝试调用一个对象的方法的时候，如果该方法不存在，则调用 __call($func,$para) 方法。这个方法必须有两个参数，第一个为调用的方法名，第二个是一个被调用方法的参数数组。需要注意的是，当你在一个子类调用父类的 private 的方法，或者在实例里调用类的非 protect 方法的时候，并不会调用 __call() ，这是 __call 和 __get 等属性操作方法的一个不同点。

<?php

class o

{

        protected function __call($func,$para)

        {

               echo 'No Method:'.$func."/n".'With Below Parameters:'."/n";

               print_r($para);

        }

}

$c=new o();

echo $c->getNames('programmer','geek');

/*

输出:

No Method:getNames

With Below Parameters:

Array

(

    [0] => programmer

    [1] => geek

)

*/

?>

__sleep(), __wakeup()
__sleep 是当序列化 (serialize) 一个实例的时候被调用， __wakeup() 则是在反序列化 (unserialize) 的时候被调用。需要注意一点，就是 __sleep() 必须返回一个数组或者对象（一般返回的是 $this ），返回的值将会被用来做为序列化的值。如果不返回这个值，则序列化失败。这也意味着反序列化将不会触发 __wakeup 事件。下面是一个可用的例子。

<?php

class o

{

        public $a='xx';

        public $b='55';

        function __sleep()

        {

               echo "I am sleepy/n";

               return $this;

        }

        function __wakeup()

        {

               echo "wake up!/n";

        }

}

$i = new o;

$si = serialize($i);

echo "sleeping now...../n";

print_r(unserialize($si));

?>

__toString()
当直接打印一个对象的时候，这个方法将会被调用。
例子：

<?php

class o

{

        private $name = 'surfchen';

        public function __toString()

        {

               return $this->name;

        }

}

$i = new o;

echo 'name:',$i;// 注意这里连接name和变量$i的是逗号而不是句号

?>

__set_state()
var_export 可以把一个集合导出为一串字符串，这些字符串是一些可执行的 PHP 代码。在 php5.1.0 的面向对象里，引入了一个叫 __set_state 的静态方法来使得 var_export 支持对象实例的导出。当用 var_export 导出一个实例的时候，所导出字符串里，是调用这个静态方法的代码。这个方法有一个参数，为包含所导出的实例的所有成员属性的一个数组。有点抽象，看下面的例子吧。

<?php

class o

{

        public $skill='php';

        public static function __set_state($arr)

        {

               foreach ($arr as $k => $v) {

                       $obj->$k = $v;

               }

               return $obj;

        }

}

$i = new o;

$i->age = 21;

eval('$b = '.var_export($i,true).';');// 这里的true表示var_export返回所导出的字符串，而不是把它打印出来。

print_r($b);

/*

输出：

stdClass Object

(

    [skill] => php

    [age] => 21

)

*/

?>

__clone()
在 php5 里，对象间的赋值总是以地址引用来传递的。例如下面这个例子，将会输出 66 ，而不是 55.

<?php

class o

{

        public $age = 55;

}

$i   = new o;

$i2 = $i;

$i->age = 66;

echo $i2->age;

?>

如果要以实际值来传递，则需要用到 clone 关键词。

<?php

class o

{

        public $age = 55;

}

$i   = new o;

$i2 = clone $i;

$i->age = 66;

echo $i2->age;// 输出55

?>

但是，这里 clone 的只是 $i 这个实例。如果 $i 的某个成员属性也是个实例，那么这个成员属性还是会以引用方法被传递到 $i2 的。例如下面这个例子：

<?php

class o

{

        public $age = 55;

        public $sub = null;

}

class o2

{

        public $p=1;

}

$i   = new o;

$i->sub=new o2;

$i2 = clone $i;

$i->sub->p=5;

echo $i2->sub->p;

?>

最后输出的是 5 ，而不是 1 。也就是说， $i 和 $i2 虽然不是指向的虽然不是同一个实例，但是它们的成员属性 $sub 却是指向同一个实例。这时候，我们必须借助 __clone 这个方法来对 $sub 进行复制。在 o 类里，加入 __clone() 方法。如下：

<?php

class o

{

        public $age = 55;

        public $sub = null;

        public function __clone()

        {

               $this->sub=clone $this->sub;

        }

}

//......

?>

这样，在 echo $i2->sub->p; 的时候，输出的就是传递时候的值 1 了。
__autoload()
当创建一个实例化的时候，如果对应的类不存在， __autoload() 将会被执行，这个函数有一个参数，为所要创建的实例对应的类名。在下面的例子里，当创建一个 test 类的实例的时候，如果 /home/surfchen/project/auto.php 存在，则 require 这个文件，否则打印一个 Class test Not Found 的错误，并中止当前脚本。

<?php

function __autoload($class_name) {

        if ($class_name == 'test') {

               $class_file = '/home/surfchen/project/auto.php';

        }

        if (is_file($class_file)) {

               require_once $class_file;

               return true;

        }

        echo 'Class '.$class_name.' Not Found';

        exit();

}

$o=new test();

echo $o->a;

?>