Cnz_Html
[ class tree: Cnz_Html ] [ index: Cnz_Html ] [ all elements ]
Packages:
Cnz
Cnz_Html

Source for file Radio.php

Documentation is available at Radio.php

  1. <?php
  2. /**
  3.  * CNZ Framework
  4.  *
  5.  * A Framework for Creating and Using Complex Web Elements
  6.  *
  7.  * The purpose of this framework is to provide a library of high-level objects
  8.  * to facilitate common HTML coding tasks, such as menus, tables, and forms.
  9.  * The intent is to reduce repetitive HTML coding as much as possible, replacing
  10.  * it with a combination of configuration files and style sheets with
  11.  * standardized naming conventions.
  12.  *
  13.  * This framework is built on and requires the
  14.  * {@link http://framework.zend.com/ Zend Framework}.
  15.  *
  16.  * @category   Cnz
  17.  * @package    Cnz_Html
  18.  * @subpackage Form
  19.  *
  20.  * @author    Lyle Frost <lfrost@cnz.com>
  21.  * @copyright Copyright (c) 2006-2007 Citadel Network <{@link http://www.citadelnetwork.com/}>
  22.  * @filesource
  23.  * @license   http://www.citadelnetwork.com/license/cnzframework New BSD License
  24.  * @version   $Id: Radio.php 27 2007-07-19 18:47:54Z lfrost $
  25.  */
  26.  
  27. /**
  28.  * Required classes.
  29.  *
  30.  * @ignore
  31.  */
  32. Zend_Loader::loadClass('Cnz_Html_Form_Item');
  33.  
  34. /**
  35.  * HTML Form Radio class
  36.  *
  37.  * This class automates the creation and display of a radio button group.
  38.  *
  39.  * Example INI:
  40.  *
  41.  * <pre><samp>
  42.  * item.contact_method.label   = "Contact Method"
  43.  * item.contact_method.type    = radio
  44.  * item.contact_method.list    = "
  45.  *     phone:Call me,
  46.  *     email:Email me
  47.  * "
  48.  * item.contact_method.initial = phone
  49.  * </samp></pre>
  50.  *
  51.  * If only a single field is specified for a list item, that is used for both
  52.  * the label and the value for that item.
  53.  *
  54.  * To use images, specify three fields <kbd>value:altText:filepath</kbd>.  If the
  55.  * filepath is relative, it is taken to be relative to the local image directory.
  56.  *
  57.  * @category   Cnz
  58.  * @package    Cnz_Html
  59.  * @subpackage Form
  60.  */
  61. class Cnz_Html_Form_Radio extends Cnz_Html_Form_Item
  62. {
  63.     /**#@+ @var array */
  64.  
  65.     /** Associative array value => label */
  66.     private $itemArray      = NULL;
  67.  
  68.     /**#@-*/
  69.  
  70.     /**#@+ @var string */
  71.     private $br        = false;
  72.     /**#@-*/
  73.  
  74.     /* Methods ===========================================================*/
  75.  
  76.     /**
  77.      * Option fields:
  78.      *   none
  79.      *
  80.      * Configuration fields:
  81.      *   br    Flag to enable br tag between radio buttons
  82.      *   list  Button list
  83.      *
  84.      * @param  array       $options Options
  85.      * @param  Zend_Config $config  Configuration
  86.      */
  87.     public function __construct(array $options = array(), Zend_Config $config = NULL)
  88.     {
  89.         parent::__construct($options, $config);
  90.         if (isset($config->list)) $this->itemArray = Cnz_Html::listToArray($config->list);
  91.         if (isset($config->br)) $this->br = Cnz_Html::configFlag($config->br);
  92.         return;
  93.     }
  94.  
  95.     /**
  96.      * @param  string $style Value for outermost style attribute
  97.      * @return void 
  98.      */
  99.     public function display($style = NULL)
  100.     {
  101.         $is = Cnz_Html::getIndentString();
  102.         $indent = Cnz_Html::indentGenerate();
  103.  
  104.         echo $indent, '<div class = "', $this->genStyles('label'), '">';
  105.         if (!empty($this->label)) echo $this->label;
  106.         else echo '&nbsp;';
  107.         echo '</div>', "\n";
  108.  
  109.         $number = 1;
  110.         echo $indent, '<div class = "', $this->genStyles('field'), '">', "\n";
  111.         foreach ($this->itemArray as $value => $label)
  112.         {
  113.             $image = NULL;
  114.             if (is_array($label))
  115.             {
  116.                 $image = $label[1];
  117.                 $label = $label[0];
  118.             }
  119.             echo $indent, $is, '<input';
  120.             if (!empty($this->initial) && $this->initial == $value)
  121.             {
  122.                 echo ' checked = "checked"';
  123.             }
  124.             echo ' id = "', $this->genId($number), '" name = "', $this->name, '" type = "radio" value = "', $value, '"/>', "\n";
  125.             echo $indent, $is, '<label for = "', $this->genId($number), '">';
  126.             if (empty($image))
  127.             {
  128.                 echo $label;
  129.             }
  130.             else
  131.             {
  132.                 echo '<img alt = "[', $label, ']" class = "', $this->genStyles(), '" src = "';
  133.                 if (substr($src, 0, 1) != '/') echo 'image/';
  134.                 echo $image, '"/>';
  135.             }
  136.             echo '</label>';
  137.             if ($this->br) echo '<br/>';
  138.             echo "\n";
  139.             $number++;
  140.         }
  141.         echo $indent, '</div>', "\n";
  142.  
  143.         return;
  144.     }
  145. }
Documentation generated on Thu, 19 Jul 2007 15:02:14 -0400 by phpDocumentor 1.4.0RC2