Методы __sleep() и __wakeup() ¶

Функция serialize() проверяет, определили ли в классе метод с магическим именем __sleep(). Если метод определили, он выполняется перед сериализацией. Метод может очистить объект и должен вернуть массив с именами всех переменных этого объекта, которые должны быть сериализованы. Если метод ничего не возвращает, то сериализуется константа null и выдаётся предупреждение E_NOTICE.

Замечание:

Методу __sleep() нельзя возвращать имена закрытых свойств в родительских классах. Это приведёт к ошибке уровня E_NOTICE. Вместо этого используйте метод __serialize().

Замечание:

Начиная с PHP 8.0.0 возврат из метода __sleep() значения, которое не является массивом, генерирует предупреждение. Раньше выдавалось уведомление.

Назначение метода __sleep() — зафиксировать отложенные данные или выполнить аналогичные задачи очистки. Метод также будет полезным, когда требуется сохранить только часть объекта.

И наоборот, функция unserialize() проверяет наличие метода с магическим именем __wakeup(). Если метод определили, функция может восстанавливать любые ресурсы, которые может иметь объект.

Назначение метода __wakeup() — восстановить соединения с базой данных, которые могли потеряться во время сериализации, и выполнить другие задачи повторной инициализации.

Методы __serialize() и __unserialize() ¶

Функция serialize() проверяет, определили ли в классе метод с магическим именем __serialize(). Если метод определили, функция выполняется перед сериализацией. Метод должен создать и вернуть ассоциативный массив пар ключ и значение, которые представляют сериализованную форму объекта. Если метод не вернул массив, выбрасывается исключение TypeError.

Замечание:

Если в одном и том же объекте определили оба метода — и __serialize(), и __sleep(), PHP вызовет только метод __serialize(). Метод __sleep() проигнорируется. Если объект реализует интерфейс Serializable, PHP проигнорирует интерфейсный метод serialize(), и вместо него будет использовать метод __serialize().

Назначение метода __serialize() заключается в определении удобного для сериализации произвольного представления объекта. Элементам массива разрешается соответствовать свойствам объекта, но это не обязательно.

И наоборот, функция unserialize() проверяет присутствие магического метода __unserialize(). Если метод определили, PHP передаст методу массив, который восстановил и вернул метод __serialize(). Затем, если нужно, метод восстанавливает свойства объекта из этого массива.

Замечание:

Если в одном и том же объекте определили оба метода — и __unserialize(), и __wakeup(), PHP вызовет только метод __unserialize(). Метод __wakeup() проигнорируется.

Замечание:

Функция доступна с PHP 7.4.0.

Метод __toString() ¶

Метод __toString() разрешает классу выбирать, как класс будет реагировать, когда с ним обращаются как со строкой. Например, класс решает, что выведет выражение echo $obj;.

Привет

Метод __invoke() ¶

Метод __invoke() вызывается, когда скрипт пытается выполнить объект как функцию.

int(5)
bool(true)

Array
(
    [0] => Array
        (
            [id] => 3
            [first_name] => Alice
            [last_name] => Gustav
        )

    [1] => Array
        (
            [id] => 2
            [first_name] => Bob
            [last_name] => Filipe
        )

    [2] => Array
        (
            [id] => 1
            [first_name] => John
            [last_name] => Do
        )

)
Array
(
    [0] => Array
        (
            [id] => 1
            [first_name] => John
            [last_name] => Do
        )

    [1] => Array
        (
            [id] => 2
            [first_name] => Bob
            [last_name] => Filipe
        )

    [2] => Array
        (
            [id] => 3
            [first_name] => Alice
            [last_name] => Gustav
        )

)

Метод __set_state() ¶

Этот статический метод вызывается для тех классов, которые экспортируются функцией var_export().

Единственный параметр метода — массив, который содержит экспортируемые свойства в виде ['property' => value, ...].

string(60) "A::__set_state(array(
   'var1' => 5,
   'var2' => 'foo',
))"
object(A)#2 (2) {
  ["var1"]=>
  int(5)
  ["var2"]=>
  string(3) "foo"
}

Замечание: При экспорте объекта функция var_export() не проверяет, реализует ли класс объекта метод __set_state(), поэтому повторный импорт объектов выбросит исключение Error, если метод __set_state() не реализовали. В частности, это относится к ряду внутренних классов. Программист несет ответственность за то, чтобы повторно импортировались только те объекты, класс которых реализует метод __set_state().

Метод __debugInfo() ¶

Этот метод вызывается функцией var_dump(), когда необходимо вывести список свойств объекта. Если этот метод не определили, выводится каждое свойство объекта c модификаторами public, protected и private.

object(C)#1 (1) {
  ["propSquared"]=>
  int(1764)
}