File: Zend_View-Helpers-HeadScript.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 (262 lines) | stat: -rw-r--r-- 10,972 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
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect3 id="zend.view.helpers.initial.headscript">
    <title>L'aide de vue HeadScript</title>

    <para>
        L'élément HTML <code>&lt;script&gt;</code> est utilisé pour à la fois pour fournir des
        éléments de scripts côté-client dans le code HTML et aussi pour lier une ressource distante
        contenant du script côté-client. L'aide de vue <code>HeadScript</code> vous permet de gérer
        ces deux cas.
    </para>

    <para>
        L'aide de vue <code>HeadScript</code> supportent les méthodes suivantes pour
        paramétrer ou ajouter des scripts :
    </para>

    <itemizedlist>
        <listitem>
            <para>
                <code>appendFile($src, $type = 'text/javascript', $attrs =
                array())</code>
            </para>
        </listitem>

        <listitem>
            <para>
                <code>offsetSetFile($index, $src, $type = 'text/javascript', $attrs =
                array())</code>
            </para>
        </listitem>

        <listitem>
            <para>
                <code>prependFile($src, $type = 'text/javascript', $attrs =
                array())</code>
            </para>
        </listitem>

        <listitem>
            <para><methodname>setFile($src, $type = 'text/javascript', $attrs = array())</methodname></para>
        </listitem>

        <listitem>
            <para>
                <code>appendScript($script, $type = 'text/javascript', $attrs =
                array())</code>
            </para>
        </listitem>

        <listitem>
            <para>
                <code>offsetSetScript($index, $script, $type = 'text/javascript', $attrs =
                array())</code>
            </para>
        </listitem>

        <listitem>
            <para>
                <code>prependScript($script, $type = 'text/javascript', $attrs =
                array())</code>
            </para>
        </listitem>

        <listitem>
            <para>
                <code>setScript($script, $type = 'text/javascript', $attrs =
                array())</code>
            </para>
        </listitem>
    </itemizedlist>

    <para>
        Dans le cas des méthodes de type <code>*File()</code>, <varname>$src</varname> est
        l'emplacement distant du script à charger ; c'est généralement sous la forme d'une <acronym>URL</acronym> ou
        d'un chemin de fichier. Pour les méthode de type <code>*Script()</code>,
        <varname>$script</varname> sont les directives de script côté-client que vous souhaitez utiliser
        dans l'élément.
    </para>

    <note>
        <title>Paramétrez des commentaires conditionnels</title>

        <para>
            <code>HeadScript</code> vous permet d'englober vos balises de script avec des
            commentaires conditionnels, ce qui permet de les masquer pour des navigateurs
            spécifiques. Pour ajouter les balises conditionnelles, fournissez le paramètre
            <code>conditional</code> en tant que partie du paramètre <varname>$attrs</varname> lors de
            l'appel de la méthode.
        </para>

        <example id="zend.view.helpers.initial.headscript.conditional">
            <title>Headscript avec des commentaires conditionnels</title>

            <programlisting language="php"><![CDATA[
// adding scripts
$this->headScript()->appendFile('/js/prototype.js',
                                'text/javascript',
                                array('conditional' => 'lt IE 7');
]]></programlisting>
        </example>
    </note>

    <para>
        <code>HeadScript</code> vous permet aussi de capturer des scripts ; ceci peut être
        utile si vous voulez créer du script côté-client par programmation, et ensuite le placer
        n'importe où. Une utilisation de ceci est montré dans un exemple ci-dessous.
    </para>

    <para>
        Enfin, vous pouvez aussi utiliser la méthode <methodname>headScript()</methodname> pour rapidement
        ajouter des éléments de script ; le prototype dans ce cas est <code>headScript($mode =
        'FILE', $spec, $placement = 'APPEND')</code>. Le <varname>$mode</varname> est soit "FILE", soit
        "SCRIPT", suivant si vous liez un script ou que vous en définissiez un. <varname>$spec</varname>
        est soit le script à lier ou la source du script elle-même. <varname>$placement</varname> est
        "APPEND", "PREPEND", ou "SET".
    </para>

    <para>
        <code>HeadScript</code> surcharge chacun des <methodname>append()</methodname>,
        <methodname>offsetSet()</methodname>, <methodname>prepend()</methodname>, et <methodname>set()</methodname> pour imposer
        l'utilisation des méthodes spéciales énumérées ci-dessus. En interne, il stocke chaque
        élément sous la forme d'un <code>stdClass</code>, qui peut être ensuite sérialisé grâce à la
        méthode <methodname>itemToString()</methodname>. Ceci vous permet de réaliser des vérifications sur les
        éléments dans la pile, et optionnellement de les modifier en modifiant simplement l'objet
        retourné.
    </para>

    <para>
        L'aide <code>HeadScript</code> est une implémentation concrète de l'<link
        linkend="zend.view.helpers.initial.placeholder">aide Conteneur</link>.
    </para>

    <note>
        <title>Utilisez InlineScript pour les scripts dans le corps ("body") du HTML</title>

        <para>
            L'aide de vue, <link
            linkend="zend.view.helpers.initial.inlinescript">InlineScript</link>, similaire à
            <code>HeadScript</code> devrait être utilisée quand vous souhaitez inclure des scripts
            dans le corps ("<classname>body</classname>") du HTML. Placer ces scripts en fin du
            document est une bonne pratique pour accélérer l'envoi de votre page, particulièrement
            pour les scripts tiers d'analyse.
        </para>
    </note>

    <note>
        <title>Les attributs arbitraires sont désactivées par défaut</title>

        <para>
            Par défaut, <code>HeadScript</code> affichera seulement les attributs de
            <code>&lt;script&gt;</code> approuvés par le W3C. Ceux-ci inclus "<code>type</code>",
            "<code>charset</code>", "<code>defer</code>", "<code>language</code>", et
            "<code>src</code>". Cependant, certaines bibliothèques javascript, notamment <ulink
            url="http://www.dojotoolkit.org/">Dojo</ulink>, utilise des attributs personnalisés dans
            le but de modifier le comportement. Pour autoriser ce type d'attribut, vous pouvez les
            activer grâce à la méthode <methodname>setAllowArbitraryAttributes()</methodname> :
        </para>

        <programlisting language="php"><![CDATA[
$this->headScript()->setAllowArbitraryAttributes(true);
]]></programlisting>
    </note>

    <example id="zend.view.helpers.initial.headscript.basicusage">
        <title>Utilisation basique de l'aide HeadScript</title>

        <para>
            Vous devriez ajouter une nouvelle balise de script à chaque fois. Comme noté
            ci-dessus, ceux-ci peuvent être des liens vers des ressources externes ou vers les
            scripts eux-mêmes.
        </para>

        <programlisting language="php"><![CDATA[
// ajout de scripts
$this->headScript()->appendFile('/js/prototype.js')
                   ->appendScript($onloadScript);
]]></programlisting>

        <para>
            L'ordre est souvent important avec les scripts côté-client ; vous devez vous
            assurer de charger les librairies dans un ordre spécifique en fonction de leurs
            dépendances ; utilisez à la fois les directives <code>append</code>,
            <code>prepend</code>, et <code>offsetSet</code> pour vous aider dans cette tâche
            :
        </para>

        <programlisting language="php"><![CDATA[
// mettre les scripts dans l'ordre

// placer celui-ci à un offset particulier pour s'assurer
// de le charger en dernier
$this->headScript()->offsetSetFile(100, '/js/myfuncs.js');

// utiliser les effets de scriptaculous (append utilise
// l'index suivant, c-à-d. 101)
$this->headScript()->appendFile('/js/scriptaculous.js');

// mais dans tous les cas, le script de base prototype
// doit être chargé en premier :
$this->headScript()->prependFile('/js/prototype.js');
]]></programlisting>

        <para>
            Quand vous êtes finalement prêt à afficher tous les scripts dans votre layout,
            faîtes simplement un <code>echo</code> de l'aide :
        </para>

        <programlisting language="php"><![CDATA[
<?php echo $this->headScript() ?>
]]></programlisting>
    </example>

    <example id="zend.view.helpers.initial.headscript.capture">
        <title>Capturer les scripts en utilisant l'aide HeadScript</title>

        <para>
            Parfois vous devez générer des scripts côté-client par programme. Même si vous
            pouvez employer la concaténation de chaînes, les "heredocs", ou tout autre équivalent,
            il est souvent plus facile de faire juste la création des scripts et de les entourer par
            des balises <acronym>PHP</acronym>. <code>HeadScript</code> vous permet de le faire, et capture ainsi
            l'élément dans la pile :
        </para>

        <programlisting language="php"><![CDATA[
<?php $this->headScript()->captureStart() ?>
var action = '<?php echo $this->baseUrl ?>';
$('foo_form').action = action;
<?php $this->headScript()->captureEnd() ?>
]]></programlisting>

        <para>Les suppositions suivantes sont considérées :</para>

        <itemizedlist>
            <listitem>
                <para>
                    Les déclarations de scripts sont ajoutées à la pile. Si vous souhaitez
                    qu'elles remplacent la pile ou qu'elles soient ajoutées en début de pile, vous
                    devez fournir "SET" ou "PREPEND", en tant que premier argument de
                    <methodname>captureStart()</methodname>.
                </para>
            </listitem>

            <listitem>
                <para>
                    Le type <acronym>MIME</acronym> est considéré comme étant "text/javascript" ; si vous
                    souhaitez spécifier un type différent, vous devez le fournir en tant que
                    deuxième argument de <methodname>captureStart()</methodname>.
                </para>
            </listitem>

            <listitem>
                <para>
                    Si vous souhaitez spécifier un quelconque attribut additionnel pour la
                    balise <code>&lt;script&gt;</code>, fournissez-le sous la forme d'un tableau en
                    troisième argument de <methodname>captureStart()</methodname>.
                </para>
            </listitem>
        </itemizedlist>
    </example>
</sect3>