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

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect2 id="zend.validate.set.lessthan">
   4     <title>LessThan</title>
   5
   6     <para>
   7         <classname>Zend_Validate_LessThan</classname> allows you to validate if a given value is
   8         less than a maximum border value. It is the cousine of
   9         <classname>Zend_Validate_GreaterThan</classname>.
  10     </para>
  11
  12     <note>
  13         <title>Zend_Validate_LessThan supports only number validation</title>
  14
  15         <para>
  16             It should be noted that <classname>Zend_Validate_LessThan</classname> supports only the
  17             validation of numbers. Strings or dates can not be validated with this validator.
  18         </para>
  19     </note>
  20
  21     <sect3 id="zend.validate.set.lessthan.options">
  22         <title>Supported options for Zend_Validate_LessThan</title>
  23
  24         <para>
  25             The following options are supported for <classname>Zend_Validate_LessThan</classname>:
  26         </para>
  27
  28         <itemizedlist>
  29             <listitem>
  30                 <para>
  31                     <emphasis><property>max</property></emphasis>: Sets the maximum allowed value.
  32                 </para>
  33             </listitem>
  34         </itemizedlist>
  35     </sect3>
  36
  37     <sect3 id="zend.validate.set.lessthan.basic">
  38         <title>Basic usage</title>
  39
  40         <para>
  41             To validate if a given value is less than a defined border simply use the following
  42             example.
  43         </para>
  44
  45         <programlisting language="php"><![CDATA[
  46 $valid  = new Zend_Validate_LessThan(array('max' => 10));
  47 $value  = 10;
  48 $return = $valid->isValid($value);
  49 // returns true
  50 ]]></programlisting>
  51
  52         <para>
  53             The above example returns <constant>TRUE</constant> for all values which are equal to 10
  54             or lower than 10.
  55         </para>
  56     </sect3>
  57 </sect2>
  58 <!--
  59 vim:se ts=4 sw=4 et:
  60 -->