Objekt orientierte Programmierung

Magische Methoden

Die Funktionen __construct(), __destruct(), __call(), __callStatic(), __get(), __set(), __isset(), __unset(), __sleep(), __wakeup(), __toString(), __invoke(), __set_state(), __clone() und __debugInfo() sind in PHP-Klassen magisch. Man kann keine Funktionen gleichen Namens in einer seiner Klassen haben, wenn man nicht die magische Funktionalität, die sie mit sich bringen, haben will.

serialize() prüft, ob Ihre Klasse eine Funktion mit dem magischen Namen __sleep() besitzt. Wenn dem so ist, wird die Funktion vor jeder Serialisierung ausgeführt. Sie kann das Objekt aufräumen und es wird von ihr erwartet, dass sie ein Array mit den Namen aller Variablen zurückliefert, die serialisiert werden sollen. Wenn die Methode nichts zurückgibt, so wird NULL serialisiert und eine E_NOTICE geworfen.

__sleep kann nicht Namen von privaten Eigenschaften von Elternklassen zurückgeben. In diesem Fall wird eine E_NOTICE geworfen. Stattdessen sollte das Serializable Interface verwendet werden.
Die beabsichtigte Verwendung von __sleep() ist, nicht gespeicherte Daten zu sichern oder ähnliche Aufräumarbeiten zu erledigen. Die Funktion ist ebenfalls nützlich, wenn Sie sehr große Objekte haben, welche nicht komplett gespeichert werden müssen.

__wakeup
unserialize() überprüft die Anwesenheit einer Funktion mit dem magischen Namen __wakeup(). Falls vorhanden, kann diese Funktion alle Ressourcen, die das Objekt haben könnte, wiederherstellen. Der beabsichtigte Zweck von __wakeup() ist es, alle Datenbankverbindungen wiederherzustellen, die während der Serialisierung verloren gegangen sein könnten, oder auch andere Aufgaben zur erneuten Initialisierung.

__invoke
Die __invoke() Methode wird aufgerufen, wenn ein Skript versucht, ein Objekt als Funktion aufzurufen.

__toString
Die __toString() Methode erlaubt einer Klasse zu entscheiden, wie sie reagieren soll, wenn sie in eine Zeichenkette umgewandelt wird. Die beeinflusst beispielsweise, was echo $obj; ausgeben wird. Diese Methode muss eine Zeichenkette zurückgeben, ansonsten wird ein E_RECOVERABLE_ERROR geworfen.

Quellcode

    
    magischeMethoden.php
    // __sleep / __wakeup

    class DB {
        private $login = "";
        private $pass = "";
        private $istVerbunden = false;

        public function __construct($login, $pass)
        {
            $this->login = $login;
            $this->pass = $pass;
            $this->verbinden();
        }

        public function verbinden()
        {
            $this->istVerbunden = true;
        }

        // serialize
        public function __sleep()
        {
            echo "sleeping...<br>";
            return array('login', 'pass');
        }

        // unserialize
        public function __wakeup()
        {
            echo "aufstehen...<br>";
            $this->verbinden();
        }

        public function istDBVerbunden() {
            if ($this->istVerbunden) {
                echo "verbunden";
            } else {
                echo "nicht verbunden";
            }
        }
    }

    $db = new DB("user", "geheim");
    echo $db->istDBVerbunden();
    echo "<br>";

    $out = serialize($db);
    $clonedObject = unserialize($out);
    var_dump($clonedObject);
    echo "<br>";
    echo $clonedObject->istDBVerbunden();
    echo "<hr>";

    // __invoke
    
    class Mathematik {

        public $operation = "";

        public function addieren($x, $y) {
            return $x + $y;
        }

        public function subtrahieren($x, $y)
        {
            return $x - $y;
        }

        public function __invoke($x, $y)
        {
            if ($this->operation == "minus") {
                echo $this->subtrahieren($x, $y);
            } else if ($this->operation == "plus") {
                echo $this->addieren($x, $y);
            }
        }
    }

    $math = new Mathematik();

    $math->operation = "plus";
    $math(5, 15);

    // __toString
    
    class Benutzer {
        private $username;
        private $vorname;
        private $nachname;
        private $id;

        public function __construct($username, $vorname, $nachname)
        {
            $this->username = $username;
            $this->vorname = $vorname;
            $this->nachname = $nachname;
            $this->id = 12; // per random generiert
        }

        public function __toString()
        {
            return "$this->username: $this->vorname $this->nachname";
        }
    }
    echo "<hr>";
    $user = new Benutzer("oop.creative-it.org", "Jens", "Haake");
    echo $user;

Magische Methoden

Quellcode

magischeMethoden.php

Ausgabe