Zend_View-Helpers-HeadMeta.xml 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 17340 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.view.helpers.initial.headmeta">
  5. <title>HeadMeta Helfer</title>
  6. <para>
  7. Das HTML Element <code>&lt;meta&gt;</code> wird verwendet um Meta Informationen über das
  8. HTML Dokument anzubieten -- typischerweise Schlüsselwörter. Dokument Zeichensätze, Cache
  9. Pragmas, usw. Meta Tags können entweder 'http-equiv' oder 'name' Typen sein, müssen ein
  10. 'content' Attribut enthalten, und können auch eines der 'lang' oder 'scheme' Modifikator
  11. Attributen enthalten.
  12. </para>
  13. <para>
  14. Der <code>HeadMeta</code> Helfer unterstützt die folgenden Methoden für das Setzen und
  15. Hinzufügen von Meta Tags:
  16. </para>
  17. <itemizedlist>
  18. <listitem><para><code>appendName($keyValue, $content,
  19. $conditionalName)</code></para></listitem>
  20. <listitem><para><code>offsetSetName($index, $keyValue, $content,
  21. $conditionalName)</code></para></listitem>
  22. <listitem><para><code>prependName($keyValue, $content,
  23. $conditionalName)</code></para></listitem>
  24. <listitem><para><code>setName($keyValue, $content,
  25. $modifiers)</code></para></listitem>
  26. <listitem><para><code>appendHttpEquiv($keyValue, $content,
  27. $conditionalHttpEquiv)</code></para></listitem>
  28. <listitem><para><code>offsetSetHttpEquiv($index, $keyValue, $content,
  29. $conditionalHttpEquiv)</code></para></listitem>
  30. <listitem><para><code>prependHttpEquiv($keyValue, $content,
  31. $conditionalHttpEquiv)</code></para></listitem>
  32. <listitem><para><code>setHttpEquiv($keyValue, $content,
  33. $modifiers)</code></para></listitem>
  34. </itemizedlist>
  35. <para>
  36. Das <varname>$keyValue</varname> Element wird verwendet um einen Wert für den 'name' oder
  37. 'http-equiv' Schlüssel zu definieren; <varname>$content</varname> ist der Wert für den
  38. 'content' Schlüssel, und <varname>$modifiers</varname> ist ein optionales assoziatives Array
  39. das Schlüssel für 'land und/oder 'scheme' enthalten kann.
  40. </para>
  41. <para>
  42. Meta Tags können auch gesetzt werden indem die <methodname>headMeta()</methodname>
  43. Helfermethode verwendet wird, welche die folgende Signatur hat: <code>headMeta($content,
  44. $keyValue, $keyType = 'name', $modifiers = array(), $placement = 'APPEND')</code>.
  45. <varname>$keyValue</varname> ist der Intalt für den Schlüssel der in
  46. <varname>$keyType</varname> spezifiziert ist, und welche entweder 'name' oder 'http-equiv'
  47. sein sollte. <varname>$placement</varname> kann entweder 'SET' (überschreibt alle vorher
  48. gespeicherten Werte), 'APPEND' (fügt an das Ende des Stacks hinzu), oder 'PREPEND' (fügt an
  49. den Beginn des Stacks hinzu) sein.
  50. </para>
  51. <para>
  52. <code>HeadMeta</code> überschreibt <methodname>append()</methodname>,
  53. <methodname>offsetSet()</methodname>, <methodname>prepend()</methodname>, und
  54. <methodname>set()</methodname> um die Verwendung der speziellen Methoden wie oben gelistet
  55. zu erzwingen. Intern wird jedes Element als <code>stdClass</code> Token gespeichert, welches
  56. später durch Verwendung der <methodname>itemToString()</methodname> Methode serialisiert
  57. wird. Das erlaubt es Prüfungen an den Elementen im Stack durchzuführen, und diese Elemente
  58. optional zu verändern indem einfach das zurückgegebene Objekt verändert wird.
  59. </para>
  60. <para>
  61. Der <code>HeadMeta</code> Helfer ist eine konkrete Implementation des
  62. <link linkend="zend.view.helpers.initial.placeholder">Platzhalter Helfers</link>.
  63. </para>
  64. <example id="zend.view.helpers.initial.headmeta.basicusage">
  65. <title>Grundsätzliche Verwendung des HeadMeta Helfers</title>
  66. <para>
  67. Neue Meta Tags können jederzeit spezifiziert werden. Typischerweise werden Clientseitige
  68. Cacheregeln oder SEO Schlüsselwörter spezifiziert.
  69. </para>
  70. <para>
  71. Wenn zum Beispiel ein spezielles SEO Schlüsselwort spezifiziert werden soll, kann das
  72. durch die Erstellung eines Meta Nametags, mit dem Namen 'keywords' und dem Inhalt des
  73. Schlüsselworts das mit der Seite assoziiert werden soll, geschehen:
  74. </para>
  75. <programlisting language="php"><![CDATA[
  76. // Meta Schlüsselwörter setzen
  77. $this->headMeta()->appendName('keywords', 'framework, PHP, productivity');
  78. ]]></programlisting>
  79. <para>
  80. Wenn Clientseitige Cacheregeln gesetzt werden sollen, können http-equiv Tags mit den
  81. Regeln die erzwungen werden sollen, gesetzt werden:
  82. </para>
  83. <programlisting language="php"><![CDATA[
  84. // Clientseitiges cachen verhindern
  85. $this->headMeta()->appendHttpEquiv('expires',
  86. 'Wed, 26 Feb 1997 08:21:57 GMT')
  87. ->appendHttpEquiv('pragma', 'no-cache')
  88. ->appendHttpEquiv('Cache-Control', 'no-cache');
  89. ]]></programlisting>
  90. <para>
  91. Ein anderer populärer Verwendungszweck für Meta Tags ist das Setzen des Inhalt-Typs,
  92. Zeichensatzes, und der Sprache:
  93. </para>
  94. <programlisting language="php"><![CDATA[
  95. // Setzen des Inhalttyps und des Zeichensatzes
  96. $this->headMeta()->appendHttpEquiv('Content-Type',
  97. 'text/html; charset=UTF-8')
  98. ->appendHttpEquiv('Content-Language', 'en-US');
  99. ]]></programlisting>
  100. <para>
  101. Als letztes Beispiel, ein einfacher Weg um eine kurze Nachricht anzuzeigen bevor mit
  102. Hilfe eines "Meta Refreshes" weitergeleitet wird:
  103. </para>
  104. <programlisting language="php"><![CDATA[
  105. // Einen Meta Refresh mit 3 Sekunden zu einer neuen URL setzen:
  106. $this->headMeta()->appendHttpEquiv('Refresh',
  107. '3;URL=http://www.some.org/some.html');
  108. ]]></programlisting>
  109. <para>
  110. Wenn man bereit ist die Meta Tags im Layout zu platzieren, muß einfach der Helfer
  111. ausgegeben werden:
  112. </para>
  113. <programlisting language="php"><![CDATA[
  114. <?php echo $this->headMeta() ?>
  115. ]]></programlisting>
  116. </example>
  117. </sect3>
  118. <!--
  119. vim:se ts=4 sw=4 et:
  120. -->