Um Tooling-Anfragen über den Kommandozeilen-Client auszuführen, muss man zuerst den Client vorbereiten so dass das System den "zf" Befehl ausführen kann. Der Kommandozeilen-Client ist, für alle Wünsche und Zwecke, die Datei .sh oder .bat welche mit der Zend Framework Distribution bereitgestellt wird. Im Trunk kann er hier gefunden werden: http://framework.zend.com/svn/framework/standard/trunk/bin/.

Wie man sehen kann, gibt es 3 Dateien im /bin/ Verzeichnis: zf.php, zf.sh, und zf.bat. zf.sh und zf.bat sind Betriebssystem-spezifische Client-Wrapper: zf.sh für die *nix Umgebung, und zf.bat für die Win32 Umgebung. Diese Client-Wrapper sind für das Finden der richtigen php.exe, das finden der zf.php, und die Übergabe an die Anfrage des Clients zuständig. Die zf.php ist verantwortlich für die Behandlung der Umgebung, die Erstellung des richtigen include_path, und der Übergabe von dem was auf der Kommandozeile angegeben wurde an die richtige Bibliothekskomponente für die Bearbeitung.

Ultimativ, muss man zwei Dinge sicherstellen damit alles funktioniert, unabhängig vom Betriebssystem auf dem man arbeitet:

Das üblichste Setup in einer *nix Umgebung ist es, zf.sh und zf.sh in das selbe Verzeichnis wie die PHP Installation zu kopieren. Diese kann normalerweise in einem der folgenden Plätze gefunden werden:

/usr/bin
/usr/local/bin
/usr/local/ZendServer/bin/
/Applications/ZendServer/bin/

Um den Ort der eigenen PHP Installation zu finden kann man 'which php' auf der Kommandozeile ausführen. Das gibt den Ort der PHP Installation zurück welche verwendet wird um in dieser Umgebung PHP Skripte auszuführen.

Der nächste Schritt ist es sicherzustellen das die Zend Framework Bibliothek korrekt im PHP include_path eingestellt wurde. Um herauszufinden wo der include_path ist, kann man php -i ausführen und nach der include_path Variable sehen, oder kompakter php -i | grep include_path ausführen. Sobald man herausgefunden hat wo der include_path ist (er ist normalerweise etwas wie /usr/lib/php, /usr/share/php, /usr/local/lib/php, oder so ähnlich), sollte man sicherstellen das der Inhalt des Verzeichnisses /library/ in einem der in include_path spezifizierten Verzeichnisse ist.

Sobald man diese zwei Dinge getan hat, sollte man in der Lage sein ein Kommando auszuführen und die richtige Antwort zurück zu erhalten, wie zum Beispiel:

Wenn man diese Art der Ausgabe nicht sieht, sollte man zurückgeben und die eigenen Einstellungen prüfen um sicherzustellen das man alle notwendigen Teile am richtigen Ort vorhanden sind.

Es gibt eine Anzahl an alternativen Einstellungen die man erstellen kann, abhängig von der Konfiguration des Servers, dem Zugriffslevel, oder aus anderen Gründen.

Das alternative Setup enthält das man den Download vom Zend Framework zusammenbehält wie er ist, und einen Link von einem PATH Ort zur zf.sh erstellt. Was dies bedeutet ist, dass man den Inhalt des Zend Framework Downloads in einem Ort wie /usr/local/share/ZendFramework platzieren kann, oder lokaler unter /home/username/lib/ZendFramework und einen symbolischen Link zu zf.sh erstellt.

Angenommen man will den Link in /usr/local/bin platzieren (dies könnte zum Beispiel auch für die Platzierung des Links unter /home/username/bin/ funktionieren), dan würde man ein Kommando wie das folgende platzieren:

ln -s /usr/local/share/ZendFramework/bin/zf.sh /usr/local/bin/zf

# ODER (zum Beispiel)
ln -s /home/username/lib/ZendFramework/bin/zf.sh /home/username/bin/zf

Das erstellt einen Link auf den man global von der Kommandozeile aus zugreifen kann.

Das üblichste Setup in einer Windows Win32 Umgebung ist es zf.bat und zf.php in das selbe Verzeichnis wie die PHP Bibliothek zu kopieren. Diese kann generell an einem der folgenden Plätze gefunden werden:

C:\PHP
C:\Program Files\ZendServer\bin\
C:\WAMP\PHP\bin

Man sollte in der Lage sein php.exe von der Kommandozeile aus auszuführen. Wenn man dazu nicht in der Lage ist, sollte man zuerst die Dokumentation prüfen welche mit der PHP Bibliothek mitgeliefert wird, um sicherzustellen dass der Pfad zu php.exe in der Windows Umgebungsvariable PATH zu finden ist.

Der nächste Schritt besteht darin sicherzustellen das die Zend Framework Bibliothek richtig auf dem PHP include_path des Systems eingerichtet ist. Um herauszufinden wo der include_path ist, kann man php -i eingeben und nach der Variable include_path sehen, oder kompakter php -i | grep include_path ausführen wenn man ein Cygwin Setup mit vorhandenem grep hat. Sobald man herausgefunden hat wo der include_path liegt (das ist normalerweise etwas wie C:\PHP\pear, C:\PHP\share, C:\Program%20Files\ZendServer\share, oder ähnlich), sollte man sicherstellen das der Inhalt des Verzeichnisses library/ in einem vom include_path spezifizierten Verzeichnis ist.

Sobald man diese zwei Dinge getan hat, sollte man in der Lage sein ein Kommando auszuführen und die richtige Antwort, so ähnlich wie die folgende, zu erhalten:

Wenn man diese Art der Ausgabe nicht sieht, sollte man zurückgehen und die Einstellungen prüfen um sicherzustellen das man alle notwendigen Teile an den richtigen Orten hat.

Es gibt eine Anzahl an alternativen Einstellungen die man erstellen kann, abhängig von der Konfiguration des Servers, dem Zugriffslevel, oder aus anderen Gründen.

Das alternative Setup enthält das man den Download vom Zend Framework zusammenbehält wie er ist, und sowohl den System PATH, als auch die php.ini Datei verändert. In der Umgebung des Benutzers muss man C:\Path\To\ZendFramework\bin hinzufügen damit die Datei zf.bat ausführbar ist. Auch die Datei php.ini ist zu verändern um sicherzustellen das C:\Path\To\ZendFramework\library im include_path liegt.

Wenn man aus bestimmten Gründen die Zend Framework Bibliothek nicht im include_path haben will, gibt es andere Optionen. Es gibt zwei spezielle Umgebungsvariablen welche zf.php verwendet um den Ort der Zend Framework Installation zu erkennen.

Die erste ist ZEND_TOOL_INCLUDE_PATH_PREPEND, welche den Wert der Umgebungsvariable dem include_path des Systems (php.ini) voranstellt bevor der Client geladen wird.

Alternativ kann man ZEND_TOOL_INCLUDE_PATH verwenden um den include_path des System komplett zu ersetzen für jene bei denen es Sinn macht, speziell für das zf Kommandozeilen-Tool.

Standardmäßig verwendet Zend_Tool den BasicLoader um alle Provider zu finden die es ausführen kann. Er durchsucht alle Verzeichnisse des Include Pfades rekursiv und öffnet alle Dateien welche mit "Manifest.php" oder "Provider.php" enden. Alle Klassen in diesen Dateien werden darauf durchsucht ob Sie entweder Zend_Tool_Framework_Provider_Interface oder Zend_Tool_Framework_Manifest_ProviderManifestable implementieren. Instanzen des Provider Interfaces sind für die echte Funktionalität zuständig und alle Ihre öffentlichen Methoden kann als Provider Aktionen zugegriffen werden. Das ProviderManifestable Interface benötigt trotzdem die Implementation einer getProviders() Methode welche ein Array an instanzierten Provider Interface Instanzen zurückgibt.

Die folgenden Namensregeln sind darauf anzuwenden, wie man auf die Provider zugreifen kann welche vom IncludePathLoader gefunden werden:

class My_Component_Manifest
    implements Zend_Tool_Framework_Manifest_ProviderManifestable
{
    public function getProviders()
    {
        return array(
            new My_Component_HelloProvider()
        );
    }
}

Wenn, als Beispiel, ein Entwickler die Fähigkeit, eine Version einer Datendatei anzuzeigen, hinzufügen will mit der seine 3rd Party Komponente arbeitet, gibt es nur eine Klasse welche der Entwickler implementieren muss. Angenommen die Komponente wird My_Component genannt, dann würde er eine Klasse erstellen welche My_Component_HelloProvider heißt in einer Datei wleche HelloProvider.php genannt ist und irgendwo in seinem include_path liegt. Diese Klasse würde Zend_Tool_Framework_Provider_Interface implementieren und diese Datei würde etwa wie folgt auszusehen haben:

class My_Component_HelloProvider
    implements Zend_Tool_Framework_Provider_Interface
{
    public function say()
    {
        echo 'Hallo von meinem Provider!';
    }
}

Bei dem obigen Code und der Annahme das der Entwickler Zugriff auf diese Funktionalität über den Konsolen-Client haben will, würde der Aufruf wie folgt aussehen:

% zf say hello
Hallo von meinem Provider!

Wie im Architektur-Abschnitt diskutiert erlaubt es Zend_Tool andere Clients für die Verwendung eigener Zend_Tool Provider zu verknüpfen. Um den unterschiedlichen Clients zu entsprechen sollte man das Antwort-Objekt verwenden um Rückgabe-Meldungen von Providern zurückzugeben anstatt echo() oder ähnliche Ausgabe-Mechanismen zu verwenden. Nach dem Umschreiben des Hello-Providers mit diesen Erkenntnissen sieht er wie folgt aus:

class My_Component_HelloProvider
    extends Zend_Tool_Framework_Provider_Abstract
{
    public function say()
    {
        $this->_registry->getResponse
                        ->appendContent("Hallo von meinem Provider!");
    }
}

Wie man sieht muss Zend_Tool_Framework_Provider_Abstract erweitert werden um Zugriff auf die Registry zu erhalten welche die Zend_Tool_Framework_Client_Response Instanz enthält.