Zend_Uri.xml 8.7 KB

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