Zend_Validate-Set.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 18298 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.validate.set" xmlns:xi="http://www.w3.org/2001/XInclude">
  5. <title>Standard Prüfklassen</title>
  6. <para>
  7. Zend Framework kommt mit einem Standardset von Prüfklassen, welche fertig zur Verwendung
  8. sind.
  9. </para>
  10. <sect2 id="zend.validate.set.alnum">
  11. <title>Alnum</title>
  12. <para>
  13. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> nur
  14. alphabetische und digitale Zeichen enthält. Dieser Prüfer enthält eine Option um
  15. auszuwählen ob Leerzeichen als gültig anzusehen sind.
  16. </para>
  17. <note>
  18. <para>
  19. Alphabetische Zeichen bedeuten Zeichen die in jeder Spache Wörter bilden. Trotzdem
  20. wird das englische Alphabet in den folgenden Sprachen für alphabethische Zeichen
  21. verwendet: Chinesisch, Japanisch, Koreanisch. Die Sprache wurde von
  22. <classname>Zend_Locale</classname> spezifiziert.
  23. </para>
  24. </note>
  25. </sect2>
  26. <sect2 id="zend.validate.set.alpha">
  27. <title>Alpha</title>
  28. <para>
  29. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> nur
  30. alphabetische Zeichen enthält. Dieser Prüfer enthält eine Option um auszuwählen ob
  31. Leerzeichen als gültig anzusehen sind.
  32. </para>
  33. </sect2>
  34. <sect2 id="zend.validate.set.barcode">
  35. <title>Barcode</title>
  36. <para>
  37. Dieser Prüfer wird mit einem Barcode Typ instanziert gegen den ein Barcode Wert geprüft
  38. werden soll. Aktuell werden die "<code>UPC-A</code>" (Universal Product Code) und
  39. "<code>EAN-13</code>" (European Article Number) Barcode Typen unterstützt, und die
  40. <methodname>isValid()</methodname> Methode gibt dann und nur dann true zurück wenn die
  41. Eingabe erfolgreich gegen den Barcode Prüfalgorithmus geprüft wurde. Es sollten alle von
  42. den Ziffern 0 bis 9 (0-9) unterschiedliche Zeichen vom Eingabewert entfernt werden bevor
  43. dieser an den Prüfer übergeben wird.
  44. </para>
  45. </sect2>
  46. <sect2 id="zend.validate.set.between">
  47. <title>Between</title>
  48. <para>
  49. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> zwischen
  50. dem minimalen und maximalen Grenzwert ist. Der Vergleich ist standardmäßig inklusive
  51. (<varname>$value</varname> kann gleich dem Grenzwert sein), kann aber überschrieben
  52. werden um einen strikten Vergleich dort durchzuführen wo <varname>$value</varname>
  53. strikt größer als das Minimum und strikt kleiner als das Maximum sein muß.
  54. </para>
  55. </sect2>
  56. <xi:include href="Zend_Validate-Callback.xml" />
  57. <sect2 id="zend.validate.set.ccnum">
  58. <title>Ccnum</title>
  59. <para>
  60. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> dem Luhn
  61. Algorithmus (mod-10 Checksumme) für Kreditkarten Nummern folgt.
  62. </para>
  63. </sect2>
  64. <sect2 id="zend.validate.set.date">
  65. <title>Date</title>
  66. <para>
  67. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> ein
  68. gültiges Datum im Format <code>YYYY-MM-DD</code> ist. Wenn die optionale
  69. <code>locale</code> Option gesetzt ist, dann wird das Datum entsprechend dem gesetzten
  70. Gebietsschemas geprüft. Und wenn die optionale <code>format</code> Option gesetzt wird,
  71. dann wird dieses Format für die Prüfung herangezogen. Für Details über die optionalen
  72. Parametern siehe <link
  73. linkend="zend.date.others.comparison.table">Zend_Date::isDate()</link>.
  74. </para>
  75. </sect2>
  76. <xi:include href="Zend_Validate-Db.xml" />
  77. <sect2 id="zend.validate.set.digits">
  78. <title>Digits</title>
  79. <para>
  80. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> nur
  81. digitale Zeichen enthält.
  82. </para>
  83. </sect2>
  84. <xi:include href="Zend_Validate-EmailAddress.xml" />
  85. <sect2 id="zend.validate.set.float">
  86. <title>Float</title>
  87. <para>
  88. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> ein
  89. Fließkomma Wert ist. Seit Zend Framework 1.8 verwendet diese Prüfung auch das aktuelle
  90. Gebietsschema des Browsers, der Umgebung oder eines anwendungsweit gesetzten
  91. Gebietsschemas. Man kann natürlich die Zugriffsmethoden get/setLocale verwenden um das
  92. verwendete Gebietsschema zu verändern oder es bei der Erstellung einer Instanz dieser
  93. Prüfung angeben.
  94. </para>
  95. </sect2>
  96. <sect2 id="zend.validate.set.greater_than">
  97. <title>GreaterThan</title>
  98. <para>
  99. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> größer als
  100. die Minimale Grenze ist.
  101. </para>
  102. </sect2>
  103. <sect2 id="zend.validate.set.hex">
  104. <title>Hex</title>
  105. <para>
  106. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> nur
  107. Hexadezimale Digitale Zeichen enthält.
  108. </para>
  109. </sect2>
  110. <xi:include href="Zend_Validate-Hostname.xml" />
  111. <sect2 id="zend.validate.set.iban">
  112. <title>Iban</title>
  113. <para>
  114. Gibe nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> eine
  115. gültige IBAN (Internationale Bank Account Nummer) enthält. IBAN Nummern werden gegen ein
  116. Land geprüft in dem Sie verwendet werden und durch eine Checksumme.
  117. </para>
  118. <para>
  119. Es gibt zwei Wege um IBAN Nummern zu prüfen. Als ersten Weg kann man ein Gebietsschema
  120. angeben das das Land repräsentiert. Jede angegebene IBAN Nummer wird das gegen dieses
  121. Land geprüft.
  122. </para>
  123. <programlisting language="php"><![CDATA[
  124. $validator = new Zend_Validate_Iban('de_AT');
  125. $iban = 'AT611904300234573201';
  126. if ($validator->isValid($iban)) {
  127. // IBAN scheint gültig zu sein
  128. } else {
  129. // IBAN ist ungültig
  130. foreach ($validator->getMessages() as $message) {
  131. echo "$message\n";
  132. }
  133. }
  134. ]]></programlisting>
  135. <para>
  136. Das sollte man tun wenn man IBAN Nummern gegen ein einzelnes Land prüfen will. Der
  137. einfachere Weg der Prüfung ist es kein Gebietsschema anzugeben wie im nächsten Beispiel
  138. gezeigt.
  139. </para>
  140. <programlisting language="php"><![CDATA[
  141. $validator = new Zend_Validate_Iban();
  142. $iban = 'AT611904300234573201';
  143. if ($validator->isValid($iban)) {
  144. // IBAN scheint gültig zu sein
  145. } else {
  146. // IBAN ist ungültig
  147. }
  148. ]]></programlisting>
  149. <para>
  150. Aber das zeigt ein großes Problem: Wenn man nur IBAN Nummern von einem einzelnen Land
  151. akzeptieren darf, zum Beispiel Frankreich, sind auch die IBAN Nummer von anderen Ländern
  152. gültig. Deshalb als Erinnerung: Wenn man IBAN Nummern gegen ein definiertes Land zu
  153. prüfen hat, sollte man ein Gebietsschema angeben. Und wenn man alle IBAN Nummern
  154. akzeptieren will unabhängig von irgendeinem Land kann der Einfachheit halber das
  155. Gebietsschema unterdrückt werden.
  156. </para>
  157. </sect2>
  158. <sect2 id="zend.validate.set.identical">
  159. <title>Identical</title>
  160. <para>
  161. Gibt nur dann <constant>TRUE</constant> zurück wenn der angegebene Token mit
  162. <varname>$value</varname> identisch ist. Diese Prüfung kann jeden beliebigen Typ
  163. handhaben.
  164. </para>
  165. <para>
  166. Der Token gegen den geprüft werden soll kann entweder als Parameter bei der
  167. Instanziierung gesetzt werden, oder durch die Verwendung der
  168. <methodname>setToken()</methodname> Methode.
  169. </para>
  170. <programlisting language="php"><![CDATA[
  171. // Setzen des Token bei der Instanziierung
  172. $validator = new Zend_Validate_Identical(array('one' => 'two'));
  173. if ($validator->isValid(array('one' => 'two'))) { // Token gültig
  174. // Irgendwas machen
  175. }
  176. // Setzen des Tokens durch Verwendung von setToken()
  177. $validator->setToken(true);
  178. if ($validator->isValid(1)) { // Token gültig
  179. // Irgendwas machen
  180. }
  181. ]]></programlisting>
  182. </sect2>
  183. <xi:include href="Zend_Validate-InArray.xml" />
  184. <sect2 id="zend.validate.set.int">
  185. <title>Int</title>
  186. <para>
  187. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> ein
  188. gültiger Integer ist. Seit Zend Framework 1.8 verwendet diese Prüfung auch das aktuelle
  189. Gebietsschema des Browsers, der Umgebung oder eines anwendungsweit gesetzten
  190. Gebietsschemas. Man kann natürlich die Zugriffsmethoden get/setLocale verwenden um das
  191. verwendete Gebietsschema zu verändern oder es bei der Erstellung einer Instanz dieser
  192. Prüfung angeben.
  193. </para>
  194. </sect2>
  195. <sect2 id="zend.validate.set.ip">
  196. <title>Ip</title>
  197. <para>
  198. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> eine
  199. gültige IP Adresse ist.
  200. </para>
  201. </sect2>
  202. <sect2 id="zend.validate.set.less_than">
  203. <title>LessThan</title>
  204. <para>
  205. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> kleiner
  206. als die Maximale Grenze ist.
  207. </para>
  208. </sect2>
  209. <sect2 id="zend.validate.set.not_empty">
  210. <title>NotEmpty</title>
  211. <para>
  212. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> kein
  213. leerer Wert ist.
  214. </para>
  215. </sect2>
  216. <xi:include href="Zend_Validate-PostCode.xml" />
  217. <sect2 id="zend.validate.set.regex">
  218. <title>Regex</title>
  219. <para>
  220. Gibt nur dann <constant>TRUE</constant> zurück wenn <varname>$value</varname> mit einem
  221. Regular Expression Pattern geprüft werden kann.
  222. </para>
  223. </sect2>
  224. <xi:include href="Zend_Validate-Sitemap.xml" />
  225. <sect2 id="zend.validate.set.string_length">
  226. <title>StringLength</title>
  227. <para>
  228. Gibt nur dann <constant>TRUE</constant> zurück wenn die Länge des Strings von
  229. <varname>$value</varname> mindstens ein Minimum und nicht größer als ein Maximum ist
  230. (wenn die max Option nicht <constant>NULL</constant> ist). Wirft die
  231. <methodname>setMin()</methodname> Methode eine Ausnahme wenn die minimale Länge auf
  232. einen größeren Wert gesetzt wird als die maximale Länge, und die
  233. <methodname>setMax()</methodname> Methode wirft eine Ausnahme wenn die maximale Länge
  234. auf einen kleineren Wert als die minimale Länge gesetzt wird. Seit Version 1.0.2
  235. unterstützt diese Klasse UTF-8 und andere Zeichensätze, basierend auf dem aktuellen Wert
  236. von <ulink
  237. url="http://www.php.net/manual/de/ref.iconv.php#iconv.configuration"><code>iconv.internal_encoding</code></ulink>.
  238. Wenn man ein anderes Encoding benötigt kann man es mit den Zugriffsmethoden getEncoding
  239. und setEncoding setzen.
  240. </para>
  241. </sect2>
  242. </sect1>
  243. <!--
  244. vim:se ts=4 sw=4 et:
  245. -->