Verwendung von Zend_Tool auf der Kommandozeile
Das CLI, oder Kommandozeilentool (intern bekannt als Konsolen Tool),
ist aktuell das primäre Interface für die Bearbeitung von Zend_Tool
Anfragen. Mit dem CLI Tool können Entwickler Tooling Anfragen im
"Kommandozeilen Fenster", auch bekannt als "Terminal" Fenster, auslösen. Diese Umgebung ist
vorherrschend bei *nix Umgebungen, es gibt aber auch übliche Implementationen unter Windows
mit cmd.exe, Console2 und auch im Cygwin Projekt.
Installation
Herunterladen und anfangen
Zuerst muss Zend Framework heruntergeladen werden. Das kann man tun, indem man auf
framework.zend.com geht und das letzte Release herunterlädt. Nachdem man das
Paket heruntergeladen und auf dem System plaziert hat ist der nächste Schritt das
zf Kommendo auf dem System zu erstellen. Der einfachste Weg das zu tun ist die
richtigen Dateien vom bin/ Verzeichnis des Downloads zu kopieren, und diese Dateien
im gleichen Verzeichnis zu platzieren wie der Ort an dem die
PHP CLI Binardatei ist.
Installation über Pear
Um es über PEAR zu installieren muss man die 3rd Party Site zfcampus.org verwenden
und das letzte Zend Framwork PEAR Paket empfangen. Diese Pakete werden
typischerweise innerhalb eines Tages nach einem offiziellen Zend Framework Release
erstellt. Der Vorteil der Installation über den PEAR Package Manager ist, dass die
ZF Bibliothek im include_path endet, und die zf.php und ZF Skripte an einem Ort im
eigenen System enden der es erlaubt Sie ohne zusätzliches Setup zu starten.
Das ist es schon. Nachdem initialen Setup sollte man in der Lage sein weiter zu
machen indem das zf Kommando ausgeführt wird. Ein gute Weg um zu prüfen ob es
vorhanden ist, ist es zf --help auszuführen.
Installation von Hand
Die Installtion von Hand zeigt den Prozess um zf.php und die Zend Framework
Bibliothek dazu zu zwingen zusammen zu arbeiten wenn diese nicht auf konventionellen
Orten abgelegt wurden, oder zumindest, an einem Ort an dem das eigene System diese
nicht einfach ausführen kann (typisch für Programme im eigenen System Pfad).
Wenn man auf einem *nix oder Mac System ist, kann man auch einen Link von irgendwo im
eigenen Pfad zur zf.sh Datei erstellen. Wenn man das macht muss man sich keine
Gedanken darüber machen das die Zend Framework Bibliothek im eigenen include_path
ist, da die Dateien zf.php und zf.sh auf die Bibliothek, relativ dazu wo Sie sind,
zugreifen können (was bedeutet das die ./bin/ Dateien relativ zu ../library/ der
Zend Framework Bibliothek sind).
Es gibt eine Anzahl von anderen vorhandenen Optionen für das Setup von zf.php und
der Bibliothek im eigenen System. Diese Optionen drehen sich um das Setzen von
speziellen Umgebungsvariablen. Diese werden im späteren Kapitel "Die CLI Umgebung
anpassen" beschrieben. Die Umgebungsvariablen für das Setzen von include_path,
ZF_INCLUDE_PATH und ZF_INCLUDE_PATH_PREPEND für zf.php sind die interessantesten.
Kommandos für generelle Zwecke
Version
Das zeigt die aktuelle Versionsnummer der Kopie vom Zend Framework welche das zf.php
Tool verwendet.
Eingebaute Hilfe
Das eingebaute Hilfe System ist der primäre Ort von dem man up-to-date Informationen
darüber erhält was das eigene System in der Lage ist zu tun. Das Hilfe System ist
dahingehend dynamisch das Provider dem eigenen System hinzugefügt und
automatisch ausgeführt werden, und als solches werden die notwendigen Parameter
damit Sie ausgeführt werden können, im Hilfe Schirm vorhanden. Der einfachste Weg um
den Hilfe Schirm zu erhalten ist der folgende:
Das gibt einen Überblick über die verschiedenen Möglichkeiten des Systems. Manchmal
gibt es engültigere Kommandos die ausgeführt werden können, und um mehr
Informationen über Sie zu erhalten muss man ein spezialisierteres Hilfe Kommando
ausführen. Für die spezialisierte Hilfe muss einfach eines der Elemente des
Kommandos mit einem "=" ersetzt werden. Das sagt dem Hilfe System das man mehr
Informationen darüber will welche Kommandos an Stelle des Fragezeichens stehen
können. Zum Beispiel:
Das obige bedeutet "zeig mir alle 'Aktionen' für den Provider 'controller'"; wärend
das folgende:
bedeutet "zeig mit alle Provider welche die 'show' Aktion unterstützen. Das arbeitet
auch wenn man in Optionen geht wie man im folgenden Beispiel sehen kann:
Manifest
Das zeigt welche Informationen im Tooling System Manifest sind. Das ist wichtiger
für Entwickler von Providers als für normale Benutzer des Tooling Systems.
Projekt spezifische Kommandos
Project
The project provider is the first command you might want to run. This will setup the basic
structure of your application. This is required before any of the other providers can
be executed.
This will create a project in a directory called ./MyProjectName. From this point on,
it is important to note that any subsequent commands on the command line must be issued
from within the project directory you had just created. So, after creation, changing into
that directory is required.
Project
The module provider allows for the easy creation of a Zend Framework module. A module
follows the hMVC pattern loosely. When creating modules, it will take the same structure
used at the application/ level, and duplicate it inside of the chosen name for your module,
inside of the "modules" directory of the application/ directory without duplicating the
modules directory itself. For example:
This will create a module named Blog at application/modules/Blog, and all of the artifacts
that a module will need.
Controller
The controller provider is responsible for creating (mostly) empty controllers as well
as their corresponding view script directories and files. To utilize it to create
an 'Auth' controlller, for example, execute:
This will create a controller named Auth, specifically it will create a file at
application/controllers/AuthController.php with the AuthController inside.
If you wish to create a controller for a module, use any of the following:
Note: In the first command, 1 is the value for the "includeIndexAction" flag.
Action
To create an action within an existing controller:
View
To create a view outside of the normal controller/action creation, you would use
one of the following:
This will create a view script in the controller folder of Auth.
Model
The model provider is only responsible for creating the proper model files,
with the proper name inside the application folder. For example
If you wish to create a model within a specific module:
The above will create a 'Post' model inside of the 'Blog' module.
Form
The form provider is only responsible for creating the proper form file and
init() method, with the proper name inside the application folder. For example:
If you wish to create a model within a specific module:
The above will create a 'Comment' form inside of the 'Blog' module.
DbAdapter
To configure a DbAdapter, you will need to provide the information as a url
encoded string. This string needs to be in quotes on the command line.
For example, to enter the following information:
adapter: Pdo_Mysql
username: test
password: test
dbname: test
The following will have to be run on the command line:
This assumes you wish to store this information inside of the
'production' space of the application configuration file. The following will
demonstrate an sqlite configuration, in the 'development' section of the
application config file.
DbTable
The DbTable provider is responsible for creating Zend_Db_Table
model/data access files for your application to consume, with the proper
class name, and in the proper location in the application. The two
important pieces of information are the DbTable name,
and the actual database table name. For example:
The DbTable provider is also capable of creating the proper files by
scanning the database configured with the above DbAdapter provider.
When executing the above, it might make sense to use the pretend / "-p"
flag first so that you can see what would be done, and what tables can
be found in the database.
Layout
Currently, the only supported action for layouts is simply to enable them
will setup the proper keys in the application.ini file for the application
resource to work, and create the proper directories and layout.phtml file.
Environment Customization
The Storage Directory
The storage directory is important so that providers may have a place to find
custom user generated logic that might change the way they behave. One example
can be found below is the placement of a custom project profile file.
The Configuration File
This will create the proper zf.ini file. This should
be run after zf --setup storage-directory. If it is not, it will
be located inside the users home directory. If it is, it will be located inside
the users storage directory.
Environment Locations
These should be set if you wish to override the default places where zf will
attempt to read their values.
ZF_HOME
the directory this tool will look for a home directory
directory must exist
search order:
ZF_HOME environment variable
HOME environment variable
then HOMEPATH environment variable
ZF_STORAGE_DIRECTORY
where this tool will look for a storage directory
directory must exist
search order:
ZF_STORAGE_DIRECTORY environment variable
$homeDirectory/.zf/ directory
ZF_CONFIG_FILE
where this tool will look for a configuration file
search order:
ZF_CONFIG_FILE environment variable
$homeDirectory/.zf.ini file if it exists
$storageDirectory/zf.ini file if it exists
ZF_INCLUDE_PATH
set the include_path for this tool to use this value
original behavior:
use php's include_path to find ZF
use the ZF_INCLUDE_PATH environment variable
use the path ../library (relative to zf.php) to find ZF
ZF_INCLUDE_PATH_PREPEND
prepend the current php.ini include_path with this value