在PHP中,“__sleep()”是一个魔术方法,执行serialize()时,先会调用该方法;它可以用于清理对象,并返回一个包含对象中所有应被序列化的变量名称的数组。“__sleep()”方法常用于提交未提交的数据,或类似的清理操作。
本教程操作环境:windows7系统、PHP7.1版,DELL G3电脑
PHP中__sleep()方法详解
__sleep(),执行serialize()时,先会调用这个函数
serialize() 函数会检查类中是否存在一个魔术方法 __sleep()。如果存在,则该方法会优先被调用,然后才执行序列化操作。
此功能可以用于清理对象,并返回一个包含对象中所有应被序列化的变量名称的数组。
如果该方法未返回任何内容,则 NULL 被序列化,并产生一个 E_NOTICE 级别的错误。
注意:
__sleep() 不能返回父类的私有成员的名字。这样做会产生一个 E_NOTICE 级别的错误。可以用 Serializable 接口来替代。
作用:
__sleep() 方法常用于提交未提交的数据,或类似的清理操作。同时,如果有一些很大的对象,但不需要全部保存,这个功能就很好用。
【推荐学习:《PHP视频教程》】
具体请参考如下代码:
<?php class Person { public $sex; public $name; public $age; public function __construct($name="", $age=25, $sex='男') { $this->name = $name; $this->age = $age; $this->sex = $sex; } /** * @return array */ public function __sleep() { echo "当在类外部使用serialize()时会调用这里的__sleep()方法<br>"; $this->name = base64_encode($this->name); return array('name', 'age'); // 这里必须返回一个数值,里边的元素表示返回的属性名称 } } $person = new Person('小明'); // 初始赋值 echo serialize($person); echo '<br/>';
代码运行结果:
当在类外部使用serialize()时会调用这里的__sleep()方法 O:6:"Person":2:{s:4:"name";s:8:"5bCP5piO";s:3:"age";i:25;}
扩展知识:
魔术方法
在利用对PHP反序列化进行利用时,经常需要通过反序列化中的魔术方法,检查方法里有无敏感操作来进行利用。
PHP 将所有以 __(两个下划线)开头的类方法保留为魔术方法。
常见的魔术方法
__construct()//创建对象时触发
__destruct() //对象被销毁时触发
__call() //在对象上下文中调用不可访问的方法时触发
__callStatic() //在静态上下文中调用不可访问的方法时触发
__get() //用于从不可访问的属性读取数据
__set() //用于将数据写入不可访问的属性
__isset() //在不可访问的属性上调用isset()或empty()触发
__unset() //在不可访问的属性上使用unset()时触发
__invoke() //当脚本尝试将对象调用为函数时触发
__sleep() //此功能可以用于清理对象,并返回一个包含对象中所有应被序列化的变量名称的数组。
__wakeup() //经常用在反序列化操作中,例如重新建立数据库连接,或执行其它初始化操作。
php魔术方法官方文档 :https://www.php.net/manual/zh/language.oop5.magic.php