Zend_Validate-Set.xml 11 KB

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