Zend_Uri.xml 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15234 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.uri.chapter">
  5. <title>Zend_Uri</title>
  6. <sect2 id="zend.uri.overview">
  7. <title>Überblick</title>
  8. <para>
  9. <classname>Zend_Uri</classname> ist eine Komponente, die das Verändern und Validieren von
  10. <ulink url="http://www.w3.org/Addressing/">Uniform Resource Identifiers</ulink> (URIs)
  11. unterstützt. <classname>Zend_Uri</classname> existiert hauptsächlich, um andere Komponenten wie z.B.
  12. <classname>Zend_Http_Client</classname> zu unterstützen, aber ist auch als eigenständiges Hilfsmittel
  13. nützlich.
  14. </para>
  15. <para>
  16. URIs beginnen immer mit einem Schema, gefolgt von einem Doppelpunkt. Der Aufbau der vielen
  17. unterschiedlichen Schemata unterscheidet sich erheblich. Die <classname>Zend_Uri</classname> stellt
  18. eine Fabrik (Factory) bereit, die eine Unterklasse von sich selber zurück gibt, die auf das
  19. entsprechende Schema spezialisiert ist. Diese Unterklasse heißt
  20. <classname>Zend_Uri_&lt;scheme&gt;</classname>, wobei <code>&lt;scheme&gt;</code> das Schema in
  21. Kleinbuchstaben mit einem Großbuchstaben am Anfang darstellt. Eine Ausnahme dieser Regel ist
  22. HTTPS, das auch von <classname>Zend_Uri_Http</classname> verarbeitet wird.
  23. </para>
  24. </sect2>
  25. <sect2 id="zend.uri.creation">
  26. <title>Eine neue URI erstellen</title>
  27. <para>
  28. <classname>Zend_Uri</classname> erstellt eine neue URI von Grund auf, wenn nur das Schema an
  29. <classname>Zend_Uri::factory()</classname> übergeben wurde.
  30. </para>
  31. <example id="zend.uri.creation.example-1">
  32. <title>Erstellen einer neuen URI mit Zend_Uri::factory()</title>
  33. <programlisting role="php"><![CDATA[
  34. // Um eine neue URI von Grund auf zu erstellen, übergebe nur das Schema.
  35. $uri = Zend_Uri::factory('http');
  36. // $uri instanceof Zend_Uri_Http
  37. ]]></programlisting>
  38. </example>
  39. <para>
  40. Um eine neue URI von Grund auf zu erstellen, übergibt man nur das Schema an
  41. <classname>Zend_Uri::factory()</classname><footnote><para>Zum Zeitpunkt des Schreiben unterstützt
  42. Zend_Uri nur HTTP uznd HTTPS Schemata</para></footnote> . Wenn eine nicht unterstütztes
  43. Schema übergeben wird, wird eine <classname>Zend_Uri_Exception</classname> ausgeworfen.
  44. </para>
  45. <para>
  46. Wenn das Schema oder die übergebene URI unterstützt wird, gibt
  47. <classname>Zend_Uri::factory()</classname> eine Unterklasse von sich selbst zurück, die auf das zu
  48. erstellende Schema spezialisiert ist.
  49. </para>
  50. </sect2>
  51. <sect2 id="zend.uri.manipulation">
  52. <title>Verändern einer vorhandenen URI</title>
  53. <para>
  54. Um eine vorhandene URI zu verändern, übergibt man die komplett URI an
  55. <classname>Zend_Uri::factory()</classname>.
  56. </para>
  57. <example id="zend.uri.manipulation.example-1">
  58. <title>Verändern einer vorhandenen URI mit Zend_Uri::factory()</title>
  59. <programlisting role="php"><![CDATA[
  60. // Um eine vorhandene URI zu verändern, übergibt man sie.
  61. $uri = Zend_Uri::factory('http://www.zend.com');
  62. // $uri instanceof Zend_Uri_Http
  63. ]]></programlisting>
  64. </example>
  65. <para>
  66. Die URI wird analysiert und validiert. Wenn sie als ungültig erkannt wird, wird sofort eine
  67. <classname>Zend_Uri_Exception</classname> geworfen. Andernfalls gibt <classname>Zend_Uri::factory()</classname>
  68. eine Unterklasse von sich selbst zurück, die auf das zu verändernde Schema spezialisiert
  69. ist.
  70. </para>
  71. </sect2>
  72. <sect2 id="zend.uri.validation">
  73. <title>URI Validierung</title>
  74. <para>
  75. Die <classname>Zend_Uri::check()</classname> Methode kann verwendet werden, wenn nur das Validieren
  76. einer vorhandenen URI benötigt wird.
  77. </para>
  78. <example id="zend.uri.validation.example-1">
  79. <title>URI Validierung mit Zend_Uri::check()</title>
  80. <programlisting role="php"><![CDATA[
  81. // Überprüfe, ob eine übergebe URI wohlgeformt ist
  82. $valid = Zend_Uri::check('http://uri.in.question');
  83. // $valid ist TRUE für eine valide URI, andernfalls FALSE
  84. ]]></programlisting>
  85. </example>
  86. <para>
  87. <classname>Zend_Uri::check()</classname> gibt ein Boolean zurück, was einfacher ist, als
  88. <classname>Zend_Uri::factory()</classname> zu verwenden und eine Ausnahme abzufangen.
  89. </para>
  90. <sect3 id="zend.uri.validation.allowunwise">
  91. <title>"Unwise" Zeichen in URIs erlauben</title>
  92. <para>
  93. Standardmäßig wird Zend_Uri die folgenden Zeichen nicht akzepzieren, da Sie durch die RFC als
  94. "unwise" definiert und deshalb ungültig sind: <code>"{", "}", "|", "\", "^", "`"</code>.
  95. Trotzdem, akzeptieren viele Implementierungen diese Zeichen als Gültig.
  96. </para>
  97. <para>
  98. Zend_Uri kann so eingestellt werden das es diese "unwise" Zeichen akzeptiert indem die
  99. 'allow_unwise' Option auf ein boolsches TRUE gesetzt wird, durch Verwendung der
  100. Zend_Uri::setConfig() Methode:
  101. </para>
  102. <example id="zend.uri.validation.allowunwise.example-1">
  103. <title>Spezielle Zeichen in URIs erlauben</title>
  104. <programlisting role="php"><![CDATA[
  105. // Enthält das '|' Symbol
  106. // Normal würde das false zurückgeben:
  107. $valid = Zend_Uri::check('http://example.com/?q=this|that');
  108. // Trotzdem kann man diese "unwise" Zeichen erlauben
  109. Zend_Uri::setConfig(array('allow_unwise' => true));
  110. // Gibt 'true' zurück
  111. $valid = Zend_Uri::check('http://example.com/?q=this|that');
  112. // Setzt den Wert 'allow_unwise' auf das Standardmäßige FALSE zurück
  113. Zend_Uri::setConfig(array('allow_unwise' => false));
  114. ]]></programlisting>
  115. </example>
  116. <note><para>
  117. <classname>Zend_Uri::setConfig()</classname> setzt Konfigurationsoptionen global. Es wird empfohlen die
  118. 'allow_unwise' Option auf 'false' zurückzusetzen wie im obigen Beispiel, solange man unwise
  119. Zeichen immer global erlauben will.
  120. </para></note>
  121. </sect3>
  122. </sect2>
  123. <sect2 id="zend.uri.instance-methods">
  124. <title>Allgemeine Instanzmethoden</title>
  125. <para>
  126. Jede Instant einer <classname>Zend_Uri</classname> Unterklasse (z.B. <classname>Zend_Uri_Http</classname>) hat
  127. verschiedene Instanzmethoden, die für die Verwendung mit jeglicher URI nützlich sind.
  128. </para>
  129. <sect3 id="zend.uri.instance-methods.getscheme">
  130. <title>Das Schema der URI erhalten</title>
  131. <para>
  132. Das Schema der URI ist der Teil der URI vor dem Doppelpunkt. Zum Beispiel ist
  133. <code>http</code> das Schema von <code>http://www.zend.com</code>.
  134. </para>
  135. <example id="zend.uri.instance-methods.getscheme.example-1">
  136. <title>Das Schema eines Zend_Uri_* Objektes erhalten</title>
  137. <programlisting role="php"><![CDATA[
  138. $uri = Zend_Uri::factory('http://www.zend.com');
  139. $scheme = $uri->getScheme(); // "http"
  140. ]]></programlisting>
  141. </example>
  142. <para>
  143. Die <code>getScheme()</code> Instanzmethode gibt nur das Schema des URI Objektes
  144. zurück.
  145. </para>
  146. </sect3>
  147. <sect3 id="zend.uri.instance-methods.geturi">
  148. <title>Die komplette URI erhalten</title>
  149. <example id="zend.uri.instance-methods.geturi.example-1">
  150. <title>Die komplette URI eines Zend_Uri_* Objektes erhalten</title>
  151. <programlisting role="php"><![CDATA[
  152. $uri = Zend_Uri::factory('http://www.zend.com');
  153. echo $uri->getUri(); // "http://www.zend.com"
  154. ]]></programlisting>
  155. </example>
  156. <para>
  157. Die <code>getUri()</code> Methode gibt den String zurück, der die komplette URI
  158. repräsentiert.
  159. </para>
  160. </sect3>
  161. <sect3 id="zend.uri.instance-methods.valid">
  162. <title>Die URI validieren</title>
  163. <para>
  164. <classname>Zend_Uri::factory()</classname> validiert immer jede übergebene URI und wird keine
  165. <classname>Zend_Uri</classname> Unterklasse instantieren, wenn die übergebene URI ungültig ist.
  166. Dennoch ist es nach der Instanzierung der <classname>Zend_Uri</classname> Unterklasse für eine neue
  167. oder eine bestehende URI möglich, dass die URI später ungültig wird, nachdem sie verändert
  168. worden ist.
  169. </para>
  170. <example id="zend.uri.instance-methods.valid.example-1">
  171. <title>Ein Zend_Uri_* Object validieren</title>
  172. <programlisting role="php"><![CDATA[
  173. $uri = Zend_Uri::factory('http://www.zend.com');
  174. $isValid = $uri->valid(); // TRUE
  175. ]]></programlisting>
  176. </example>
  177. <para>
  178. Die <code>valid()</code> Instanzmethode ermöglicht es, das URI Objekt auf Gültigkeit zu
  179. überprüfen.
  180. </para>
  181. </sect3>
  182. </sect2>
  183. </sect1>
  184. <!--
  185. vim:se ts=4 sw=4 et:
  186. -->