File: Zend_Application-Examples.xml

package info (click to toggle)
zendframework 1.12.9%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 133,584 kB
  • sloc: xml: 1,311,829; php: 570,173; sh: 170; makefile: 125; sql: 121
file content (257 lines) | stat: -rw-r--r-- 9,076 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: 22741 -->
<sect1 id="zend.application.examples">
    <title>Beispiele</title>

    <para>
        Die Klasse Bootstrap selbst wird typischerweise sehr minimal sein; oft wird sie einfach
        nur ein leerer Stub sein, der die Basis Bootstrapping-Klasse erweitert:
    </para>

    <programlisting language="php"><![CDATA[
class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
{
}
]]></programlisting>

    <para>
        Mit einer entsprechenden Konfigurationsdatei:
    </para>

    <programlisting language="ini"><![CDATA[
; APPLICATION_PATH/configs/application.ini
[production]
autoloaderNamespaces[] = "My_"
bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
bootstrap.class = "Bootstrap"
pluginpaths.My_Bootstrap_Resource = "My/Bootstrap/Resource"
resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"

[testing: production]
[development : production]
]]></programlisting>

    <note>
        <title>Namespaces für Autoloader</title>

        <para>
            Weil diese Beispiele eigenen Code verwenden, müssen wir die Präfixe der Namespaces
            für diesen Code in unserer Konfiguration registrieren; dies wird mit dem
            Konfigurationsschlüssel <property>autoloaderNamespaces</property> getan, welcher ein
            Array ist.
        </para>

        <para>
            Um zusätzlich sicherzustellen, dass eigene Plugin-Ressourcen erkannt werden, müssen wir
            einen Plugin-Präfixpfad in der Bootstrap registrieren. Das wird mit dem
            Konfigurationsschlüssel <property>pluginpaths</property> getan, welcher ein assoziatives
            Array ist, mit Schlüsseln, die das zu verwendenden Präfix kennzeichnen, und Werten,
            welche den Pfad enthalten, der diesem Präfix entspricht.
        </para>
    </note>

    <para>
        Sollten trotzdem eigene Initialisierungen notwendig sein, hat man zwei Möglichkeiten.
        Erstens kann man Methoden schreiben, die mit <emphasis>_init</emphasis> anfangen, um eigenen
        Code zu spezifizieren, der für das Bootstrapping verwendet werden soll. Diese Methoden
        werden durch <methodname>bootstrap()</methodname> aufgerufen, und können genauso aufgerufen
        werden, wie wenn sie öffentliche Methoden wären:
        <emphasis>bootstrap&lt;resource&gt;()</emphasis>. Sie sollten ein optionales Array an
        Optionen akzeptieren.
    </para>

    <para>
        Wenn die eigene Ressource-Methode einen Wert zurückgibt, wird diese in einem Container
        im Bootstrap gespeichert. Das kann nützlich sein, wenn verschiedene Ressourcen interagieren
        müssen (wie wenn eine Ressource sich selbst in eine andere iniziiert). Die Methode
        <methodname>getResource()</methodname> kann dann verwendet werden, um diese Werte zu
        erhalten.
    </para>

    <para>
        Das Beispiel unten zeigt eine Ressource-Methode für die Initialisierung des Anfrage-Objekts.
        Es verwendet die Erkennung der Abhängigkeit (diese hängt von der Ressource FrontController
        ab), holt eine Ressource vom Bootstrap, und gibt einen Wert zurück, um ihn im
        Bootstrap zu speichern.
    </para>

    <programlisting language="php"><![CDATA[
class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
{
    protected function _initRequest()
    {
        // Sicherstellen, dass eine FrontController-Instanz vorhanden ist
        // und diese holen
        $this->bootstrap('FrontController');
        $front = $this->getResource('FrontController');

        // Das Anfrage-Objekt initialisieren
        $request = new Zend_Controller_Request_Http();
        $request->setBaseUrl('/foo');

        // Sie dem FrontController hinzufügen
        $front->setRequest($request);

        // Bootstrap speichert den Wert im 'request' Schlüssel
        // seines Containers
        return $request;
    }
}
]]></programlisting>

    <para>
        Man beachte in diesem Beispiel den Aufruf von <methodname>bootstrap()</methodname>; dieser
        stellt sicher, dass der FrontController initialisiert wurde, bevor die Methode aufgerufen
        wird. Dieser Aufruf kann entweder eine Ressource oder eine andere Methode in der Klasse
        auslösen.
    </para>

    <para>
        Die andere Option ist, die Verwendung eines Ressource-Plugins. Ressource-Plugins sind
        Objekte, die spezielle Initialisierungen ausführen, und die wie folgt spezifiziert werden
        können:
    </para>

    <itemizedlist>
        <listitem>
            <para>
                Während der Instanzierung des Objekts <classname>Zend_Application</classname>
            </para>
        </listitem>

        <listitem>
            <para>
                Während der Initialisierung des Objekts Bootstrap
            </para>
        </listitem>

        <listitem>
            <para>
                Durch explizites Einschalten über Methodenaufrufe auf dem Objekt Bootstrap
            </para>
        </listitem>
    </itemizedlist>

    <para>
        Ressource-Plugins implementieren
        <classname>Zend_Application_Resource_ResourceAbstract</classname>, welche einfach
        definieren, dass sie Injektion des Aufrufers und von Optionen erlauben, und die eine
        <methodname>init()</methodname> Methode haben. Als Beispiel, könnte eine eigene
        "View"-Bootstrap-Ressource wie folgt aussehen:
    </para>

    <programlisting language="php"><![CDATA[
class My_Bootstrap_Resource_View
    extends Zend_Application_Resource_ResourceAbstract
{
    public function init()
    {
        $view = new Zend_View($this->_getOptions());
        Zend_Dojo::enableView($view);

        $view->doctype('XHTML1_STRICT');
        $view->headTitle()->setSeparator(' - ')->append('Meine Site');
        $view->headMeta()->appendHttpEquiv('Content-Type',
                                           'text/html; charset=utf-8');

        $view->dojo()->setDjConfigOption('parseOnLoad', true)
                     ->setLocalPath('/js/dojo/dojo.js')
                     ->registerModulePath('../spindle', 'spindle')
                     ->addStylesheetModule('spindle.themes.spindle')
                     ->requireModule('spindle.main')
                     ->disable();

        $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper(
            'ViewRenderer'
        );
        $viewRenderer->setView($view);

        return $view;
    }
}
]]></programlisting>

    <para>
        Um der Bootstrap zu sagen, dass sie das verwenden soll, würde man entweder den Klassennamen
        des Ressource-Plugins übergeben müssen, oder eine Kombination eines Plugin Loader
        Präfixpfades und den Kurznamen des Ressource-Plugins (z.B. "view"):
    </para>

    <programlisting language="php"><![CDATA[
$application = new Zend_Application(
    APPLICATION_ENV,
    array(
        'resources' => array(
            'My_Bootstrap_Resource_View' => array(), // kompletter Klassenname
            'view',                                  // ODER Kurzname

            'FrontController' => array(
                'controllerDirectory' => APPLICATION_PATH . '/controllers',
            ),
        ),

        // Für Kurznamen, definiere die Plugin Pfade:
        'pluginPaths = array(
            'My_Bootstrap_Resource' => 'My/Bootstrap/Resource',
        )
    )
);
]]></programlisting>

    <para>
        Ressource-Plugins können andere Ressourcen und Initialisierungen aufrufen, indem sie auf den
        Eltern-Bootstrap zugreifen:
    </para>

    <programlisting language="php"><![CDATA[
class My_Bootstrap_Resource_Layout
    extends Zend_Application_Resource_ResourceAbstract
{
    public function init()
    {
        // Sicherstellen, dass die View initialisiert ist...
        $this->getBootstrap()->bootstrap('view');

        // Das View-Objekt erhalten
        $view = $this->getBootstrap()->getResource('view');

        // ...
    }
}
]]></programlisting>

    <para>
        Bei normaler Verwendung würde man die Anwendung instanzieren, sie bootstrappen, und
        anschließend ausführen:
    </para>

    <programlisting language="php"><![CDATA[
$application = new Zend_Application(...);
$application->bootstrap()
            ->run();
]]></programlisting>

    <para>
        Für ein eigenes Skript müsste man einfach spezifische Ressourcen initialisieren:
    </para>

    <programlisting language="php"><![CDATA[
$application = new Zend_Application(...);
$application->getBootstrap('db');

$service = new Zend_XmlRpc_Server();
$service->setClass('Foo');  // Verwende die Datenbank...
echo $service->handle();
]]></programlisting>

    <para>
        Statt der Verwendung der Methode <methodname>bootstrap()</methodname>, um interne Methoden
        oder Ressourcen aufzurufen, kann man auch Überladung verwenden:
    </para>

    <programlisting language="php"><![CDATA[
$application = new Zend_Application(...);
$application->getBootstrapDb();
]]></programlisting>
</sect1>