Dynamisches Laden von Dateien und Klassen

Die Zend_Loader Klasse enthält Methoden die helfen Dateien dynamisch zu laden.

Zend_Loader vs. require_once()

Die Zend_Loader Methoden werden am Besten verwendet wenn der Dateiname der Verwendet wird variabel ist. Wenn er zum Beispiel auf einem Parameter einer Benutzereinfabe oder eines Arguments einer Methode basiert. Wenn eine Datei oder eine Klasse geladen werden soll deren Name konstant ist, gibt es keinen Vorteil durch die Verwendung von Zend_Loader gegenüber traditionellen PHP Funktionen wie require_once().

Dateien laden

Die statische Methode Zend_Loader::loadFile() lädt eine PHP Datei. Die geladene Datei kann jeden PHP Code enthalten. Diese Methode ist ein Wrapper für die PHP Funktion include(). Diese Methode gibt bei einem Fehler ein boosches FALSE zurück, zum Beispiel wenn die definierte Datei nicht existiert.

Beispiel 501. Beispiel der loadFile() Methode

Zend_Loader::loadFile($filename, $dirs=null, $once=false);

Das $filename Argument definert den Dateinamen der geladen werden soll, und der keine Verzeichnis Informationen enthalten darf. Eine Sicherheitsprüfung wird auf $filename durchgeführt. Das $filename Argument darf nur Alphanumerische Zeichen enthalten, Bindestriche ("-"), Unterstriche ("_") oder Punkte ("."). Das $dirs Argument hat keine dieser Einschränkungen.

Das $dirs Argument definiert das Verzeichnis in welchem nach der Datei gesucht werden soll. Wenn der Wert NULL ist, wird nur anhand vom include_path gesucht. Wenn der Wert Zeichenkette oder ein Array ist, wird das definierte Verzeichnis oder die Verzeichnisse durchsucht, gefolgt vom include_path.

Das $once Argument ist Boolean. Wenn es TRUE ist, verwendet Zend_Loader::loadFile() die PHP Funktion include_once() für das Laden der Datei, andernfalls wird die PHP Funktion include() verwendet.

Klassen laden

Die statische Methode Zend_Loader::loadClass($class, $dirs) lädt eine PHP Datei und prüft anschließend ob die Klasse existiert.

Beispiel 502. Beispiel der loadClass() Methode

Zend_Loader::loadClass('Container_Tree',
    array(
        '/home/production/mylib',
        '/home/production/myapp'
    )
);

Die Zeichenkette welche die Klasse definiert, wird in einen relativen Pfad umgewandelt durch die Annahme das Verzeichnisse für das OS mit Unterstrichen getrennt werden und anfügen von '.php'. Im obigen Beispiel wird für Windows 'Container_Tree' zu 'Container\\Tree.php'.

Wenn $dirs eine Zeichenkette oder ein Array ist, durchsucht Zend_Loader::loadClass() die Verzeichnisse in der angegebenen Reihenfolge. Die erste passende Datei wird geladen. Wenn die Datei in den definierten Verzeichnissen $dirs nicht existiert wird der include_path der PHP Umgebung durchsucht.

Wenn die Datei nicht gefunden wird, oder die Klasse nach dem Laden nicht existiert, wirft Zend_Loader::loadClass() eine Zend_Exception.

Zend_Loader::loadFile() wird für das Laden verwendet, deswegen darf der Klassenname nur Alphanumerische Zeichen, den Bindestrich ('-'), den Unterstrich ('_') und den Punkt ('.') enthalten.

Klassen von PHP Namespaces laden

Beginnend mit Version 1.10.0 erlaubt Zend Framework das Laden von Klassen aus PHP Namespaces. Diese Unterstützung folgt den gleichen Richtlinien und Implementationen wie Sie in der PHP Framework Interop Group PSR-0 Referenz Implementation gefunden werden können.

Mit dieser Richtlinie werden die folgenden Regeln angewandt:

  • Jeder Separator für Namespaces wird zu einem DIRECTORY_SEPARATOR konvertiert wenn er vom Dateisystem geladen wird.

  • Jedes "_" Zeichen im CLASS NAME wird zu einem DIRECTORY_SEPARATOR konvertiert. Das "_" Zeichen hat keine spezielle Bedeutung im Namespace.

  • Dem voll-qualifizierte Namespace und der Klasse wird ".php" angehängt wenn Sie vom Dateisystem geladen werden.

Als Beispiel:

  • \Doctrine\Common\IsolatedClassLoader => /path/to/project/lib/vendor/Doctrine/Common/IsolatedClassLoader.php

  • \namespace\package\Class_Name => /path/to/project/lib/vendor/namespace/package/Class/Name.php

  • \namespace\package_name\Class_Name => /path/to/project/lib/vendor/namespace/package_name/Class/Name.php

Testen ob eine Datei gelesen werden kann

Die statische Methode Zend_Loader::isReadable($pathname) gibt TRUE zurück wenn eine Datei im angegebenen Pfadnamen existiert und lesbar ist, andernfalls FALSE.

Beispiel 503. Beispiel der isReadable() Methode

if (Zend_Loader::isReadable($filename)) {
    // Mach was mit $filename
}

Das $filename Argument definiert den Dateinamen der geprüft werden soll. Er darf Pfadinformationen enthalten. Diese Methode ist ein Wrapper für die PHP Funktion is_readable(). Diese PHP Funktion durchsucht den include_path nicht, während Zend_Loader::isReadable() dies macht.

Verwenden von Autoloaders

Die Zend_Loader Klasse enthält eine Methode die im PHP SPL Autoloader registriert werden kann. Zend_Loader::autoload() ist die Callback Methode. Als Vereinfachung bietet Zend_Loader die registerAutoload() Funktion welche die autoload() Methode registriert. Wenn die spl_autoload Erweiterung in der PHP Umgebung nicht vorhanden ist wird die registerAutoload() Methode eine Zend_Exception werfen.

Beispiel 504. Beispiel für das registrieren der Autoloader Callback Methode

Zend_Loader::registerAutoload();

Nach dem registrieren des Zend Framework Autoload Callbacks, können die Klassen des Zend Frameworks referenziert werden ohne das sie explizit geladen werden müssen. Die autoload() Methode verwendet automatisch Zend_Loader::loadClass() wenn eine Klasse referenziert wird.

Wenn die Zend_Loader Klasse erweitert wird, kann ein optionales Argument für registerAutoload() angegeben werden, um die Klasse zu definieren von welcher die autoload() Methode registriert werden soll.

Beispiel 505. Beispiel für das registrieren der Autoload Callback Methode von einer erweiterten Klasse

Wegen der Semantik der Referenzen von statischen Funktionen in PHP, muß Code für beide loadClass() und autoload() implementiert werden, und autoload() muß self::loadClass() aufrufen. Wenn die autoload() Methode den Aufruf zu self::loadClass() an die Elternklasse delegiert, ruft Sie die Methode des Namens in der Elternklasse und nicht in der Subklasse auf.

class My_Loader extends Zend_Loader
{
    public static function loadClass($class, $dirs = null)
    {
        parent::loadClass($class, $dirs);
    }

    public static function autoload($class)
    {
        try {
            self::loadClass($class);
            return $class;
        } catch (Exception $e) {
            return false;
        }
    }
}

Zend_Loader::registerAutoload('My_Loader');

Der Callback für den Autoloader kann entfernt werden. Die registerAutoload() Methode hat ein zweites optionales Argument welches standardmäßig TRUE ist. Wenn dieses Argument FALSE ist, wird die Registrierung des Callback des Autoloaders vom SPL Autoload Stack entfernt.