Programmer's Reference Guide

Einführung

Zend_Application
Zend Framework's Referenzhandbuch

Zend_Application Quick Start

Es gibt zwei Wege um mit Zend_Application anzufangen, und diese hängen davon ab wie man das Projekt beginnt. In jedem Fall beginnt man immer mit der Erstellung einer Bootstrap Klasse und einer diesbezüglichen Konfigurationsdatei.

Wenn man plant Zend_Tool zu verwenden um das eigene Projekt zu erstellen sollte man anbei weiterlesen. Wenn man Zend_Application zu einem existierenden Projekt hinzufügen will, sollte man hier weiterlesen.

Verwenden von Zend_Tool

Der schnellste Weg um mit Zend_Application zu beginnen ist die Verwendung von Zend_Tool um das Projekt zu erstellen. Das erstellt auch die Bootstrap Klasse und die Datei.

Um ein Projekt zu erstellen muß einfach das zf Kommando (auf *nix Systemen) ausgeführt werden:

% zf create project newproject

Oder unter Windows das zf.bat Kommando:

C:> zf.bat create project newproject

Beides erstellt eine Projektstruktur die wie folgt aussieht:

newproject
|-- application
|   |-- Bootstrap.php
|   |-- configs
|   |   `-- application.ini
|   |-- controllers
|   |   |-- ErrorController.php
|   |   `-- IndexController.php
|   |-- models
|   `-- views
|       |-- helpers
|       `-- scripts
|           |-- error
|           |   `-- error.phtml
|           `-- index
|               `-- index.phtml
|-- library
|-- public
|   `-- index.php
`-- tests
    |-- application
    |   `-- bootstrap.php
    |-- library
    |   `-- bootstrap.php
    `-- phpunit.xml

Im obigen Diagramm ist die Bootstrap unter newproject/application/Bootstrap.php und sieht zuerst wie folgt aus:

class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
{
}

Es ist auch zu bemerken das eine Konfigurationdatei unter newproject/application/configs/application.ini erstellt wurde. Diese hat den folgenden Inhalt:

[production]
phpSettings.display_startup_errors = 0
phpSettings.display_errors = 0
includePaths.library = APPLICATION_PATH "/../library"
bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
bootstrap.class = "Bootstrap"
resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
 
[staging : production]
 
[testing : production]
phpSettings.display_startup_errors = 1
phpSettings.display_errors = 1
 
[development : production]
phpSettings.display_startup_errors = 1
phpSettings.display_errors = 1

Alle Einstellungen in dieser Konfigurationsdatei sind für die Verwendung mit Zend_Application und der Bootstrap.

Eine andere Datei von Interesse ist die newproject/public/index.php Datei, welche Zend_Application einfügt und diese ausführt.

// Define path to application directory
defined('APPLICATION_PATH')
    || define('APPLICATION_PATH',
              realpath(dirname(__FILE__) . '/../application'));
 
// Define application environment
defined('APPLICATION_ENV')
    || define('APPLICATION_ENV',
              (getenv('APPLICATION_ENV') ? getenv('APPLICATION_ENV')
                                         : 'production'));
 
/** Zend_Application */
require_once 'Zend/Application.php';
 
// Create application, bootstrap, and run
$application = new Zend_Application(
    APPLICATION_ENV,
    APPLICATION_PATH . '/configs/application.ini'
);
$application->bootstrap()
            ->run();

Um mit dem Quick Start weiterzumachen, springen Sie bitte auf das Ressource Kapitel.

Zend_Application in der eigenen Anwendung hinzufügen

Die Basis von Zend_Application ist wirklich einfach:

Eine application/Bootstrap.php Datei mit der Klasse Bootstrap erstellen.
Eine Konfigurationsdatei application/configs/application.ini mit der Basiskonfiguration für Zend_Application erstellen.
Ändern von public/index.php um Zend_Application anzupassen.

Zuerst die eigene Bootstrap Klasse erstellen. Erzeuge eine Datei application/Bootstrap.php mit dem folgenden Inhalt:

class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
{
}

Jetzt die Konfiguration erstellen. Für dieses Tutorial, verwenden wir eine Konfiguration im INI Stil; man kann natürlich genauso eine XML oder PHP Konfigurationsdatei verwenden. Erstelle eine Datei application/configs/application.ini, und füge den folgenden Inhalt ein:

[production]
phpSettings.display_startup_errors = 0
phpSettings.display_errors = 0
includePaths.library = APPLICATION_PATH "/../library"
bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
bootstrap.class = "Bootstrap"
resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
 
[staging : production]
 
[testing : production]
phpSettings.display_startup_errors = 1
phpSettings.display_errors = 1
 
[development : production]
phpSettings.display_startup_errors = 1
phpSettings.display_errors = 1

Jetz verändern wir das Gateway Skript public/index.php. Wenn die Datei nicht existiert erstellen wir Sie; andernfalls ersetzen wir Sie mit dem folgenden Inhalt:

// Define path to application directory
defined('APPLICATION_PATH')
    || define('APPLICATION_PATH',
              realpath(dirname(__FILE__) . '/../application'));
 
// Define application environment
defined('APPLICATION_ENV')
    || define('APPLICATION_ENV',
              (getenv('APPLICATION_ENV') ? getenv('APPLICATION_ENV')
                                         : 'production'));
 
// Typischerweise wird man das eigene library/ Verzeichnis zum include_path
// hinzufügen wollen, speziell wenn es die ZF Installation enthält
set_include_path(implode(PATH_SEPARATOR, array(
    dirname(dirname(__FILE__)) . '/library',
    get_include_path(),
)));
 
/** Zend_Application */
require_once 'Zend/Application.php';
 
// Create application, bootstrap, and run
$application = new Zend_Application(
    APPLICATION_ENV,
    APPLICATION_PATH . '/configs/application.ini'
);
$application->bootstrap()
            ->run();

Es ist zu beachten das die Environment Konstante der Anwendung nach einer Environment Variable "APPLICATION_ENV" sucht. Wir empfehlen diese im Web Server Environment zu setzen. In Apache kann man diese entweder in der vhost Definition setzen, oder in der .htaccess Datei. Wir empfehlen den folgenden Inhalt in der Datei public/.htaccess:

SetEnv APPLICATION_ENV development
 
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]

Hinweis: Mehr über mod_rewrite lernen
Die obigen Rewrite Regeln erlauben es auf jede Datei im Document Root des eigenen virtuellen Host's zuzugreifen. Wenn es Dateien gibt die man auf diesem Weg nicht bereitstellen will, muss man in seinen Regeln restriktiver sein. Gehe zur Apache WebSite und » lerne mehr über mod_rewrite.

An diesem Punkt, wurde alles gesetzt um die Vorteile von Zend_Application zu verwenden.

Hinzufügen und Erstellen von Ressourcen

Wenn man den Anleitungen von oben gefolgt ist, dann verwendet die Bootstrap Klasse einen Front Controller, und wenn Sie gestartet wird, wird Sie den Front Controller ausführen. Trotzdem wird man, in allen Fällen, etwas mehr Konfiguration als das benötigen.

In diesem Kapitel werden wir zwei Ressourcen zur anwendung hinzufügen. Zuerst werden wir Layouts erstellen, und dann werden wir ein View Objekt anpassen.

Eine der von Zend_Application angebotenen Standardressourcen ist die "layout" Ressource. Diese Ressource erwartet, das man Konfgurationswerte definiert, welche dann verwendet werden um die Zend_Layout Instanz zu konfigurieren.

Um Sie zu verwenden müssen wir die Konfigurationsdatei aktualisieren.

[production]
phpSettings.display_startup_errors = 0
phpSettings.display_errors = 0
bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
bootstrap.class = "Bootstrap"
resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
; ADD THE FOLLOWING LINES
resources.layout.layout = "layout"
resources.layout.layoutPath = APPLICATION_PATH "/layouts/scripts"
 
[staging : production]
 
[testing : production]
phpSettings.display_startup_errors = 1
phpSettings.display_errors = 1
 
[development : production]
phpSettings.display_startup_errors = 1
phpSettings.display_errors = 1

Wenn man es nicht bereits getan hat, muß man das Verzeichnis application/layouts/scripts/ und die Datei layout.phtml in diesem Verzeichnis erstellen. Ein gutes Layout zum Starten ist das folgende (und ist mit der View Ressource die als nächstes besprochen wird verbunden):

<?php echo $this->doctype() ?>
<html>
<head>
    <?php echo $this->headTitle() ?>
    <?php echo $this->headLink() ?>
    <?php echo $this->headStyle() ?>
    <?php echo $this->headScript() ?>
</head>
<body>
    <?php echo $this->layout()->content ?>
</body>
</html>

An diesem Punkt, hat man ein funktionierendes Layout.

Jetzt fügen wir eine eigene View Ressource hinzu. Wenn die View initialisiert wird, will man den HTML DocType und einen Standardwert für den im HTML Kopf zu verwendenden Titel setzen. Das kann durch die Änderung der Bootstrap Klasse und dem Hinzufügen einer Methode gemacht werden:

class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
{
    protected function _initView()
    {
        // Initialize view
        $view = new Zend_View();
        $view->doctype('XHTML1_STRICT');
        $view->headTitle('My First Zend Framework Application');
 
        // Add it to the ViewRenderer
        $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper(
            'ViewRenderer'
        );
        $viewRenderer->setView($view);
 
        // Return it, so that it can be stored by the bootstrap
        return $view;
    }
}

Diese Methode wird automatisch ausgeführt wenn das Bootstrap der Anwendung ausgeführt wird und stellt sicher das die View so initialisiert wird wie die Anwendung das benötigt.

Nächste Schritte mit Zend_Application

Das oben erwähnte reicht um mit Zend_Application zu beginnen und das Bootstrap der eigenen Anwendung zu erstellen. Von hier an, sollte man beginnen Ressource-Methoden zu erstellen, oder, für maximale Wiederverwendbarkeit, Ressource-Plugin Klassen. Lesen Sie weiter, um mehr zu lernen!

Einführung

Zend_Application
Zend Framework's Referenzhandbuch

Theorie der Funktionsweise

Comments

Posted by: Chase Adams on: 2011-06-16 11:09:46 ⁋

I started learning Zend a few weeks ago and have seen a lot of tutorials using the initView to declare a doctype for the document.

Aside from learning how to utilize a method in the bootstrap, what purpose is there in declaring a doctype?

I would think this would be an unnecessary PHP call when it could be just as easily rendered via HTML if you're only using one doctype in your application...is that incorrect?

Posted by: Fabian Keller on: 2011-08-28 07:13:09 ⁋

@Chase Adams
Declaring the doctype ist not unnecessary as soon as you use Zend_Form. Zend_Form renders the forms depending on the doctype to generate valid HTML.

Posted by: peter on: 2011-11-12 22:58:38 ⁋

poor documentation
Extremely difficult framework.ever seen in my life.
really unhappy with it

Posted by: Matt on: 2011-11-19 21:01:16 ⁋

I have to agree. The documentation does not go into enough detail about the actual sequence of events that occur when you run() a Zend_Application.

In general, the ZF documentation is pretty badly written. It assumes you understand all the terminology already; it talks about weird corner cases and situations without having thoroughly covered the basics; it gives examples that completely lack context. I like ZF's flexibility and comprehensiveness, but this documentation does virtually nothing to make it understandable.

Posted by: Muhammad Zeeshan on: 2011-11-25 10:18:23 ⁋

Very Poor Documentation!

Posted by: Scott Benton on: 2012-01-13 18:51:40 ⁋

Quick solution to something that was frustrating to me. In the process of building out my layout files, it would be nice for links to external resources (CSS, javascript, etc) could always be written relative to application/public, at least to speed up initial development.

So here's a quick function to add to bootstrap.php to define a constant for document root. This is not fully tested, or standards compliant, but it's working for me:




    public function _initBaseURL() {
        
        if (isset($_SERVER["REDIRECT_URL"])) {
            $redirect = $_SERVER["REDIRECT_URL"];                    
            $depth = count(explode("/",$redirect));
            $base = "";
            for ($i = 1; $i<$depth; $i++) {
                $base .= "../";                
            }
            define("_BASE_",$base);
        } else {
            define("_BASE_","");
        }
    }

From there, stylesheet or other links in layout.phtml files (or anywhere else, I beleive) can be written as:



<link rel="stylesheet" type="text/css" href="<?php echo _BASE_; ?>/css/styles.css" />

Hope this helps somebody!

+ Add A Comment

Please do not report issues via comments; use the ZF Issue Tracker.

If you have a JIRA/Crowd account, we suggest you login first before commenting.

Select a Version

Languages Available

Components

SimpleCloud API: Zend_Cloud

ZendX_Console_Process_Unix

ZendX_JQuery

ZF Zend Framework