Zend_Validate-InArray.xml 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 18822 -->
  3. <!-- Reviewed: no -->
  4. <sect2 id="zend.validate.set.in_array">
  5. <title>InArray</title>
  6. <para>
  7. <classname>Zend_Validate_InArray</classname> erlaubt es zu prüfen ob ein gegebener Wert
  8. in einem Array enthalten ist. Er ist auch in der Lage mehrdimensionale Arrays zu prüfen.
  9. </para>
  10. <sect3 id="zend.validate.set.in_array.basic">
  11. <title>Einfache Array Prüfung</title>
  12. <para>
  13. Der einfachste Weg ist es, das Array welches durchsucht werden soll, bei der
  14. Initiierung anzugeben:
  15. </para>
  16. <programlisting language="php"><![CDATA[
  17. $validator = new Zend_Validate_InArray(array('key' => 'value',
  18. 'otherkey' => 'othervalue'));
  19. if ($validator->isValid('value')) {
  20. // Wert gefunden
  21. } else {
  22. // Wert nicht gefunden
  23. }
  24. ]]></programlisting>
  25. <para>
  26. Das verhält sich genauso wie <acronym>PHP</acronym>'s
  27. <methodname>in_array()</methodname> Methode.
  28. </para>
  29. <note>
  30. <para>
  31. Standardmäßig ist diese Prüfung nicht strikt noch kann Sie mehrdimensionale Arrays
  32. prüfen.
  33. </para>
  34. </note>
  35. <para>
  36. Natürlich kann man das Array gegen das geprüft werden soll auch im Nachhinein durch
  37. Verwendung der <methodname>setHaystack()</methodname> Methode angegeben werden.
  38. <methodname>getHaystack()</methodname> gibt das aktuell gesetzte Haystack Array zurück.
  39. </para>
  40. <programlisting language="php"><![CDATA[
  41. $validator = new Zend_Validate_InArray();
  42. $validator->setHaystack(array('key' => 'value', 'otherkey' => 'othervalue'));
  43. if ($validator->isValid('value')) {
  44. // Wert gefunden
  45. } else {
  46. // Wert nicht gefunden
  47. }
  48. ]]></programlisting>
  49. </sect3>
  50. <sect3 id="zend.validate.set.in_array.strict">
  51. <title>Strikte Array Prüfung</title>
  52. <para>
  53. Wie vorher erwähnt kann man auch eine Strikte Prüfung im Array durchführen.
  54. Standardmäßig würde kein Unterschied zwischen dem Integerwert <emphasis>0</emphasis>
  55. und dem String <emphasis>"0"</emphasis> sein. Wenn eine strikte Prüfung durchgeführt
  56. wird dann wird dieser Unterschied auch geprüft und nur gleiche Typen werden akzeptiert.
  57. </para>
  58. <para>
  59. Eine strikte Prüfung kann auch auf zwei verschiedenen Wegen durchgeführt werden. Bei
  60. der Initiierung und durch Verwendung einer Methode. Bei der Initiierung muß hierfür ein
  61. Array mit der folgenden Struktur angegeben werden:
  62. </para>
  63. <programlisting language="php"><![CDATA[
  64. $validator = new Zend_Validate_InArray(
  65. array(
  66. 'haystack' => array('key' => 'value', 'otherkey' => 'othervalue'),
  67. 'strict' => true
  68. )
  69. );
  70. if ($validator->isValid('value')) {
  71. // Wert gefunden
  72. } else {
  73. // Wert nicht gefunden
  74. }
  75. ]]></programlisting>
  76. <para>
  77. Der <emphasis>haystack</emphasis> Schlüssel enthält das eigene Array das für die
  78. Prüfung verwendet wird. Durch das Setzen des <emphasis>script</emphasis> Schlüssels
  79. auf <constant>TRUE</constant> wird die Prüfung so durchgeführt, das der Typ strikt
  80. geprüft wird.
  81. </para>
  82. <para>
  83. Natürlich kann man auch die <methodname>setStrict()</methodname> Methode verwenden
  84. um diese Einstellung im Nachhinein zu ändern und <methodname>getStrict()</methodname>
  85. um den aktuell gesetzten Status zu erhalten.
  86. </para>
  87. <note>
  88. <para>
  89. Es ist zu beachten das die <emphasis>strict</emphasis> Einstellung standardmäßig
  90. <constant>FALSE</constant> ist.
  91. </para>
  92. </note>
  93. </sect3>
  94. <sect3 id="zend.validate.set.in_array.recursive">
  95. <title>Rekursive Array Prüfung</title>
  96. <para>
  97. Zusätzlich zu <acronym>PHP</acronym>'s <methodname>in_array()</methodname> Methode kann
  98. diese Prüfung auch verwendet werden um Mehrdimensionale Arrays zu prüfen.
  99. </para>
  100. <para>
  101. Um mehrdimensionale Array zu prüfen muß die <emphasis>recursive</emphasis> Option
  102. gesetzt werden.
  103. </para>
  104. <programlisting language="php"><![CDATA[
  105. $validator = new Zend_Validate_InArray(
  106. array(
  107. 'haystack' => array(
  108. 'firstDimension' => array('key' => 'value',
  109. 'otherkey' => 'othervalue'),
  110. 'secondDimension' => array('some' => 'real',
  111. 'different' => 'key')),
  112. 'recursive' => true
  113. )
  114. );
  115. if ($validator->isValid('value')) {
  116. // Wert gefunden
  117. } else {
  118. // Wert nicht gefunden
  119. }
  120. ]]></programlisting>
  121. <para>
  122. Das eigene Array wird das rekursiv geprüft um zu sehen ob der angegebene Wert enthalten
  123. ist. Zusätzlich kann <methodname>setRecursive()</methodname> verwendet werden um diese
  124. Option im Nachhinein zu setzen und <methodname>getRecursive()</methodname> um Ihn zu
  125. erhalten.
  126. </para>
  127. <programlisting language="php"><![CDATA[
  128. $validator = new Zend_Validate_InArray(
  129. array(
  130. 'firstDimension' => array('key' => 'value',
  131. 'otherkey' => 'othervalue'),
  132. 'secondDimension' => array('some' => 'real',
  133. 'different' => 'key')
  134. )
  135. );
  136. $validator->setRecursive(true);
  137. if ($validator->isValid('value')) {
  138. // Wert gefunden
  139. } else {
  140. // kein Wert gefunden
  141. }
  142. ]]></programlisting>
  143. <note>
  144. <title>Standardwert für die Rekursion</title>
  145. <para>
  146. Standardmäßig ist die rekursive Prüfung ausgeschaltet.
  147. </para>
  148. </note>
  149. <note>
  150. <title>Optionsschlüssel im Haystack</title>
  151. <para>
  152. Wenn man die Schlüssel '<property>haystack</property>',
  153. '<property>strict</property>' oder '<property>recursive</property>' im eigenen
  154. Haystack verwenden, dann muß man diese mit dem <property>haystack</property>
  155. Schlüssel einhüllen.
  156. </para>
  157. </note>
  158. </sect3>
  159. </sect2>
  160. <!--
  161. vim:se ts=4 sw=4 et:
  162. -->