PHP
Волшебные методы
Поиск…
__get (), __set (), __isset () и __unset ()
Всякий раз, когда вы пытаетесь получить определенное поле из класса, например:
$animal = new Animal();
$height = $animal->height;
PHP вызывает магический метод __get($name) , в этом случае $name равно "height" . Запись в поле класса следующим образом:
$animal->height = 10;
__set($name, $value) магический метод __set($name, $value) , с $name равным "height" и $value равным 10 .
PHP также имеет две встроенные функции isset() , которые проверяют, существует ли переменная, и unset() , которая уничтожает переменную. Проверка того, установлено ли поле объектов так:
isset($animal->height);
Будет вызывать __isset($name) для этого объекта. Уничтожение такой переменной:
unset($animal->height);
Будет вызывать __unset($name) для этого объекта.
Обычно, когда вы не определяете эти методы в своем классе, PHP просто извлекает поле, поскольку оно хранится в вашем классе. Однако вы можете переопределить эти методы для создания классов, которые могут хранить данные как массив, но могут использоваться как объект:
class Example {
private $data = [];
public function __set($name, $value) {
$this->data[$name] = $value;
}
public function __get($name) {
if (!array_key_exists($name, $this->data)) {
return null;
}
return $this->data[$name];
}
public function __isset($name) {
return isset($this->data[$name]);
}
public function __unset($name) {
unset($this->data[$name]);
}
}
$example = new Example();
// Stores 'a' in the $data array with value 15
$example->a = 15;
// Retrieves array key 'a' from the $data array
echo $example->a; // prints 15
// Attempt to retrieve non-existent key from the array returns null
echo $example->b; // prints nothing
// If __isset('a') returns true, then call __unset('a')
if (isset($example->a)) {
unset($example->a));
}
empty () и магические методы
Обратите внимание, что вызов empty() в атрибуте class будет вызывать __isset() поскольку в руководстве PHP указано:
empty () по существу является кратким эквивалентом ! isset ($ var) || $ var == false
__construct () и __destruct ()
__construct() является наиболее распространенным магическим методом в PHP, потому что он используется для установки класса при его инициализации. Противоположностью метода __construct() является метод __destruct() . Этот метод вызывается, когда больше нет ссылок на созданный объект или когда вы принудительно удаляете его. Сбор мусора PHP очистит объект, сначала вызвав его деструктор, а затем удалив его из памяти.
class Shape {
public function __construct() {
echo "Shape created!\n";
}
}
class Rectangle extends Shape {
public $width;
public $height;
public function __construct($width, $height) {
parent::__construct();
$this->width = $width;
$this->height = $height;
echo "Created {$this->width}x{$this->height} Rectangle\n";
}
public function __destruct() {
echo "Destroying {$this->width}x{$this->height} Rectangle\n";
}
}
function createRectangle() {
// Instantiating an object will call the constructor with the specified arguments
$rectangle = new Rectangle(20, 50);
// 'Shape Created' will be printed
// 'Created 20x50 Rectangle' will be printed
}
createRectangle();
// 'Destroying 20x50 Rectangle' will be printed, because
// the `$rectangle` object was local to the createRectangle function, so
// When the function scope is exited, the object is destroyed and its
// destructor is called.
// The destructor of an object is also called when unset is used:
unset(new Rectangle(20, 50));
__нанизывать()
Всякий раз, когда объект рассматривается как строка, вызывается метод __toString() . Этот метод должен возвращать строковое представление класса.
class User {
public $first_name;
public $last_name;
public $age;
public function __toString() {
return "{$this->first_name} {$this->last_name} ($this->age)";
}
}
$user = new User();
$user->first_name = "Chuck";
$user->last_name = "Norris";
$user->age = 76;
// Anytime the $user object is used in a string context, __toString() is called
echo $user; // prints 'Chuck Norris (76)'
// String value becomes: 'Selected user: Chuck Norris (76)'
$selected_user_string = sprintf("Selected user: %s", $user);
// Casting to string also calls __toString()
$user_as_string = (string) $user;
__invoke ()
Этот волшебный метод вызывается, когда пользователь пытается вызвать объект как функцию. Возможные варианты использования могут включать некоторые подходы, такие как функциональное программирование или некоторые обратные вызовы.
class Invokable
{
/**
* This method will be called if object will be executed like a function:
*
* $invokable();
*
* Args will be passed as in regular method call.
*/
public function __invoke($arg, $arg, ...)
{
print_r(func_get_args());
}
}
// Example:
$invokable = new Invokable();
$invokable([1, 2, 3]);
// optputs:
Array
(
[0] => 1
[1] => 2
[2] => 3
)
__call () и __callStatic ()
__call() и __callStatic() вызываются , когда кто - то называет несуществующий метод объекта в объекте или статическом контексте.
class Foo
{
/**
* This method will be called when somebody will try to invoke a method in object
* context, which does not exist, like:
*
* $foo->method($arg, $arg1);
*
* First argument will contain the method name(in example above it will be "method"),
* and the second will contain the values of $arg and $arg1 as an array.
*/
public function __call($method, $arguments)
{
// do something with that information here, like overloading
// or something generic.
// For sake of example let's say we're making a generic class,
// that holds some data and allows user to get/set/has via
// getter/setter methods. Also let's assume that there is some
// CaseHelper which helps to convert camelCase into snake_case.
// Also this method is simplified, so it does not check if there
// is a valid name or
$snakeName = CaseHelper::camelToSnake($method);
// Get get/set/has prefix
$subMethod = substr($snakeName, 0, 3);
// Drop method name.
$propertyName = substr($snakeName, 4);
switch ($subMethod) {
case "get":
return $this->data[$propertyName];
case "set":
$this->data[$propertyName] = $arguments[0];
break;
case "has":
return isset($this->data[$propertyName]);
default:
throw new BadMethodCallException("Undefined method $method");
}
}
/**
* __callStatic will be called from static content, that is, when calling a nonexistent
* static method:
*
* Foo::buildSomethingCool($arg);
*
* First argument will contain the method name(in example above it will be "buildSomethingCool"),
* and the second will contain the value $arg in an array.
*
* Note that signature of this method is different(requires static keyword). This method was not
* available prior PHP 5.3
*/
public static function __callStatic($method, $arguments)
{
// This method can be used when you need something like generic factory
// or something else(to be honest use case for this is not so clear to me).
print_r(func_get_args());
}
}
Пример:
$instance = new Foo();
$instance->setSomeState("foo");
var_dump($instance->hasSomeState()); // bool(true)
var_dump($instance->getSomeState()); // string "foo"
Foo::exampleStaticCall("test");
// outputs:
Array
(
[0] => exampleCallStatic
[1] => test
)
__sleep () и __wakeup ()
__sleep и __wakeup - это методы, связанные с процессом сериализации. Функция serialize проверяет, имеет ли __sleep метод __sleep . Если это так, оно будет выполнено до любой сериализации. __sleep возвращает массив имен всех переменных объекта, который должен быть сериализован.
__wakeup в свою очередь, будет выполняться путем unserialize если он присутствует в классе. Это намерение состоит в том, чтобы восстановить ресурсы и другие вещи, которые необходимо инициализировать после несериализации.
class Sleepy {
public $tableName;
public $tableFields;
public $dbConnection;
/**
* This magic method will be invoked by serialize function.
* Note that $dbConnection is excluded.
*/
public function __sleep()
{
// Only $this->tableName and $this->tableFields will be serialized.
return ['tableName', 'tableFields'];
}
/**
* This magic method will be called by unserialize function.
*
* For sake of example, lets assume that $this->c, which was not serialized,
* is some kind of a database connection. So on wake up it will get reconnected.
*/
public function __wakeup()
{
// Connect to some default database and store handler/wrapper returned into
// $this->dbConnection
$this->dbConnection = DB::connect();
}
}
__debugInfo ()
Этот метод вызывается
var_dump()при сбросе объекта, чтобы получить свойства, которые должны быть показаны. Если метод не определен для объекта, будут показаны все общедоступные, защищенные и частные свойства. - Руководство PHP
class DeepThought {
public function __debugInfo() {
return [42];
}
}
var_dump(new DeepThought());
Вышеприведенный пример выводит:
class DeepThought#1 (0) {
}
var_dump(new DeepThought());
Вышеприведенный пример выводит:
class DeepThought#1 (1) {
public ${0} =>
int(42)
}
__clone ()
__clone вызывается использованием ключевого слова clone . Он используется для управления состоянием объекта при клонировании, после того, как объект был фактически клонирован.
class CloneableUser
{
public $name;
public $lastName;
/**
* This method will be invoked by a clone operator and will prepend "Copy " to the
* name and lastName properties.
*/
public function __clone()
{
$this->name = "Copy " . $this->name;
$this->lastName = "Copy " . $this->lastName;
}
}
Пример:
$user1 = new CloneableUser();
$user1->name = "John";
$user1->lastName = "Doe";
$user2 = clone $user1; // triggers the __clone magic method
echo $user2->name; // Copy John
echo $user2->lastName; // Copy Doe