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

Source for file form_field_radio_group.class.php

Documentation is available at form_field_radio_group.class.php

  1. <?php
  2. // *** Tangra (Application Framework and Tools for PHP)
  3. //  $Id$
  4. //
  5.  
  6. /**
  7.  * Contains class Form_Field_Radio_Group
  8.  *
  9.  * @package tangra_lib
  10.  * @subpackage form
  11.  */
  12.  
  13. /**
  14.  *
  15.  */
  16. require_once(TANGRA_MAIN_DIR.'form/fields/form_field.class.php');
  17. /**
  18.  *
  19.  */
  20. require_once(TANGRA_MAIN_DIR.'exceptions/te_radio_value_already_exists.class.php');
  21.  
  22.  
  23. /**
  24.  * Represents group of radio buttons
  25.  *
  26.  * @package tangra_lib
  27.  * @subpackage form
  28.  */
  29. class Form_Field_Radio_Group extends Form_Field {
  30.     /**
  31.      * Array that contains radio buttons
  32.      *
  33.      * @var array 
  34.      * @internal
  35.      */
  36.     private $radios = array();
  37.  
  38.  
  39.     /**
  40.      * Constructor
  41.      *
  42.      * @param string $name Name of the field
  43.      * @param integer $value Default value.
  44.      * @param boolean $required Is field required. Default is false
  45.      */
  46.     function __construct($name, $value = NULL, $required = false) {
  47.         parent::__construct($name, $value, $required);
  48.  
  49.         $this->add_potential_error('invalid_value');
  50.     }
  51.  
  52.  
  53.     /**
  54.      * Adds radio button
  55.      *
  56.      * @param integer $value Value of the radio button
  57.      * @throws  TE_Radio_Value_Already_Exists
  58.      */
  59.     public function add_radio($value) {
  60.         if ($this->is_unique_value($value)) {
  61.             if ($value == $this->get_value()) {
  62.                 $checked = true;
  63.             } else {
  64.                 $checked = false;
  65.             }
  66.  
  67.             $c = count($this->radios);
  68.             $this->radios[$c]['value'] = $value;
  69.             $this->radios[$c]['checked'] = $checked;
  70.             $this->radios[$c]['html_value'] = $c + 1;
  71.         } else {
  72.             throw new TE_Radio_Value_Already_Exists($value);
  73.         }
  74.     }
  75.  
  76.  
  77.     /**
  78.      * Sets all radios at once using array
  79.      *
  80.      * @param array $radios_arr 
  81.      */
  82.     public function set_radios($radios_arr) {
  83.         $this->radios = array();
  84.  
  85.         foreach($radios_arr as $key => $value) {
  86.             $this->add_radio($value);
  87.         }
  88.     }
  89.  
  90.  
  91.     /**
  92.      * Performs basic check for validity
  93.      *
  94.      * @return boolean 
  95.      * @internal
  96.      */
  97.     public function basic_check() {
  98.         $has_errors = parent::basic_check();
  99.         $ok = false;
  100.         if (!$has_errors) {
  101.             if ($this->get_required()) {
  102.                 $ok = $this->is_value_valid($this->get_html_value());
  103.                 if (!$ok) {
  104.                     $this->set_error('invalid_value');
  105.                     $has_errors = true;
  106.                 }
  107.             } else {
  108.                 if ($this->get_html_value() != NULL) {
  109.                     $ok = $this->is_value_valid($this->get_html_value());
  110.                     if (!$ok) {
  111.                         $this->set_error('invalid_value');
  112.                         $has_errors = true;
  113.                     }
  114.                 }
  115.             }
  116.         }
  117.  
  118.         return $has_errors;
  119.     }
  120.  
  121.  
  122.     /**
  123.      * Checks if there is radio button with that value
  124.      *
  125.      * @param integer $value 
  126.      * @return unknown 
  127.      */
  128.     private function is_value_valid($value) {
  129.         $ret = false;
  130.  
  131.         foreach($this->radios as $radio) {
  132.             if ($radio['html_value'] == $value) {
  133.                 $ret = true;
  134.                 break;
  135.             }
  136.         }
  137.  
  138.         return $ret;
  139.     }
  140.  
  141.  
  142.     /**
  143.      * Sets value
  144.      *
  145.      * @param integer $value 
  146.      */
  147.     public function set_value($value) {
  148.         parent::set_value($value);
  149.         $this->set_radio_checked($value);
  150.     }
  151.  
  152.  
  153.     /**
  154.      * Returns array with field properties
  155.      *
  156.      * @return array 
  157.      * @internal
  158.      */
  159.     public function get_properties_array() {
  160.         $ret = parent::get_properties_array();
  161.         $ret['radios'] = $this->radios;
  162.         $ret['missing'] = true;
  163.  
  164.         return $ret;
  165.     }
  166.  
  167.  
  168.     /**
  169.      * Returns all radios as array
  170.      *
  171.      * @return array 
  172.      */
  173.     public function get_radios() {
  174.         return $this->radios;
  175.     }
  176.  
  177.  
  178.     /**
  179.      * Checks if there is a radio with same value
  180.      *
  181.      * @param integer $value 
  182.      * @return boolean 
  183.      * @internal
  184.      */
  185.     private function is_unique_value($value) {
  186.         $ret = true;
  187.  
  188.         foreach($this->radios as $radio) {
  189.             if ($value == $radio['value']) {
  190.                 $ret = false;
  191.                 break;
  192.             }
  193.         }
  194.  
  195.         return $ret;
  196.     }
  197.  
  198.  
  199.     /**
  200.      * Marks radio as checked
  201.      *
  202.      * @param integer $value Value of radio that will be marked as checked
  203.      */
  204.     private function set_radio_checked($value) {
  205.         foreach($this->radios as &$radio) {
  206.             if ($radio['value'] != $value) {
  207.                 $radio['checked'] = false;
  208.             } else {
  209.                 $radio['checked'] = true;
  210.             }
  211.         }
  212.     }
  213.  
  214.  
  215.     /**
  216.      * Transfers data from html_value to value
  217.      * @internal
  218.      */
  219.     protected function translate_value_html2app() {
  220.         foreach($this->radios as $radio) {
  221.             if ($radio['html_value'] == $this->get_html_value()) {
  222.                 $this->set_value($radio['value']);
  223.                 break;
  224.             }
  225.         }
  226.     }
  227. }