File: Zend_Controller-Router-Route-Chain.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 (217 lines) | stat: -rw-r--r-- 8,624 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
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect3 id="zend.controller.router.routes.chain">
    <title>Zend_Controller_Router_Route_Chain</title>

    <para>
        <classname>Zend_Controller_Router_Route_Chain</classname> ist eine Route die es erlaubt
        mehrere Routen miteinander zu verketten. Das erlaubt es Hostname-Routen und Pfad-Routen zu
        verketten, oder zum Beispiel mehrere Pfad-Routen. Verkettung kann entweder
        program-technisch oder mit einer Konfigurationsdatei durchgeführt werden.
    </para>

    <note>
        <title>Priorität der Parameter</title>

        <para>
            Wenn Routen wie die Hostnameroute und die Pfadroute zusammengekettet werden, haben die
            Parameter der Hostnameroute eine höhere Priorität als die Parameter der Pfadroute.
            Deshalb wird, wenn man im Hostnamen und in der Pfadroute einen Controller definiert,
            der Controller der Hostnameroute ausgewählt.
        </para>
    </note>

    <para>
        Wenn Programmtechnisch verkettet wird, gibt es zwei Wege das zu tun. Der erste besteht
        darin eine neue Instanz von <classname>Zend_Controller_Router_Route_Chain</classname> zu
        erstellen und dann die <methodname>chain()</methodname> Methode mehrere Male mit allen
        Routen aufzurufen die zusammen verkettet werden sollen. Der andere Weg besteht darin die
        erste Route zu nehmen, z.B. eine Hostname Route, und die <methodname>chain()</methodname>
        Methode mit der Route auf Ihr aufzurufen, die angehängt werden soll. Das verändert die
        Hostname Route nicht, gibt aber eine neue Instanz von
        <classname>Zend_Controller_Router_Route_Chain</classname> zurück, die dann beide Routen
        verkettet hat:
    </para>

    <programlisting language="php"><![CDATA[
// Erstellung zweier Routen
$hostnameRoute = new Zend_Controller_Router_Route_Hostname(...);
$pathRoute     = new Zend_Controller_Router_Route(...);

// Erster Weg, mit Verkettung über die Chain Route
$chainedRoute = new Zend_Controller_Router_Route_Chain();
$chainedRoute->chain($hostnameRoute)
             ->chain($pathRoute);

// Zweiter Weg, direkt verketten
$chainedRoute = $hostnameRoute->chain($pathRoute);
]]></programlisting>

    <para>
        Wenn Routen miteinander verkettet werden, ist Ihr Trennzeichen ein
        Schrägstrich. Es kann Fälle geben in denen man ein anderes Trennzeichen verwenden will:
    </para>

    <programlisting language="php"><![CDATA[
// Zwei Routen erstellen
$firstRoute  = new Zend_Controller_Router_Route('foo');
$secondRoute = new Zend_Controller_Router_Route('bar');

// Sie mit einem anderen Trennzeichen miteinander verketten
$chainedRoute = $firstRoute->chain($secondRoute, '-');

// Zusammenbauen der Route: "foo-bar"
echo $chainedRoute->assemble();
]]></programlisting>

    <sect4 id="zend.controller.router.routes.chain.config">
        <title>Verkettete Routen über Zend_Config</title>

        <para>
            Um Routen in einer Config Datei miteinander zu verketten gibt es zusätzliche Parameter
            für die Konfiguration von Ihnen. Der einfachere Weg ist die Verwendung des
            <property>chains</property> Parameters. Dieser ist einfach eine Liste von Routen, die
            mit der Eltern-Route verkettet werden. Weder die Eltern-, noch die Kind-Routen werden
            dem Router direkt hinzugefügt sondern nur die resultierende verkettete Route. Der Name
            der verketteten Route im Router ist standardmäßig der Name der Eltern-Route und der Name
            der Kind-Route verbunden mit einem Bindestrich (-). Eine einfache Konfiguration würde
            in <acronym>XML</acronym> wie folgt aussehen:
        </para>

        <programlisting language="xml"><![CDATA[
<routes>
    <www type="Zend_Controller_Router_Route_Hostname">
        <route>www.example.com</route>
        <chains>
            <language type="Zend_Controller_Router_Route">
                <route>:language</route>
                <reqs language="[a-z]{2}">
                <chains>
                    <index type="Zend_Controller_Router_Route_Static">
                        <route></route>
                        <defaults module="default" controller="index"
                                  action="index" />
                    </index>
                    <imprint type="Zend_Controller_Router_Route_Static">
                        <route>imprint</route>
                        <defaults module="default" controller="index"
                                  action="index" />
                    </imprint>
                </chains>
            </language>
        </chains>
    </www>
    <users type="Zend_Controller_Router_Route_Hostname">
        <route>users.example.com</route>
        <chains>
            <profile type="Zend_Controller_Router_Route">
                <route>:username</route>
                <defaults module="users" controller="profile" action="index" />
            </profile>
        </chains>
    </users>
    <misc type="Zend_Controller_Router_Route_Static">
        <route>misc</route>
    </misc>
</routes>
]]></programlisting>

        <para>
            Das führt zu den drei Routen <command>www-language-index</command>,
            <command>www-language-imprint</command> und <command>users-language-profile</command>
            die nur basierend auf dem Hostnamen und der Route <command>misc</command> passen, was
            wiederum mit jedem Hostnamen passt.
        </para>

        <para>
            Der alternative Weg der Erstellung einer verketteten Route ist der über den
            <property>chain</property> Parameter, was wiederum nur mit dem Chain-Route Typ direkt
            verwendet werden kann, und auch im Root Level funktioniert:
        </para>

        <programlisting language="xml"><![CDATA[
<routes>
    <www type="Zend_Controller_Router_Route_Chain">
        <route>www.example.com</route>
    </www>
    <language type="Zend_Controller_Router_Route">
        <route>:language</route>
        <reqs language="[a-z]{2}">
    </language>
    <index type="Zend_Controller_Router_Route_Static">
        <route></route>
        <defaults module="default" controller="index" action="index" />
    </index>
    <imprint type="Zend_Controller_Router_Route_Static">
        <route>imprint</route>
        <defaults module="default" controller="index" action="index" />
    </imprint>

    <www-index type="Zend_Controller_Router_Route_Chain">
        <chain>www, language, index</chain>
    </www-index>
    <www-imprint type="Zend_Controller_Router_Route_Chain">
        <chain>www, language, imprint</chain>
    </www-imprint>
</routes>
]]></programlisting>

        <para>
            Man kann auch den <property>chain</property> Parameter als Array übergeben statt die
            Routen mit einem Komma zu seperieren:
        </para>

        <programlisting language="xml"><![CDATA[
<routes>
    <www-index type="Zend_Controller_Router_Route_Chain">
        <chain>www</chain>
        <chain>language</chain>
        <chain>index</chain>
    </www-index>
    <www-imprint type="Zend_Controller_Router_Route_Chain">
        <chain>www</chain>
        <chain>language</chain>
        <chain>imprint</chain>
    </www-imprint>
</routes>
]]></programlisting>

        <para>
            Wenn man Chain-Routen mit <classname>Zend_Config</classname> konfiguriert und will dass
            das Trennzeichen ein anderes als ein Unterstrich ist, dann muss man dises Trennzeichen
            separat spezifizieren:
        </para>

        <programlisting language="php"><![CDATA[
$config = new Zend_Config(array(
    'chainName' => array(
        'type'   => 'Zend_Controller_Router_Route_Static',
        'route'  => 'foo',
        'chains' => array(
            'subRouteName' => array(
                'type'     => 'Zend_Controller_Router_Route_Static',
                'route'    => 'bar',
                'defaults' => array(
                    'module'      => 'module',
                     'controller' => 'controller',
                     'action'     => 'action'
                )
            )
        )
    )
));

// Das Trennzeichen vor dem hinzufügen der Config setzen
$router->setChainNameSeparator('_separator_')

// Config hinzufügen
$router->addConfig($config);

// Der Name unserer Route ist jetzt: chainName_separator_subRouteName
echo $this->_router->assemble(array(), 'chainName_separator_subRouteName');

// Die Prüfung: Ausgegeben wird /foo/bar
]]></programlisting>
    </sect4>
</sect3>