Metoda __callStatic()

Metoda ta pojawiła się stosunkowo niedawno, bo dopiero w PHP 5.3. Jest bardzo podobna do omawianej w poprzedniej części zestawienia metody __call(). Tak jak ona jest używania w momencie wywołania nieistniejącej metody, jednak tylko w przypadku, gdy nastąpiło to w sposób statyczny (tak też musi być sama zdefiniowana). Jako parametry __callStatic() przyjmuje kolejno nazwę wywołanej metody oraz tablicę zawierającą przekazane do niej parametry. Na poniższym przykładzie widać porównanie obu metod:

class TestCall
{
	public function __call($nazwa, $argumenty)
	{
		echo "Wywołano metodę $nazwa z parametrami: " . implode(',', $argumenty) . PHP_EOL;
	}

	public static function __callStatic($nazwa, $argumenty)
	{
		echo "Wywołano statycznie metodę $nazwa z parametrami: " . implode(',', $argumenty) . PHP_EOL;
	}
}
$obj = new TestCall();
$obj->nieistniejacaMetoda('normalne wywołanie');
TestCall::nieistniejacaMetoda('statyczne wywołanie');

Wynik działania powyższego skryptu będzie następujący:

Wywołano metodę nieistniejacaMetoda z parametrami: normalne wywołanie 
Wywołano statycznie metodę nieistniejacaMetoda z parametrami: statyczne wywołanie 

Metody __isset() oraz __unset()

Pierwsza jest wywoływana w momencie, gdy pojawia się próba dostępu do nieistniejącej właściwości obiektu poprzez funkcję isset() lub empty(). Metoda __unset() jest natomiast wywoływana podczas  wykonywania funkcji unset() na nieistniejącej właściwości. Obie przyjmują jako parametr nazwę wywołanej właściwości. Poniższy przykład obrazuje sposób działania opisanych metod:

class TestowaKlasa
{
   public function __unset($nazwa)
   {
      echo "Nie można usunąć '$nazwa', zmienna nie isnieje!" . PHP_EOL;
   }

   public function __isset($nazwa){
      echo "Właściwość '$nazwa' nie istnieje!" . PHP_EOL;
   }
}

$obj = new TestowaKlasa();

unset($obj->nieistniejacaWlasciwosc);
isset($obj->nieistniejacaWlasciwosc);

Efekt działania będzie następujący:

Nie można usunąć 'nieistniejacaWlasciwosc', zmienna nie isnieje!
Właściwość 'nieistniejacaWlasciwosc' nie istnieje!

Metoda __invoke()

Została wprowadzona w PHP 5.3 i jest wywołana w momencie, gdy następuje próba użycia obiektu w sposób przeznaczony dla funkcji. Poszczególne parametry odpowiadają tym użytym w wywołaniu obiektu. Warto pamiętać, że gdy klasa posiada zdefiniowaną metodę __invoke(), zastosowanie na jej obiekcie funkcji is_callable() zwróci w rezultacie true.

class MojaKlasa 
{
   public function __invoke($parametr1, $parametr2)
   {
      var_dump($parametr1, $parametr2);		
   }	
}

$obj = new MojaKlasa();
$obj('abc', 123);
var_dump(is_callable($obj));

Wynik działania powyższego skryptu będzie następujący:

string(3) "abc"
int(123)
bool(true)

Metoda __set_state()

Jest to metoda statyczna, która jest wywoływana w momencie użycia na klasie funkcji var_export(). Przyjmuje jeden parametr, zawierający eksportowane właściwości w formacie: array('wlasciwosc1' => wartosc, 'wlasciwosc2' => wartosc, …). Obrazuje to przykład zaczerpnięty z dokumentacji:

class MojaKlasa
{
    public $w1;
    public $w2;

    public static function __set_state($tab)
    {
        $obj = new MojaKlasa();
        $obj->w1 = $tab['w1'];
        $obj->w2 = $tab['w2'];
        return $obj;
    }
}

$obj = new MojaKlasa();
$obj->w1 = 123;
$obj->w2 = 'abc';

eval('$b = ' . var_export($obj, true) . ';'); 
var_dump($b);

object(MojaKlasa)#2 (2) {
  ["w1"]=>
  int(123)
  ["w2"]=>
  string(3) "abc"
}

Podsumowanie

To była ostatnia część z cyklu „Metody magiczne w PHP”. W poszczególnych artykułach omówiłem wszystkie, jakie występują w PHP 5.3. Mam nadzieję, że wyjaśniły one mechanizmy, które mogą być bardzo przydatne w programowaniu obiektowym.

Metoda __toString

Niniejsza metoda zwraca tekstową reprezentację obiektu i zostanie wywołana w momencie, gdy będziemy chcieli go wyświetlić, na przykład przy pomocy instrukcji echo lub print. Gdy nie zdefiniujemy __toString(), efektem takiego działania będzie błąd i zatrzymanie skryptu:

Catchable fatal error: Object of class MyClass could not be converted to string in /sciezka/do/skryptu/skrypt.php on line 13

Ważną rzeczą jest, że metoda musi na koniec działania zwracać wartość tekstową. Jeśli będzie to liczba, tablica lub obiekt, wygenerowany zostanie błąd. Można w takim przypadku skorzystać z konwersji typów (rzutowania). Na poniższym skrypcie przedstawiono zastosowanie omawianej metody:

class MyClass
{
	private $variable;
	
	public function __construct($parametr)
	{
		$this->variable = $parametr;
	}
	
	public function __toString()
	{
		return $this->variable;		
	}
}

$object = new MyClass("abc");
echo $object;

Efektem działania skryptu będzie po prostu wyświetlenie zawartości właściwości $variable, czyli abc.

Metoda __clone()

W PHP5 w odróżnieniu od wersji 4 wszystkie obiekty reprezentowane są przez referencję. Nie jest więc możliwe bezpośrednie tworzenie kopii obiektów. Poniższy kod spowoduje przypisanie pod  $anotherObject referencji do $object:

$object = new MyClass();
$anotherObject = $object;

W takim przypadku zmiana jednego z obiektów spowoduje więc jednoczesną zmianę drugiego.

Aby utworzyć kopię, musimy skorzystać z instrukcji clone:

$object = new MyClass();
$anotherObject = clone $object;

Utworzenie obiektu w powyższy sposób spowoduje, że w przypadku jakiejkolwiek modyfikacji, zmieniamy tylko jeden z nich.

Metoda __clone() jest wywoływana właśnie podczas klonowania obiektu. Dzięki temu możemy wprowadzić w nim określone zmiany. Przedstawiono to na poniższym przykładzie:

class MyClass
{
	private $id;
	
	private $variable;
		
	public function __construct($variable)
	{
		$this->id = md5(rand());
		$this->variable = $variable;
	}
	
	public function __clone()
	{
		$this->id = md5(rand());				
	}
}

$object = new MyClass("abc");
$object = clone $object;

var_dump($object);
var_dump($object);

Wynik działania skryptu będzie następujący:

object(MyClass)#2 (2) {
  ["id":"MyClass":private]=>
  string(32) "d204e0411e7921f0b468ddb52ea87fc7"
  ["variable":"MyClass":private]=>
  string(3) "abc"
}
object(MyClass)#2 (2) {
  ["id":"MyClass":private]=>
  string(32) "d204e0411e7921f0b468ddb52ea87fc7"
  ["variable":"MyClass":private]=>
  string(3) "abc"
}

Po utworzeniu obiektu $object z podaniem jednego parametru, następuje jego sklonowanie. Konstruktor klasy przypisuje przekazany parametr do odpowiedniej właściwości oraz dodatkowo generuje unikalny identyfikator. Jak jednak widać metoda __clone() wywoływana podczas kopiowania obiektu generuje nowy identyfikator. Widać to wyraźnie po wyświetleniu zawartości obiektów: oba mają tę samą wartość zmiennej $variable, jednak różne $id.

Metody __sleep() i __wakeup()

Kolejne dwie metody magiczne wywoływane są w przypadku serializacji obiektów. Polega ona (tak samo jak w przypadku tablic), na przekształceniu struktury danych na postać łańcucha znaków, możliwego do ponownego przekształcenia w obiekt. Wykorzystuje się do tego celu funkcje serialize() oraz unserialize().

Dzięki metodom __sleep() oraz __wakeup() możemy dokonać modyfikacji obiektu oraz wybrać właściwości, które będą poddane serializacji. Metody te nie przyjmują żadnych parametrów, ale __sleep() powinna zwracać indeksowaną tablicę zawierającą nazwy właściwości, jakie poddane zostaną operacji.

Na poniższym przykładzie przedstawiono działanie metod:

class MyClass
{
	private $id;
	private $variable1;
	private $variable2;
		
	public function __construct($variable1, $variable2)
	{
		$this->id = md5(rand());
		$this->variable1 = $variable1;
		$this->variable2 = $variable2;
	}
	
	public function __sleep()
	{
		return array("variable1");		
	}
	
	public function __wakeup()
	{
		$this->id = md5(rand());				
	}
}

$object = new MyClass(123, "abc");
$object_s = serialize($object);
$object_u = unserialize($object_s);

echo "Obiekt:";
var_dump($object);

echo "Obiekt po serialize():";
var_dump($object_s);

echo "Obiekt po unserialize():";
var_dump($object_u);

Efekt działania skryptu będzie następujący:

Obiekt:object(MyClass)#1 (3) {
  ["id":"MyClass":private]=>
  string(32) "c57ec22b3055e619b765e52dbe9dc5f1"
  ["variable1":"MyClass":private]=>
  int(123)
  ["variable2":"MyClass":private]=>
  string(3) "abc"
}

Obiekt po serialize():string(50) "O:7:"MyClass":1:{s:18:"MyClassvariable1";i:123;}"

Obiekt po unserialize():object(MyClass)#2 (3) {
  ["id":"MyClass":private]=>
  string(32) "857590827074cb64b4c0df198ecdc431"
  ["variable1":"MyClass":private]=>
  int(123)
  ["variable2":"MyClass":private]=>
  NULL
}

Na początku tworzony jest obiekt, którego konstruktor przypisuje do dwóch właściwości przekazane parametry, oraz dodatkowo ustala pseudolosowy identyfikator. Następuje później serializacja obiektu, która zmienia jego postać na łańcuch znaków. W tym momencie wywoływana jest metoda __sleep(), która wybiera tylko jedną z właściwości do przechowania. W kolejnym kroku wykonywana jest czynność przywrócenia obiektu, w wyniku której uruchomiona zostaje __wakeup(). Dzięki temu $variable1 zostaje odzyskana, jednak druga właściwość $variable2 już nie (została pominięta w __sleep()). Dodatkowo wylosowany zostaje nowy identyfikator.

Ciąg dalszy nastąpi…

Konstruktor i destruktor

Są to dwie podstawowe metody, których wywołanie następuje odpowiednio podczas tworzenia nowego obiektu oraz przy jego usuwaniu. Konstruktor służy do zainicjowania obiektu, przypisania właściwości oraz wykonania podstawowych operacji podczas jego tworzenia.

Destruktor jest wywoływany automatycznie w momencie usuwania obiektu. Bardzo ważne jest to, że samodzielne wywołanie tej metody nie usuwa obiektu. W przypadku takiego działania zostanie po prostu wykonany zdefiniowany w destruktorze kod, jednak obiekt będzie istniał dalej. Jeśli chcemy sami go usunąć , możemy skorzystać z jednej z następujących możliwości:

unset($object);
$object = null;

Nie mamy obowiązku definiowania konstruktora i destruktora, domyślnie są one puste.

Na poniższym przykładzie przedstawiono działanie konstruktora i destruktora:

class MyClass
{
   public $variable;
   public function __construct($variable)
   {
      $this->variable = $variable;
      echo "Obiekt został utworzony";
   }

   public function __destruct()
   {
      echo "Obiekt został zniszczony";
   }
}

$object = new MyClass(123);
$object->__destruct();
var_dump($object);

Wynik działania skryptu będzie następujący:

Obiekt został utworzony
Obiekt został zniszczony
object(MyClass)#1 (1) {
   ["variable"]=>
   int(123)
}
Obiekt został zniszczony

Jak  można zauważyć obiekt został utworzony, w wyniku czego nastąpiło wywołanie konstruktora, który przypisał odpowiednią właściwość. W kolejnym kroku wywołano destruktor, co jak widać w dalszej części nie usunęło obiektu, a jedynie wykonało jego kod (wyświetlenie komunikatu). Można to zaobserwować w wyniku funkcji var_dump(). Ostatecznie obiekt został usunięty w momencie zakończenia skryptu – destruktor został wywołany ponownie, tym razem automatycznie.

Metody __get() oraz __set()

Są to metody wywoływane w momencie, gdy następuje próba dostępu do nieistniejącej właściwości obiektu. Metoda __get() zostanie wykonana, gdy będziemy pobierali taką właściwość. Posiada ona jeden parametr, do którego zostaje przypisana nazwa wywoływanej właściwości.

Analogicznie metoda __set() wywoła się, gdy będziemy chcieli ustawić nieistniejącą właściwość obiektu. Przyjmuje ona dwa parametry, kolejno: nazwa oraz wartość.

Należy pamiętać, że gdy nie zdefiniujemy powyższych metod, to w przypadku odczytu nieistniejącej właściwości otrzymamy null, natomiast gdy będziemy chcieli do takiej przypisać wartość, zostanie ona w tym momencie utworzona.

Można to zobaczyć analizując działanie następującego skryptu:

class MyClass
{
   /* ... */
}

$object = new MyClass();
$object->undefinedVariable = 123;

var_dump($object);
var_dump($object->anotherUndefinedVariable);

Efekt jego działania będzie następujący:

object(MyClass)#1 (1) {
   ["undefinedVariable"]=>
   int(123)
}
NULL

Na poniższym przykładzie przedstawiono zasadę działania metod __get() oraz __set():

class MyClass
{
   public function __construct()
   {
      echo $this->undefinedVariable;
   }

   public function __get($name)
   {
      echo "Obiekt nie posiada właściwości $name";
   }

   public function __set($name,  $value)
   {
      echo "Obiekt nie posiada właściwości $name, nie można więc przypisać 
wartości $value";
   }
}

$object = new MyClass();
$object->anotherUndefinedVariable = 678;

Wynikiem działania skryptu będzie:

Obiekt nie posiada właściwości undefinedVariable
Obiekt nie posiada właściwości anotherUndefinedVariable, nie można więc 
przypisać wartości 678

W momencie tworzenia obiektu poprzez konstruktor nastąpiła próba odczytania zmiennej  undefinedVariable, co spowodowało wywołanie metody __get(). Gdy wykonano przypisanie do nieistniejącej właściwości anotherUndefinedVariable, aktywowana została metoda __set();

Metoda __call()

Metoda ta działa analogicznie do poprzednio omówionych, dotyczy jednak metod obiektu. W przypadku, gdy nie zdefiniujemy __cal() i wywołujemy nieistniejącą metodę, zostanie wyświetlony odpowiedni błąd, a działanie skryptu zatrzymane:

Fatal error:  Call to undefined method MyClass::undefinedMethod() 
in /sciezka/do/pliku/skrypt.php on line 13

Po zdefiniowaniu w klasie metody __call(), w takim przypadku błąd nie wystąpi i zostanie wykonany zawarty w niej kod. Przyjmuje ona dwa parametry: nazwę wywołanej metody oraz tablicę zawierającą przekazane zmienne. Przykładowe zastosowanie może być nastepujące:

class MyClass
{
   public function __call($name, $params)
   {
      echo "Metoda $name nie istnieje. Przekazane parametry:";
      print_r($params);
   }
}

$object = new MyClass();
$object->undefinedMethod(12, "a", "b");

Wynik działania powyższego skryptu będzie następujący:

Metoda undefinedMethod nie istnieje. Przekazane parametry:

Array
(
   [0] => 12
   [1] => a
   [2] => b
}

Ciąg dalszy nastąpi…