Zend_View-Helpers-HeadScript.xml 9.6 KB

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