2
0

Zend_View-Helpers-HeadScript.xml 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 17232 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.view.helpers.initial.headscript">
  5. <title>HeadScript Helfer</title>
  6. <para>
  7. Das HTML <code>&lt;script&gt;</code> Element wird verwendet um entweder Clientseitige
  8. Skriptelemente Inline zu ermöglichen oder um eine entfernte Ressource zu verlinken die
  9. Clientseitigen Skriptcode enthält. Der <code>HeadScript</code> Helfer erlaubt es beides zu
  10. Managen.
  11. </para>
  12. <para>
  13. Der <code>HeadScript</code> Helfer unterstützt die folgenden Methoden für das Setzen und
  14. Hinzufügen von Skripten:
  15. </para>
  16. <itemizedlist>
  17. <listitem><para><code>appendFile($src, $type = 'text/javascript',
  18. $attrs = array())</code></para></listitem>
  19. <listitem><para><code>offsetSetFile($index, $src, $type = 'text/javascript',
  20. $attrs = array())</code></para></listitem>
  21. <listitem><para><code>prependFile($src, $type = 'text/javascript',
  22. $attrs = array())</code></para></listitem>
  23. <listitem><para><code>setFile($src, $type = 'text/javascript',
  24. $attrs = array())</code></para></listitem>
  25. <listitem><para><code>appendScript($script, $type = 'text/javascript',
  26. $attrs = array())</code></para></listitem>
  27. <listitem><para><code>offsetSetScript($index, $script, $type = 'text/javascript',
  28. $attrs = array())</code></para></listitem>
  29. <listitem><para><code>prependScript($script, $type = 'text/javascript',
  30. $attrs = array())</code></para></listitem>
  31. <listitem><para><code>setScript($script, $type = 'text/javascript',
  32. $attrs = array())</code></para></listitem>
  33. </itemizedlist>
  34. <para>
  35. Im Falle der <code>*File()</code> Methoden ist <varname>$src</varname> der entfernte Ort des
  36. Skriptes das geladen werden soll; das ist üblicherweise in der Form einer
  37. <acronym>URL</acronym> oder eines Pfades. Für die <code>*Script()</code> Methoden sind
  38. <varname>$script</varname> die clientseitigen Skript Direktiven die in diesem Element
  39. verwendet werden sollen.
  40. </para>
  41. <note>
  42. <title>Abhängige Kommentare setzen</title>
  43. <para>
  44. <code>HeadScript</code> erlaubt es ein Script Tag in abhängige Kommentare zu setzen, das
  45. es erlaubt es vor speziellen Browsern zu verstecken. Um abhängige Tags zu setzen, muß
  46. der abhängige Wert als Teil des <varname>$attrs</varname> Parameters im Methodenaufruf
  47. übergeben werden.
  48. </para>
  49. <example id="zend.view.helpers.initial.headscript.conditional">
  50. <title>Headscript mit abhängigen Kommentaren</title>
  51. <programlisting language="php"><![CDATA[
  52. // Scripte hinzufügen
  53. $this->headScript()->appendFile(
  54. '/js/prototype.js',
  55. 'text/javascript',
  56. array('conditional' => 'lt IE 7')
  57. );
  58. ]]></programlisting>
  59. </example>
  60. </note>
  61. <para>
  62. <code>HeadScript</code> erlaubt auch das Erfassen von Skripten; das kann nützlich sein wenn
  63. man ein Clientseitiges Skript programmtechnisch erstellen und es dann woanders platzieren
  64. will. Seine Verwendung wird in einem Beispiel anbei gezeigt.
  65. </para>
  66. <para>
  67. Letztendlich kann die <methodname>headScript()</methodname> Methode verwendet werden um
  68. Skript Elemente schnell hinzuzufügen; die Signatur hierfür ist <code>headScript($mode =
  69. 'FILE', $spec, $placement = 'APPEND')</code>. Der <varname>$mode</varname> ist
  70. entweder 'FILE' oder 'SCRIPT', anhängig davon ob das Skript verlinkt oder definiert wird.
  71. <varname>$spec</varname> ist entweder die Skriptdatei die verlinkt wird, oder der Skriptcode
  72. selbst. <varname>$placement</varname> sollte entweder 'APPEND', 'PREPEND' oder 'SET' sein.
  73. </para>
  74. <para>
  75. <code>HeadScript</code> überschreibt <methodname>append()</methodname>,
  76. <methodname>offsetSet()</methodname>, <methodname>prepend()</methodname>, und
  77. <methodname>set()</methodname> um um die Verwendung der speziellen Methoden wie vorher
  78. gezeigt zu erzwingen. Intern wird jedes Element als <code>stdClass</code> Token gespeichert,
  79. welches später mit Hilfe der <methodname>itemToString()</methodname> Methode serialisiert
  80. wird. Das erlaubt es Prüfungen an den Elementen im Stack vorzunehmen, und diese Elemente
  81. optional zu ändern, einfach durch das Modifizieren des zurückgegebenen Objektes.
  82. </para>
  83. <para>
  84. Der <code>HeadScript</code> Helfer ist eine konkrete Implementation des
  85. <link linkend="zend.view.helpers.initial.placeholder">Platzhalter Helfers</link>.
  86. </para>
  87. <note>
  88. <title>InlineScript für HTML Body Skripte verwenden</title>
  89. <para>
  90. <code>HeadScript</code>'s Schwester Helfer,
  91. <link linkend="zend.view.helpers.initial.inlinescript">InlineScript</link>, sollte
  92. verwendet werden wenn man Inline Skripte im HTML <code>body</code> inkludieren will. Die
  93. Platzierung von Skripten am Ende des Dokuments ist eine gängige Praxis für die
  94. schnellere Auslieferung von Seiten, speziell wenn 3rd Party Analyse Skripte verwendet
  95. werden.
  96. </para>
  97. </note>
  98. <note>
  99. <title>Andere Attribute werden stanadrdmäßig ausgeschaltet</title>
  100. <para>
  101. Standardmäßig wird <code>HeadScript</code> nur <code>&lt;script&gt;</code> Attribute
  102. darstellen die von W3C abgesegnet sind. Diese beinhalten 'type', 'charset', 'defer',
  103. 'language', und 'src'. Trotzdem, verwenden einige Javascript Frameworks, vorallem
  104. <ulink url="http://www.dojotoolkit.org/">Dojo</ulink>, eigene Attribute um Verhalten
  105. zu ändern. Um solche Attribute zu erlauben, können diese über die
  106. <methodname>setAllowArbitraryAttributes()</methodname> Methode eingeschaltet werden:
  107. </para>
  108. <programlisting language="php"><![CDATA[
  109. $this->headScript()->setAllowArbitraryAttributes(true);
  110. ]]></programlisting>
  111. </note>
  112. <example id="zend.view.helpers.initial.headscript.basicusage">
  113. <title>Grundsätzliche Verwendung des HeadScript Helfers</title>
  114. <para>
  115. Neue Skript Tags können jederzeit spezifiziert werden. Wie vorher beschrieben können
  116. diese Links auf externe Ressourcen Dateien oder Skripte sein.
  117. </para>
  118. <programlisting language="php"><![CDATA[
  119. // Skripte hinzufügen
  120. $this->headScript()->appendFile('/js/prototype.js')
  121. ->appendScript($onloadScript);
  122. ]]></programlisting>
  123. <para>
  124. Die Reihenfolge ist oft wichtig beim Clientseitigen Skripting; es kann notwendig sein
  125. sicherzustellen das Bibliotheken in einer speziellen Reihenfolge geladen werden da Sie
  126. Abhängigkeiten zueinander haben; die verschiedenen append, prepend und offsetSet
  127. Direktiven können hierbei helfen:
  128. </para>
  129. <programlisting language="php"><![CDATA[
  130. // Skripte in eine Reihenfolge bringen
  131. // An einem bestimmten Offset Platzieren um Sicherzustellen
  132. // das es als letztes geladen wird
  133. $this->headScript()->offsetSetFile(100, '/js/myfuncs.js');
  134. // Scriptige Effekte verwenden (append verwendet den nächsten Index, 101)
  135. $this->headScript()->appendFile('/js/scriptaculous.js');
  136. // Aber Basis Prototype Skripte müssen immer als erstes geladen werden
  137. $this->headScript()->prependFile('/js/prototype.js');
  138. ]]></programlisting>
  139. <para>
  140. Wenn man letztendlich damit fertig ist am alle Skripte im Layoutskript darzustellen, muß
  141. der Helfer einfach ausgegeben werden:
  142. </para>
  143. <programlisting language="php"><![CDATA[
  144. <?php echo $this->headScript() ?>
  145. ]]></programlisting>
  146. </example>
  147. <example id="zend.view.helpers.initial.headscript.capture">
  148. <title>Skripte einfachen mit Hilfe des HeadScript Helfers</title>
  149. <para>
  150. Manchmal mit ein Clientseitiges Skript programmtechnisch erstellt werden. Wärend man
  151. Strings zusammenhängen, Heredocs und ähnliches verwenden könnte, ist es oft einfacher
  152. nur das Skript zu erstellen und in <acronym>PHP</acronym> Tags einzubetten.
  153. <code>HeadScript</code> lässt das zu, und erfasst es in den Stack:
  154. </para>
  155. <programlisting language="php"><![CDATA[
  156. <?php $this->headScript()->captureStart() ?>
  157. var action = '<?php echo $this->baseUrl ?>';
  158. $('foo_form').action = action;
  159. <?php $this->headScript()->captureEnd() ?>
  160. ]]></programlisting>
  161. <para>
  162. Die folgenden Annahmen werden gemacht:
  163. </para>
  164. <itemizedlist>
  165. <listitem>
  166. <para>
  167. Das Skript wird an den Stack angefügt. Wenn es den Stack ersetzen soll oder an
  168. den Anfang hinzugefügt werden soll, muß 'SET' oder 'PREPEND' als erstes Argument
  169. an <methodname>captureStart()</methodname> übergeben werden.
  170. </para>
  171. </listitem>
  172. <listitem>
  173. <para>
  174. Der <acronym>MIME</acronym> Typ des Skripts wird mit 'text/javascript'
  175. angenommen; wenn ein anderer Typ spezifiziert werden soll muß dieser als zweites
  176. Argument an <methodname>captureStart()</methodname> übergeben werden.
  177. </para>
  178. </listitem>
  179. <listitem>
  180. <para>
  181. Wenn irgendwelche zusätzlichen Attribute für das <code>&lt;script&gt;</code> Tag
  182. spezifiziert werden sollen, müssen diese in einem Array als drittes Argument an
  183. <methodname>captureStart()</methodname> übergeben werden.
  184. </para>
  185. </listitem>
  186. </itemizedlist>
  187. </example>
  188. </sect3>
  189. <!--
  190. vim:se ts=4 sw=4 et:
  191. -->