documentation/manual/en/module_specs/Zend_Validate-Between.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect2 id="zend.validate.set.between">
   4     <title>Between</title>
   5
   6     <para>
   7         <classname>Zend_Validate_Between</classname> allows you to validate if a given value is
   8         between two other values.
   9     </para>
  10
  11     <note>
  12         <title>Zend_Validate_Between supports only number validation</title>
  13
  14         <para>
  15             It should be noted that Zend_Validate_Between supports only the validation of numbers.
  16             Strings or dates can not be validated with this validator.
  17         </para>
  18     </note>
  19
  20     <sect3 id="zend.validate.set.between.options">
  21         <title>Supported options for Zend_Validate_Between</title>
  22
  23         <para>
  24             The following options are supported for <classname>Zend_Validate_Between</classname>:
  25         </para>
  26
  27         <itemizedlist>
  28             <listitem>
  29                 <para>
  30                     <emphasis><property>inclusive</property></emphasis>: Defines if the validation
  31                     is inclusive the minimum and maximum border values or exclusive. It defaults
  32                     to <constant>TRUE</constant>.
  33                 </para>
  34             </listitem>
  35
  36             <listitem>
  37                 <para>
  38                     <emphasis><property>min</property></emphasis>: Sets the minimum border for the
  39                     validation.
  40                 </para>
  41             </listitem>
  42
  43             <listitem>
  44                 <para>
  45                     <emphasis><property>max</property></emphasis>: Sets the maximum border for the
  46                     validation.
  47                 </para>
  48             </listitem>
  49         </itemizedlist>
  50     </sect3>
  51
  52     <sect3 id="zend.validate.set.between.basic">
  53         <title>Default behaviour for Zend_Validate_Between</title>
  54
  55         <para>
  56             Per default this validator checks if a value is between <property>min</property> and
  57             <property>max</property> where both border values are allowed as value.
  58         </para>
  59
  60         <programlisting language="php"><![CDATA[
  61 $valid  = new Zend_Validate_Between(array('min' => 0, 'max' => 10));
  62 $value  = 10;
  63 $result = $valid->isValid($value);
  64 // returns true
  65 ]]></programlisting>
  66
  67         <para>
  68             In the above example the result is <constant>TRUE</constant> due to the reason that per
  69             default the search is inclusively the border values. This means in our case that any
  70             value from '0' to '10' is allowed. And values like '-1' and '11' will return
  71             <constant>FALSE</constant>.
  72         </para>
  73     </sect3>
  74
  75     <sect3 id="zend.validate.set.between.inclusively">
  76         <title>Validation exclusive the border values</title>
  77
  78         <para>
  79             Sometimes it is useful to validate a value by excluding the border values. See the
  80             following example:
  81         </para>
  82
  83         <programlisting language="php"><![CDATA[
  84 $valid  = new Zend_Validate_Between(
  85     array(
  86         'min' => 0,
  87         'max' => 10,
  88         'inclusive' => false
  89     )
  90 );
  91 $value  = 10;
  92 $result = $valid->isValid($value);
  93 // returns false
  94 ]]></programlisting>
  95
  96         <para>
  97             The example is almost equal to our first example but we excluded the border value. Now
  98             the values '0' and '10' are no longer allowed and will return <constant>FALSE</constant>.
  99         </para>
 100     </sect3>
 101 </sect2>
 102 <!--
 103 vim:se ts=4 sw=4 et:
 104 -->