File: Zend_Navigation-Pages-MVC.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 (242 lines) | stat: -rwxr-xr-x 8,644 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
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect2 id="zend.navigation.pages.mvc">
    <title>Zend_Navigation_Page_Mvc</title>

    <para>
        Les pages de type <acronym>MVC</acronym> utilisent des paramètres <acronym>MVC</acronym>
        issus du composant <classname>Zend_Controller</classname>. Une page <acronym>MVC</acronym> utilisera
        en interne <classname>Zend_Controller_Action_Helper_Url</classname> dans la méthode
        <methodname>getHref()</methodname> pour générer des cibles (hrefs), et la méthode
        <methodname>isActive()</methodname> utilisera les paramètres issus de
        <classname>Zend_Controller_Request_Abstract</classname> et les comparera aux paramètres
        internes à la page.
    </para>

    <table id="zend.navigation.pages.mvc.options">
        <title>Options des pages de type MV</title>
        <tgroup cols="4">
            <thead>
                <row>
                    <entry>Clé</entry>
                    <entry>Type</entry>
                    <entry>Valeur par défaut</entry>
                    <entry>Description</entry>
                </row>
            </thead>
            <tbody>
                <row>
                    <entry><code>action</code></entry>
                    <entry><type>chaine</type></entry>
                    <entry><constant>NULL</constant></entry>
                    <entry>
                        Nom de l'action pour générer des cibles vers la page.
                    </entry>
                </row>
                <row>
                    <entry><code>controller</code></entry>
                    <entry><type>chaine</type></entry>
                    <entry><constant>NULL</constant></entry>
                    <entry>
                        Nom du contrôleur pour générer des cibles vers la page.
                    </entry>
                </row>
                <row>
                    <entry><code>module</code></entry>
                    <entry><type>chaine</type></entry>
                    <entry><constant>NULL</constant></entry>
                    <entry>
                        Nom du module pour générer des cibles vers la page.
                    </entry>
                </row>
                <row>
                    <entry><code>params</code></entry>
                    <entry><type>Array</type></entry>
                    <entry><methodname>array()</methodname></entry>
                    <entry>
                        Paramètres utilisateurs pour générer des cibles vers la page.
                    </entry>
                </row>
                <row>
                    <entry><code>route</code></entry>
                    <entry><type>chaine</type></entry>
                    <entry><constant>NULL</constant></entry>
                    <entry>
                        Nom de la route à utiliser pour générer des cibles vers la page.
                    </entry>
                </row>
                <row>
                    <entry><code>reset_params</code></entry>
                    <entry><code>bool</code></entry>
                    <entry><constant>TRUE</constant></entry>
                    <entry>
                        Remettre à zéro les paramètres de la route ou non.
                    </entry>
                </row>
            </tbody>
        </tgroup>
    </table>

    <note>
        <para>
            Les trois exemples qui suivent supposent une configuration <acronym>MVC</acronym> par défaut,
            avec une route <code>default</code>.
        </para>

        <para>
            L'<acronym>URI</acronym> retournée est relative au <code>baseUrl</code> de
            <classname>Zend_Controller_Front</classname>. Dans nos exemples, le baseUrl vaut
            '/' pour simplifier.
        </para>
    </note>

    <example id="zend.navigation.pages.mvc.example.getHref">
        <title>getHref() génères les URI de la page</title>

        <para>
            Cet exemple montre que les pages de type <acronym>MVC</acronym> utilisent
            <classname>Zend_Controller_Action_Helper_Url</classname> en interne pour générer
            les <acronym>URI</acronym>s suite à l'appel à <code>$page->getHref()</code>.
        </para>

        <programlisting language="php"><![CDATA[
// getHref() retourne /
$page = new Zend_Navigation_Page_Mvc(array(
    'action'     => 'index',
    'controller' => 'index'
));

// getHref() retourne /blog/post/view
$page = new Zend_Navigation_Page_Mvc(array(
    'action'     => 'view',
    'controller' => 'post',
    'module'     => 'blog'
));

// getHref() retourne /blog/post/view/id/1337
$page = new Zend_Navigation_Page_Mvc(array(
    'action'     => 'view',
    'controller' => 'post',
    'module'     => 'blog',
    'params'     => array('id' => 1337)
));
]]></programlisting>
    </example>

    <example id="zend.navigation.pages.mvc.example.isActive">
        <title>isActive() détermine si la page est active</title>

        <para>
            Cet exemple montre que les pages de type <acronym>MVC</acronym> utilisent l'objet de
            requête afin de déterminer si elles sont actives ou non.
        </para>

        <programlisting language="php"><![CDATA[
/*
 * Requête dispatchée:
 * - module:     default
 * - controller: index
 * - action:     index
 */
$page1 = new Zend_Navigation_Page_Mvc(array(
    'action'     => 'index',
    'controller' => 'index'
));

$page2 = new Zend_Navigation_Page_Mvc(array(
    'action'     => 'bar',
    'controller' => 'index'
));

$page1->isActive(); // retourne true
$page2->isActive(); // retourne false

/*
 * Requête dispatchée:
 * - module:     blog
 * - controller: post
 * - action:     view
 * - id:         1337
 */
$page = new Zend_Navigation_Page_Mvc(array(
    'action'     => 'view',
    'controller' => 'post',
    'module'     => 'blog'
));

// retourne true, car la requpete a le même trio module/controller/action
$page->isActive();

/*
 * Requête dispatchée:
 * - module:     blog
 * - controller: post
 * - action:     view
 */
$page = new Zend_Navigation_Page_Mvc(array(
    'action'     => 'view',
    'controller' => 'post',
    'module'     => 'blog',
    'params'     => array('id' => null)
));

// retourne false, car page a besoin du paramètre id dans la requête
$page->isActive(); // retourne false
]]></programlisting>
    </example>

    <example id="zend.navigation.pages.mvc.example.routes">
        <title>Utiliser les routes</title>

        <para>
            Les routes sont utilisables dans les pages de type <acronym>MVC</acronym>. Si une page a une route,
            elle sera utilisée par <methodname>getHref()</methodname> pour générer l'<acronym>URL</acronym>
            de la page.
        </para>

        <para>
            <note>
                <para>
                    Notez que si vous utilisez le paramètre <code>route</code>, vous devrez
                    préciser les paramètres par défaut de la route
                    (module, controller, action, etc.), autremant <methodname>isActive()</methodname>
                    ne pourra déterminer si la page est active ou pas. La raison est qu'il n'existe
                    actuellement aucune méthode permettant de récupérer les paramètres par défaut
                    d'une route un objet <classname>Zend_Controller_Router_Route_Interface</classname>,
                    ni même de récupérer la route courante depuis un objet
                    <classname>Zend_Controller_Router_Interface</classname>.
                </para>
            </note>
        </para>

        <programlisting language="php"><![CDATA[
// La route suivante est ajoutée au routeur de ZF
Zend_Controller_Front::getInstance()->getRouter()->addRoute(
    'article_view', // nom de la route
    new Zend_Controller_Router_Route(
        'a/:id',
        array(
            'module'     => 'news',
            'controller' => 'article',
            'action'     => 'view',
            'id'         => null
        )
    )
);

// Une page est créee avec un paramètre 'route'
$page = new Zend_Navigation_Page_Mvc(array(
    'label'      => 'A news article',
    'route'      => 'article_view',
    'module'     => 'news',    // requis pour isActive(), voyez les notes ci-dessus
    'controller' => 'article', // requis pour isActive(), voyez les notes ci-dessus
    'action'     => 'view',    // requis pour isActive(), voyez les notes ci-dessus
    'params'     => array('id' => 42)
));

// retourne: /a/42
$page->getHref();
]]></programlisting>
    </example>
</sect2>