Zend_View-Helpers-HeadScript.xml 9.8 KB

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