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

Source for file form_field_number_nls.class.php

Documentation is available at form_field_number_nls.class.php

  1. <?php
  2. // *** Tangra (Application Framework and Tools for PHP)
  3. //  $Id$
  4. //
  5.  
  6.  
  7.  
  8. /**
  9.  * Contains class Form_Field_Number_NLS
  10.  *
  11.  * @package tangra_lib
  12.  * @subpackage form
  13.  */
  14.  
  15. /**
  16.  *
  17.  */
  18. require_once(TANGRA_MAIN_DIR.'form/fields/text/form_field_text.class.php');
  19. /**
  20.  *
  21.  */
  22. require_once(TANGRA_MAIN_DIR.'nls/number_functions.inc.php');
  23.  
  24.  
  25. /**
  26.  * Represents text field that accepts number formated according some NLS specifics
  27.  *
  28.  * @package tangra_lib
  29.  * @subpackage form
  30.  */
  31. class Form_Field_Number_NLS extends Form_Field_Text {
  32.     /**
  33.      * Separator for thousands
  34.      *
  35.      * @var string 
  36.      * @internal
  37.      */
  38.     private $thousands_separator;
  39.     /**
  40.      * Decimal separator
  41.      *
  42.      * @var string 
  43.      * @internal
  44.      */
  45.     private $floating_separator;
  46.  
  47.  
  48.     /**
  49.      * Constructor
  50.      *
  51.      * @param string $name Name of the field
  52.      * @param boolean $required Is field required. Default is false
  53.      * @param integer $maxlength Maximum length of the text. Default is 100
  54.      * @param string $value Default value.
  55.      * @param string $thousands_separator Separator for thousands
  56.      * @param string $floating_separator Decimal separator
  57.      */
  58.     function __construct($name, $required = false, $maxlength = 100, $value = NULL, $thousands_separator = ' ', $floating_separator = '.') {
  59.         parent::__construct($name, $required, $maxlength, $value);
  60.  
  61.         $this->set_separators($thousands_separator, $floating_separator);
  62.  
  63.         $this->add_potential_error('not_a_number');
  64.     }
  65.  
  66.  
  67.     /**
  68.      * Sets separators
  69.      *
  70.      * @param string $thousands_separator Thousands separator
  71.      * @param string $floating_separator Decimal separator
  72.      */
  73.     public function set_separators($thousands_separator, $floating_separator) {
  74.         if ($thousands_separator == $floating_separator) {
  75.             throw new Tangra_Exception('Thousands separator and Floating separator can not be the same = '. $thousands_separator);
  76.         }
  77.  
  78.         if ($thousands_separator != ',' && $thousands_separator != ' ' && $thousands_separator != '.' && $thousands_separator != '') {
  79.             throw new Tangra_Exception('Invalid thousands separator = "'.$thousands_separator.'". Must be "," (comma) or " "(space) or empty.');
  80.         }
  81.  
  82.         $this->thousands_separator = $thousands_separator;
  83.  
  84.         if ($floating_separator != '.' && $floating_separator != ",") {
  85.             throw new Tangra_Exception('Invalid floating separator = "'.$floating_separator.'". Must be "."(dot) or ","(comma)');
  86.         }
  87.  
  88.         $this->floating_separator = $floating_separator;
  89.  
  90.     }
  91.  
  92.     /**
  93.      * Returns thousands separator
  94.      *
  95.      * @return string 
  96.      */
  97.     public function get_thousands_separator() {
  98.         return $this->thousands_separator;
  99.     }
  100.  
  101.  
  102.     /**
  103.      * Returns decimal separator
  104.      *
  105.      * @return unknown 
  106.      */
  107.     public function get_floating_separator() {
  108.         return $this->floating_separator;
  109.     }
  110.  
  111.  
  112.     /**
  113.      * Alias of get_floating_separator
  114.      *
  115.      * @return unknown 
  116.      */
  117.     public function get_decimal_separator() {
  118.         return $this->get_floating_separator();
  119.     }
  120.  
  121.  
  122.     /**
  123.      * Performs basic check for validity
  124.      *
  125.      * @return boolean 
  126.      * @internal
  127.      */
  128.     public function basic_check() {
  129.         $has_errors = parent::basic_check();
  130.  
  131.         if (!$has_errors) {
  132.             if ($this->get_html_value() != NULL and $this->get_html_value() != '') {
  133. //printbr($this->convert_number($this->get_html_value()));
  134.                 if (!(convert_number_from_nls_format($this->get_html_value(), $this->get_floating_separator(), $this->get_thousands_separator()) !== false)) {
  135.                     $this->set_error('not_a_number');
  136.                     $has_errors = true;
  137.                 }
  138.             }
  139.         }
  140.  
  141.         return $has_errors;
  142.     }
  143.  
  144.  
  145.     /**
  146.      * Transfers data from html_value to value
  147.      * @internal
  148.      */
  149.     protected function translate_value_html2app() {
  150.         $this->set_value(convert_number_from_nls_format($this->get_html_value(), $this->get_floating_separator(), $this->get_thousands_separator()));
  151.     }
  152. }