Item
[ class tree: Item ] [ index: Item ] [ all elements ]
Packages:
Formagic
Item
Renderer
Rule

Source for file Radio.php

Documentation is available at Radio.php

  1. <?php
  2. /**
  3.  * Formagic
  4.  *
  5.  * LICENCE
  6.  *
  7.  * This source file is subject to the new BSD license that is bundled
  8.  * with this package in the file LICENSE.txt.
  9.  * It is also available through the world-wide-web at
  10.  * http://formagic.weasle.de/licence.txt
  11.  * If you did not receive a copy of the license and are unable to
  12.  * obtain it through the world-wide-web, please send an email
  13.  * to licence@weasle.de so we can send you a copy immediately.
  14.  *
  15.  * @category    Formagic
  16.  * @package     Item
  17.  * @author      Florian Sonnenburg
  18.  * @copyright   Copyright (c) 2007 Florian Sonnenburg
  19.  * @license     http://formagic.weasle.de/licence.txt     New BSD License
  20.  * @revision    $Revision: 11 $
  21.  */
  22.  
  23. /**
  24.  * Input type radio for formagic formgenerator
  25.  *
  26.  * @category    Formagic
  27.  * @package     Item
  28.  * @author      Florian Sonnenburg
  29.  * @copyright   Copyright (c) 2007 Florian Sonnenburg
  30.  * @version     $Id: Radio.php 11 2007-08-12 20:02:57Z meweasle $
  31.  */
  32. class Formagic_Item_Radio extends Formagic_Item {
  33.  
  34.     /**
  35.      * Array containing select options
  36.      * @var     array 
  37.      * @access  private
  38.      */
  39.     private $data;
  40.  
  41.     /**
  42.      * String to separate radio elements from each other
  43.      * @var     string 
  44.      * @access  private
  45.      */
  46.     private $separator = "\n";
  47.  
  48.     /**
  49.      * Tells if an empty radio element should be added to list of elements
  50.      * @var     array 
  51.      * @access  private
  52.      */
  53.     private $emptyElement = null;
  54.  
  55.     /**
  56.      * Argument handler for arguments that are unknown to item parent class
  57.      *
  58.      * @param string $key Argument name
  59.      * @param mixed $arg Argument value
  60.      * @return boolean 
  61.      */
  62.     protected function _handleArg($key, $arg)
  63.     {
  64.         switch($key){
  65.             case 'separator':
  66.                 $this->separator = $arg;
  67.                 break;
  68.             case 'addEmptyFirst':
  69.                 $this->addEmpty($arg, 'first');
  70.                 break;
  71.             case 'addEmpty':
  72.             case 'addEmptyLast':
  73.                 $this->addEmpty($arg, 'last');
  74.                 break;
  75.             case 'data':
  76.                 $this->setData($arg);
  77.                 break;
  78.             default:
  79.                 throw new Exception("Argument type '$key' not supported");
  80.         } // switch
  81.         return true;
  82.     }
  83.  
  84.     /**
  85.      * Saves empty element
  86.      *
  87.      * @param mixed $element Label of empty element if string. If true, '---' is
  88.      *           label of empty element.
  89.      * @param mixed $pos Where to add empty element. Allowed values:
  90.      *           'first' or 'last'
  91.      * @return boolean 
  92.      */
  93.     public function addEmpty($element, $pos)
  94.     {
  95.         if (!$element) {
  96.             return false;
  97.         }
  98.         $element = is_bool($element) ? '---' : $element;
  99.         $this->emptyElement = array($element,$pos);
  100.         return true;
  101.     }
  102.  
  103.     /**
  104.      * Adds empty element to data array after constructor is processed
  105.      *
  106.      * @return boolean 
  107.      */
  108.     protected function _onCreate()
  109.     {
  110.         if ($this->emptyElement) {
  111.             $element = $this->emptyElement[0];
  112.             $pos = $this->emptyElement[1];
  113.             $this->data = $pos == 'last'
  114.                     ? $this->data + array(''=>$element)
  115.                     : array(''=>$element) + $this->data;
  116.         }
  117.         return true;
  118.     }
  119.  
  120.     /**
  121.      * Sets data for radio elements
  122.      *
  123.      * @param array $arr Associative array. Array-key will be value of radio
  124.      *           elements, array-value will be label.
  125.      * @return boolean 
  126.      */
  127.     public function setData($arr)
  128.     {
  129.         $this->data = $arr;
  130.         return true;
  131.     }
  132.  
  133.     /**
  134.      * Sets separator string
  135.      *
  136.      * @param string $separator 
  137.      * @return string 
  138.      */
  139.     public function setSeparator($separator)
  140.     {
  141.         return $this->separator = $separator;
  142.     }
  143.  
  144.     /**
  145.      * Returns string with HTML representation of radio elements
  146.      *
  147.      * @return string 
  148.      */
  149.     public function getHtml()
  150.     {
  151.         // HTML blocked
  152.         $currVal = $this->getValue();
  153.         if ($this->_isBlocked) {
  154.             $str = "";
  155.             if ($this->isPostItem) {
  156.                 $str .= '<input type="hidden" name="' . $this->name .
  157.                         '" value="' . $currVal . '" />';
  158.             }
  159.             foreach($this->data as $key => $value) {
  160.                 $checkIndicator = $key == $currVal ? "(o)" : "(&nbsp;&nbsp;)";
  161.                 $str .= $checkIndicator . " " . $value . $this->separator;
  162.             }
  163.  
  164.         // HTML default
  165.         } else {
  166.             $str = "";
  167.             $attrStr = $this->_getAttributeStr();
  168.  
  169.             foreach($this->data as $key => $value) {
  170.                 $c = (string)$key == (string)$currVal ? ' checked="checked"' : '';
  171.                 $rName = $this->name . $key;
  172.                 $rId = $this->id . $key;
  173.  
  174.                 // id=\"" . $this->name . "\"
  175.                 $str .= "<input type=\"radio\" id=\"$rId\" name=\"{$this->name}\"" .
  176.                         " value=\"$key\"{$c}$attrStr /><label for=\"$rId\">$value" .
  177.                         "</label>{$this->separator}";
  178.             }
  179.         }
  180.         $str = rtrim($str, $this->separator);
  181.         return $str;
  182.     }
  183.  
Documentation generated on Thu, 23 Aug 2007 00:29:46 +0200 by phpDocumentor 1.4.0