tangra logo
   
[ class tree: tangra_lib ] [ index: tangra_lib ] [ all elements ]
 

Source for file form_field_integer_limited.class.php

Documentation is available at form_field_integer_limited.class.php

  1. <?php
  2. // *** Tangra (Application Framework and Tools for PHP)
  3. //  $Id$
  4. //
  5.  
  6. /**
  7.  * Contains class Form_Field_Date
  8.  *
  9.  * @package tangra_lib
  10.  * @subpackage form
  11.  */
  12.  
  13. /**
  14.  *
  15.  */
  16. require_once(TANGRA_MAIN_DIR.'form/fields/integer/form_field_integer.class.php');
  17.  
  18.  
  19. /**
  20.  * Represents text field that accepts limited integer
  21.  *
  22.  * @package tangra_lib
  23.  * @subpackage form
  24.  */
  25. class Form_Field_Integer_Limited extends Form_Field_Integer {
  26.     /**
  27.      * Minumum value
  28.      *
  29.      * @var integer 
  30.      * @internal
  31.      */
  32.     private $min_val;
  33.     /**
  34.      * Maximum value
  35.      *
  36.      * @var integer 
  37.      * @internal
  38.      */
  39.     private $max_val;
  40.  
  41.  
  42.     /**
  43.      * Constructor
  44.      *
  45.      * @param string $name Name of the field
  46.      * @param integer $min_val Minimum accepted value
  47.      * @param integer $max_val maximum accepted value
  48.      * @param boolean $required Is field required. Default is false
  49.      * @param integer $maxlength Maximum length of the text. Default is 10
  50.      * @param integer $value Default value
  51.      */
  52.     function __construct($name, $min_val, $max_val, $required = false, $maxlength = 100, $value = NULL) {
  53.         parent::__construct($name, $required, $maxlength, $value);
  54.  
  55.         $this->set_min_val($min_val);
  56.         $this->set_max_val($max_val);
  57.  
  58.         $this->add_potential_error('integer_greater');
  59.         $this->add_potential_error('integer_smaller');
  60.     }
  61.  
  62.  
  63.     /**
  64.      * Sets minimum accepted value
  65.      *
  66.      * @param integer $min_val 
  67.      */
  68.     public function set_min_val($min_val) {
  69.         tangra_if_not_int_throw_e($min_val);
  70.         $this->min_val = $min_val;
  71.     }
  72.  
  73.  
  74.     /**
  75.      * Sets maximum accepted value
  76.      *
  77.      * @param integer $max_val 
  78.      */
  79.     public function set_max_val($max_val) {
  80.         tangra_if_not_int_throw_e($max_val);
  81.         $this->max_val = $max_val;
  82.     }
  83.  
  84.  
  85.     /**
  86.      * Returns minimum accepted value
  87.      *
  88.      * @return integer 
  89.      */
  90.     public function get_min_val() {
  91.         return $this->min_val;
  92.     }
  93.  
  94.  
  95.     /**
  96.      * Returns maximum accepted value
  97.      *
  98.      * @return integer 
  99.      */
  100.     public function get_max_val() {
  101.         return $this->max_val;
  102.     }
  103.  
  104.  
  105.     /**
  106.      * Performs basic check for validity
  107.      *
  108.      * @return boolean 
  109.      * @internal
  110.      */
  111.     public function basic_check() {
  112.         $has_errors = parent::basic_check();
  113.  
  114.         if (!$has_errors) {
  115.             if ($this->get_html_value() < $this->get_min_val()) {
  116.                 $this->set_error('integer_smaller');
  117.                 $has_errors = true;
  118.             } else {
  119.                 if ($this->get_html_value() > $this->get_max_val()) {
  120.                     $this->set_error('integer_greater');
  121.                     $has_errors = true;
  122.                 }
  123.             }
  124.         }
  125.  
  126.         return $has_errors;
  127.     }
  128.  
  129.  
  130.     /**
  131.      * Returns array with field properties
  132.      *
  133.      * @return array 
  134.      * @internal
  135.      */
  136.     public function get_properties_array() {
  137.         $ret = parent::get_properties_array();
  138.         $ret['min_val'] = $this->get_min_val();
  139.         $ret['max_val'] = $this->get_max_val();
  140.  
  141.         return $ret;
  142.     }
  143.  
  144. }