Какие магические методы существуют в PHP и как они используются?

Магические методы в PHP - это специальные методы, начинающиеся с двойного подчеркивания (например, __construct), которые автоматически вызываются в определенных ситуациях.

Основные магические методы и их использование:

• __construct(): Вызывается при создании объекта класса. Используется для инициализации свойств объекта и выполнения начальных действий.

  <?php
  class MyClass {
      public function __construct() {
          echo "Объект создан!";
      }
  }
  $obj = new MyClass(); // Выведет "Объект создан!"
  

• __destruct(): Вызывается при уничтожении объекта (например, когда скрипт завершается или объект удаляется из памяти). Используется для освобождения ресурсов (закрытие файлов, соединений с базами данных).

  <?php
  class MyClass {
      public function __destruct() {
          echo "Объект уничтожен!";
      }
  }
  $obj = new MyClass();
  unset($obj); // Выведет "Объект уничтожен!"
  

• __call(string $name, array $arguments): Вызывается при попытке вызвать недоступный или несуществующий метод в контексте объекта. $name содержит имя метода, а $arguments - массив аргументов.

  <?php
  class MyClass {
      public function __call($name, $arguments) {
          echo "Вызван недоступный метод '{$name}' с аргументами: " . implode(', ', $arguments);
      }
  }
  $obj = new MyClass();
  $obj->nonExistentMethod('arg1', 'arg2'); // Выведет "Вызван недоступный метод 'nonExistentMethod' с аргументами: arg1, arg2"
  

• __callStatic(string $name, array $arguments): Вызывается при попытке вызвать недоступный или несуществующий статический метод в контексте класса. Аналогичен __call, но для статических вызовов.

  <?php
  class MyClass {
      public static function __callStatic($name, $arguments) {
          echo "Вызван недоступный статический метод '{$name}' с аргументами: " . implode(', ', $arguments);
      }
  }
  MyClass::nonExistentStaticMethod('static_arg'); // Выведет "Вызван недоступный статический метод 'nonExistentStaticMethod' с аргументами: static_arg"
  

• __get(string $name): Вызывается при попытке получить значение недоступного или несуществующего свойства в контексте объекта. $name содержит имя свойства.

  <?php
  class MyClass {
      private $data = ['key' => 'value'];
      public function __get($name) {
          if (array_key_exists($name, $this->data)) {
              return $this->data[$name];
          }
          return null;
      }
  }
  $obj = new MyClass();
  echo $obj->key; // Выведет "value"
  echo $obj->nonExistentKey; // Выведет пустую строку (в зависимости от возвращаемого значения null)
  

• __set(string $name, mixed $value): Вызывается при попытке установить значение недоступного или несуществующего свойства в контексте объекта. $name содержит имя свойства, а $value - устанавливаемое значение.

  <?php
  class MyClass {
      private $data = [];
      public function __set($name, $value) {
          $this->data[$name] = $value;
      }
      public function getData() {
          return $this->data;
      }
  }
  $obj = new MyClass();
  $obj->newKey = 'newValue';
  print_r($obj->getData()); // Выведет Array ( [newKey] => newValue )
  

• __isset(string $name): Вызывается при вызове isset() или empty() на недоступном или несуществующем свойстве в контексте объекта. Возвращает булево значение.

  <?php
  class MyClass {
      private $data = ['present' => 'value'];
      public function __isset($name) {
          return array_key_exists($name, $this->data);
      }
  }
  $obj = new MyClass();
  var_dump(isset($obj->present));     // Выведет bool(true)
  var_dump(isset($obj->absent));      // Выведет bool(false)
  

• __unset(string $name): Вызывается при вызове unset() на недоступном или несуществующем свойстве в контексте объекта.

  <?php
  class MyClass {
      private $data = ['remove_me' => 'value_to_remove'];
      public function __unset($name) {
          if (array_key_exists($name, $this->data)) {
              unset($this->data[$name]);
              echo "Свойство '{$name}' удалено.\n";
          }
      }
      public function getData() {
          return $this->data;
      }
  }
  $obj = new MyClass();
  print_r($obj->getData());
  unset($obj->remove_me); // Выведет "Свойство 'remove_me' удалено." и удалит элемент из $data
  print_r($obj->getData());
  

• __sleep(): Вызывается перед сериализацией объекта с использованием serialize(). Должен вернуть массив имен свойств, которые необходимо сериализовать.

  <?php
  class MyClass {
      public $prop1 = 'value1';
      public $prop2 = 'value2';
      public function __sleep() {
          return ['prop1']; // Сериализуем только prop1
      }
  }
  $obj = new MyClass();
  $serialized = serialize($obj); // Сериализует только prop1
  echo $serialized; // Выведет примерно O:7:"MyClass":1:{s:5:"prop1";s:6:"value1";}
  

• __wakeup(): Вызывается после десериализации объекта с использованием unserialize(). Используется для восстановления соединений с базами данных или других действий, необходимых после восстановления объекта.

  <?php
  class MyClass {
      public $prop1;
      public $resource; // Предположим, это ресурс соединения
      public function __wakeup() {
          // Восстановить ресурс, например, соединение с базой данных
          $this->resource = fopen('/tmp/my_file.txt', 'w'); // Пример
          echo "Объект разбужен и ресурс восстановлен!\n";
      }
      public function __sleep() {
          // В __sleep мы не сериализуем ресурс
          return ['prop1'];
      }
      public function __destruct() {
          if (is_resource($this->resource)) {
              fclose($this->resource);
              echo "Ресурс закрыт.\n";
          }
      }
  }
  $obj = new MyClass();
  $obj->prop1 = 'deserialized value';
  $serialized = serialize($obj);
  unset($obj);
  
  $deserialized_obj = unserialize($serialized); // Вызовет __wakeup()
  var_dump($deserialized_obj->prop1);
  

• __toString(): Вызывается, когда объект используется как строка (например, при echo или конкатенации). Должен вернуть строковое представление объекта.

  <?php
  class MyClass {
      public $name = "MyObject";
      public function __toString() {
          return "Объект типа MyClass с именем: " . $this->name;
      }
  }
  $obj = new MyClass();
  echo $obj; // Выведет "Объект типа MyClass с именем: MyObject"
  

• __invoke(...): Вызывается при попытке вызвать объект как функцию. Может принимать любое количество аргументов.

  <?php
  class MyCallableClass {
      public function __invoke(...$args) {
          echo "Объект был вызван как функция с аргументами: " . implode(', ', $args);
      }
  }
  $obj = new MyCallableClass();
  $obj('arg1', 123); // Выведет "Объект был вызван как функция с аргументами: arg1, 123"
  

• __set_state(array $properties): Вызывается статически для классов экспортированных с помощью var_export(). Получает массив экспортированных свойств. Должен создать новый объект класса и вернуть его.

  <?php
  class MyClass {
      public $prop;
      public static function __set_state(array $properties) {
          $obj = new MyClass();
          $obj->prop = $properties['prop'];
          return $obj;
      }
  }
  $obj = new MyClass();
  $obj->prop = 'exported value';
  $exported = var_export($obj, true); // Экспортирует объект
  // $exported будет содержать код для создания объекта, использующий __set_state()
  eval('$restored_obj = ' . $exported . ';');
  var_dump($restored_obj); // Выведет объект MyClass с проперти 'exported value'
  

• __debugInfo(): Вызывается при вызове функций типа var_dump() для объекта. Метод должен возвращать массив с информацией о свойствах объекта, которые должны быть отображены.

  <?php
  class MyClass {
      public $publicProp = 'public';
      private $privateProp = 'private';
      public function __debugInfo() {
          return ['publicProp' => $this->publicProp, 'private_info' => 'некоторые детали о privateProp'];
      }
  }
  $obj = new MyClass();
  var_dump($obj); // Выведет информацию, возвращаемую __debugInfo()
  

• __clone(): Вызывается после операции клонирования (clone) объекта. Используется для глубокого копирования внутренних объектов или структур данных.

  <?php
  class SubObject {
      public $value;
      public function __construct($value) {
          $this->value = $value;
      }
  }
  class MyClass {
      public $object;
      public $anotherProp;
      public function __construct() {
          $this->object = new SubObject('initial');
          $this->anotherProp = 'original';
      }
      public function __clone() {
          // Клонируем вложенный объект для глубокого копирования
          $this->object = clone $this->object;
      }
  }
  $obj = new MyClass();
  $cloned_obj = clone $obj;
  
  // Теперь $obj->object и $cloned_obj->object - разные экземпляры SubObject
  $cloned_obj->object->value = 'modified';
  
  var_dump($obj->object->value);       // Выведет "initial"
  var_dump($cloned_obj->object->value); // Выведет "modified"
  

Таблица с кратким описанием: