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

Source for file form_field_select_multiple.class.php

Documentation is available at form_field_select_multiple.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/select/form_field_select.class.php');
  17. /**
  18.  *
  19.  */
  20. require_once(TANGRA_MAIN_DIR.'exceptions/te_select_multiple_option_not_exists.class.php');
  21. /**
  22.  *
  23.  */
  24. require_once(TANGRA_MAIN_DIR.'exceptions/te_select_multiple_value_not_an_array.class.php');
  25.  
  26.  
  27. /**
  28.  * Represents select field with multiple choice
  29.  *
  30.  * @package tangra_lib
  31.  * @subpackage form
  32.  */
  33. class Form_Field_Select_Multiple extends Form_Field_Select {
  34.     /**
  35.      * Enter description here...
  36.      *
  37.      * @param string $name Name of the field
  38.      * @param integer $value Array containing option values to be selected
  39.      * @param boolean $required Is field required. Default is false
  40.      */
  41.     function __construct($name, $value = NULL, $required = false) {
  42.         parent::__construct($name, $value, $required);
  43.     }
  44.  
  45.  
  46.     /**
  47.      * Sets which options are selected
  48.      *
  49.      * @param array $value  Array that contains values of options to be selected
  50.      * @throws TE_Select_Multiple_Value_Not_An_Array
  51.      */
  52.     public function set_value($value) {
  53.         if ($value != NULL) {
  54.             if (is_array($value)) {
  55.                 parent::set_value(array());
  56.                 $tmp_value = array();
  57.                 foreach($value as $v) {
  58.                     $this->select_option($v);
  59.                     array_push($tmp_value, $v);
  60.                 }
  61.                 parent::_set_value($tmp_value);
  62.             } else {
  63.                 throw new TE_Select_Multiple_Value_Not_An_Array();
  64.             }
  65.         } else {
  66.             $this->deselect_all_options();
  67.         }
  68.  
  69.     }
  70.  
  71.  
  72.     /**
  73.      * Marks option as selected
  74.      *
  75.      * @param integer $value Value of the option
  76.      * @throws TE_Select_Multiple_Option_Not_Exists
  77.      */
  78.     public function select_option($value) {
  79.         $ok = false;
  80.  
  81.         foreach($this->options as &$option) {
  82.             if ($option['value'] == $value) {
  83.                 $option['selected'] = true;
  84.                 $ok = true;
  85.                 break;
  86.             }
  87.         }
  88.  
  89.         if (!$ok) {
  90.             throw new TE_Select_Multiple_Option_Not_Exists('Value: '.$value);
  91.         }
  92.     }
  93.  
  94.  
  95.     /**
  96.      * Marks options as not selected
  97.      *
  98.      * @param unknown_type $value Value of the option
  99.      * @throws TE_Select_Multiple_Option_Not_Exists
  100.      */
  101.     public function deselect_option($value) {
  102.         $ok = false;
  103.  
  104.         foreach($this->options as &$option) {
  105.             if ($option['value'] == $value) {
  106.                 $option['selected'] = false;
  107.                 $ok = true;
  108.                 break;
  109.             }
  110.         }
  111.  
  112.         if (!$ok) {
  113.             throw new TE_Select_Multiple_Option_Not_Exists('Value: '.$value);
  114.         }
  115.     }
  116.  
  117.  
  118.     /**
  119.      * Captures submit
  120.      *
  121.      * @param unknown_type $form_name 
  122.      * @param unknown_type $submit_array 
  123.      * @internal
  124.      */
  125.     public function capture_submit($form_name, &$submit_array) {
  126.         if (array_key_exists($form_name.'_'.$this->get_name(), $submit_array)) {
  127.             $this->set_html_value($submit_array[$form_name.'_'.$this->get_name()]);
  128.         } else {
  129.             $this->set_html_value(array());
  130.         }
  131.     }
  132.  
  133.  
  134.     /**
  135.      * Performs basic check for validity
  136.      *
  137.      * @return boolean 
  138.      * @internal
  139.      */
  140.     public function basic_check() {
  141.         $has_errors = false;
  142.  
  143.         if ($this->get_required() && $this->get_html_value() == NULL) {
  144.             $has_errors = true;
  145.             $this->set_error('mandatory_missing');
  146.         } else {
  147.             $this->clear_errors();
  148.         }
  149.  
  150.         return $has_errors;
  151.     }
  152.  
  153.  
  154.     /**
  155.      * Transfers data from html_value to value
  156.      * @internal
  157.      */
  158.     public function translate_value_html2app() {
  159.         $tmp_value = array();
  160.  
  161.         $this->deselect_all_options();
  162.  
  163.         if (count($this->get_html_value())) {
  164.             foreach($this->get_html_value() as $html_value) {
  165.                 array_push($tmp_value, $this->options[$this->find_option_by_html_value($html_value)]['value']);
  166.     //            $this->select_option($this->options[$this->find_option_by_html_value($html_value)]['value']);
  167.             }
  168.         } else {
  169.             $tmp_value = array();
  170.         }
  171.  
  172.         $this->set_value($tmp_value);
  173.     }
  174.  
  175.  
  176.     /**
  177.      * Deselects all options
  178.      * @internal
  179.      *
  180.      */
  181.     private function deselect_all_options() {
  182.         foreach($this->options as $option) {
  183.             $this->deselect_option($option['value']);
  184.         }
  185.     }
  186.  
  187.  
  188.     /**
  189.      * Returns option value for option with html_value = <var>$html_value</var>
  190.      *
  191.      * @param integer $html_value 
  192.      * @return integer 
  193.      */
  194.     private function find_option_by_html_value($html_value) {
  195.         $ret = false;
  196.  
  197.         foreach($this->options as $key => $option ) {
  198.             if ($option['html_value'] == $html_value) {
  199.                 $ret = $key;
  200.                 break;
  201.             }
  202.         }
  203.  
  204.         if ($ret === false) {
  205.             throw new TE_Select_Multiple_Option_Not_Exists('html_value: '.$html_value);
  206.         }
  207.  
  208.         return $ret;
  209.     }
  210.  
  211. }