File: Zend_Layout-QuickStart.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 (272 lines) | stat: -rw-r--r-- 11,294 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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.layout.quickstart">
    <title>Zend_Layout Schnellstart</title>

    <para>
        Es gibt zwei primäre Verwendungen für <classname>Zend_Layout</classname>: Mit dem Zend
        Framework <acronym>MVC</acronym>, und ohne.
    </para>

    <sect2 id="zend.layout.quickstart.layouts">
        <title>Layout Skripte</title>

        <para>
            In beiden Fällen, müssen trotzdem Layout Skripte erstellt werden. Layout Sktipte
            verwenden einfach <classname>Zend_View</classname> (oder welche View Implementation auch
            immer verwendet wird). Layout Variablen werden mit einem
            <classname>Zend_Layout</classname> <link
                linkend="zend.view.helpers.initial.placeholder">Platzhalter</link> registriert,
            und es kann auf Sie über den Platzhalter Helfer zugegriffen werden oder dadurch das Sie
            als Objekt Eigenschaften vom Layout Objekt über den Layout Helfer geholt werden.
        </para>

        <para>
            Als Beispiel:
        </para>

        <programlisting language="php"><![CDATA[
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Meine Seite</title>
</head>
<body>
<?php
    // Holt den 'content' Schlüssel durch Verwendung des Layout Helfers:
    echo $this->layout()->content;

    // Holt den 'foo' Schlüssel durch Verwendung des Platzhalter Helfers:
    echo $this->placeholder('Zend_Layout')->foo;

    // Holt das Layout Objekt und empfängt verschiedene Schlüssel von Ihm:
    $layout = $this->layout();
    echo $layout->bar;
    echo $layout->baz;
?>
</body>
</html>
]]></programlisting>

        <para>
            Weil <classname>Zend_Layout</classname> <classname>Zend_View</classname> für die
            Darstellung verwendet, kann auch jeder registrierte View Helfer verwendet werden, und
            auch auf jede zuvor zugeordnete View Variable kann zugegriffen werden. Sehr hilfreich
            sind die verschiedenen <link linkend="zend.view.helpers.initial.placeholder">Platzhalter
                Helfer</link>, da diese das Empfangen von Inhalt für einen Bereich wie die
            &lt;head&gt; Sektion, Navigation usw. erlauben:
        </para>

        <programlisting language="php"><![CDATA[
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <?php echo $this->headTitle() ?>
    <?php echo $this->headScript() ?>
    <?php echo $this->headStyle() ?>
</head>
<body>
    <?php echo $this->render('header.phtml') ?>

    <div id="nav"><?php echo $this->placeholder('nav') ?></div>

    <div id="content"><?php echo $this->layout()->content ?></div>

    <?php echo $this->render('footer.phtml') ?>
</body>
</html>
]]></programlisting>
    </sect2>

    <sect2 id="zend.layout.quickstart.mvc">
        <title>Zend_Layout mit dem Zend Framework MVC verwenden</title>

        <para>
            <classname>Zend_Controller</classname> bietet ein reiches Set von Funktionalitäten für
            Erweiterung mit seinen <link linkend="zend.controller.plugins">Front Controller
                Plugins</link> und <link linkend="zend.controller.actionhelpers">Action Controller
                Helfern</link>. <classname>Zend_View</classname> hat auch <link
                linkend="zend.view.helpers">Helfer</link>. <classname>Zend_Layout</classname> nimmt
            Vorteile wahr von diesen verschiedenen Erweiterungspunkten wenn es mit den
            <acronym>MVC</acronym> Komponenten verwendet wird.
        </para>

        <para>
            <methodname>Zend_Layout::startMvc()</methodname> erstellt eine Instanz von
            <classname>Zend_Layout</classname> mit jeder optionalen Konfiguration die angegeben
            wird. Anschließend wird ein Front Controller Plugin registriert welches das Layout mit
            jedem Anwendungsinhalt darstellt sobald die Dispatch Schleife fertiggestellt ist, und
            registriert einen Action Helfer der den Zugriff auf das Layout Objekt vom Action
            Controller aus gestattet. Zusätzlich kann jederzeit die Layout Instanz vom View Skript
            geholt werden indem der <classname>Layout</classname> View Helfer verwendet wird.
        </para>

        <para>
            Zuerst sehen wir uns an wie <classname>Zend_Layout</classname> initialisiert wird um es
            mit dem <acronym>MVC</acronym> zu verwenden:
        </para>

        <programlisting language="php"><![CDATA[
// In der Bootstrap Datei:
Zend_Layout::startMvc();
]]></programlisting>

        <para>
            <methodname>startMvc()</methodname> kann ein optionales Array von Optionen oder ein
            <classname>Zend_Config</classname> Objekt entgegennehmen um die Instanz anzupassen;
            diese Optionen werden detailiert in <link linkend="zend.layout.options">diesem
                Abschnitt</link> beschrieben.
        </para>

        <para>
            In einem Action Controller, kann anschließend auf die Layout Instanz als Action Helfer
            zugegriffen werden:
        </para>

        <programlisting language="php"><![CDATA[
class FooController extends Zend_Controller_Action
{
    public function barAction()
    {
        // Layouts in dieser Aktion deaktivieren:
        $this->_helper->layout->disableLayout();
    }

    public function bazAction()
    {
        // Ein anderes Layout Skript in dieser Action verwenden:
        $this->_helper->layout->setLayout('foobaz');
    };
}
]]></programlisting>

        <para>
            Im View Skript kann dann auf das Layout Objekt über den <classname>Layout</classname>
            View Helfer zugegriffen werden. Dieser View Helfer ist etwas anders als andere da er
            keine Argumente entgegennimmt und ein Objekt statt einem Stringwert zurückgibt. Das
            erlaubt sofortige Methodenaufrufe auf dem Layout Objekt:
        </para>

        <programlisting language="php"><![CDATA[
$this->layout()->setLayout('foo'); // alternatives Layout setzen
]]></programlisting>

        <para>
            Die im <acronym>MVC</acronym> registrierte <classname>Zend_Layout</classname> Instanz
            kann jederzeit über die statische <methodname>getMvcInstance()</methodname> Methode
            geholt werden:
        </para>

        <programlisting language="php"><![CDATA[
// Gibt null zurück wenn startMvc() nicht zuerst aufgerufen wurde
$layout = Zend_Layout::getMvcInstance();
]]></programlisting>

        <para>
            Letztendlich hat das Front Controller Plugin von <classname>Zend_Layout</classname> ein
            wichtiges Feature zusätzlich zur Darstellung des Layouts: Es empfängt alle benannte
            Segmente vom Antwortobjekt und ordnet diese als Layout Variablen zu, wobei das 'default'
            Segment der 'content' Variable zugeordnet wird. Das erlaubt es auf den Anwendungsinhalt
            zugreifen zu können und es in View Skripten darzustellen.
        </para>

        <para>
            Als Beispiel, nehmen wir an das der Code zuerst
            <methodname>FooController::indexAction()</methodname> auslöst, welches einige Inhalte im
            standardmäßigen Antwortobjekt darstellt, und dann zu
            <methodname>NavController::menuAction()</methodname> weiterleitet, welches Inhalt im
            'nav' Antwortobjekt darstellt. Letztendlich wird auf
            <methodname>CommentController::fetchAction()</methodname> weitergeleitet und einige
            Kommentare geholt, aber diese werden auch im standard Antwortobjekt dargestellt. (was
            Inhalt zu diesem Segment anfügt). Das View Skript kann dann jedes separat darstellen:
        </para>

        <programlisting language="php"><![CDATA[
<body>
    <!-- Darstellung von /nav/menu -->
    <div id="nav"><?php echo $this->layout()->nav ?></div>

    <!-- Darstellung von /foo/index + /comment/fetch -->
    <div id="content"><?php echo $this->layout()->content ?></div>
</body>
]]></programlisting>

        <para>
            Dieses Feature ist teilweise nützlich wenn es in Verbindung mit dem ActionStack
            <link linkend="zend.controller.actionhelpers.actionstack">Action Helfer</link> und
            <link linkend="zend.controller.plugins.standard.actionstack">Plugin</link> verwendet
            wird, welche verwendet werden können um einen Stack von Aktionen zu definieren der
            durchgelaufen wird, und welcher angepasste Seiten erstellt.
        </para>
    </sect2>

    <sect2 id="zend.layout.quickstart.standalone">
        <title>Zend_Layout als eienständige Komponente verwenden</title>

        <para>
            Als eigenständige Komponente bietet <classname>Zend_Layout</classname> nicht annähernd
            so viele Features oder so viel Bequemlichkeit wie wenn es mit <acronym>MVC</acronym>
            verwendet wird. Trotzdem hat es zwei grundsätzliche Vorteile:
        </para>

        <itemizedlist>
            <listitem><para>Abgrenzung von Layout Variablen.</para></listitem>

            <listitem>
                <para>Isolation vom Layout View Skript von anderen View Skripten.</para>
            </listitem>
        </itemizedlist>

        <para>
            Wenn es als eigenständige Komponente verwendet wird, muß einfach das Layout Objekt
            instanziiert werden, die unterschiedlichen Zugriffsmethoden verwendet werden um Stati zu
            setzen, Variablen als Objekt Eigenschaften gesetzt, und das Layout dargestellt werden:
        </para>

        <programlisting language="php"><![CDATA[
$layout = new Zend_Layout();

// Einen Layout Skript Pfad setzen:
$layout->setLayoutPath('/path/to/layouts');

// Einige Variablen setzen:
$layout->content = $content;
$layout->nav     = $nav;

// Ein unterschiedliches Layout Skript auswählen:
$layout->setLayout('foo');

// Letztendlich das Layout darstellen
echo $layout->render();
]]></programlisting>
    </sect2>

    <sect2 id="zend.layout.quickstart.example">
        <title>Beispiel Layout</title>

        <para>
            Machmal ist ein Bild mehr Wert als tausend Wörter. Das folgende ist ein Beispiel Layout
            Skript das zeigt wie alles zusammenkommen könnte.
        </para>

         <para>
            <inlinegraphic align="center" valign="middle"
                fileref="figures/zend.layout.quickstart.example.png" format="PNG" />
        </para>

        <para>
            Die aktuelle Reihenfolge der Elemente kann variieren, abhängig vom
            <acronym>CSS</acronym> das eingestellt wurde; zum Beispiel, wenn absolute Positionen
            verwendet werden, kann es möglich sein das die Navigation später im Dokument angezeigt
            wird, aber immer noch ganz oben gezeigt wird; das selbe könnte für die Sidebar oder den
            Header gelten. Der aktuelle Mechanismum des Holens von Inhalt bleibt trotzdem der selbe.
        </para>
    </sect2>
</sect1>