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

Source for file Checkbox.php

Documentation is available at Checkbox.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: Checkbox.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 Checkbox class
  36.  *
  37.  * This class automates the creation and display of a checkbox.
  38.  *
  39.  * Example INI (defaults shown as comments):
  40.  * 
  41.  * <pre><samp>
  42.  * item.is_active.label  = Active
  43.  * item.is_active.type   = checkbox
  44.  * ;item.is_active.value = true
  45.  * </samp></pre>
  46.  *
  47.  * @category   Cnz
  48.  * @package    Cnz_Html
  49.  * @subpackage Form
  50.  */
  51. class Cnz_Html_Form_Checkbox extends Cnz_Html_Form_Item
  52. {
  53.     /**#@+ @var string */
  54.  
  55.     /** Value to use when checked. */
  56.     private    $value    = 'true';
  57.  
  58.     /**#@-*/
  59.  
  60.     /*====================================================================*/
  61.  
  62.     /**
  63.      * Option fields:
  64.      *   none
  65.      *
  66.      * Configuration fields:
  67.      *   value  Value when checked
  68.      *
  69.      * @param array       $options Options
  70.      * @param Zend_Config $config  Configuration
  71.      */
  72.     public function __construct(array $options = array(), Zend_Config $config = NULL)
  73.     {
  74.         parent::__construct($options, $config);
  75.         if (isset($config->value)) $this->value = $config->value;
  76.         return;
  77.     }
  78.  
  79.     /**
  80.      * @param  string $style Value for outermost style attribute
  81.      * @return void 
  82.      */
  83.     public function display($style = NULL)
  84.     {
  85.         $indent = Cnz_Html::indentGenerate();
  86.  
  87.         echo $indent, '<div class = "', $this->genStyles('label'), '">' . '&nbsp;' . '</div>', "\n";
  88.         echo $indent, '<div class = "', $this->genStyles('field'), '">';
  89.         echo '<input';
  90.         if (!empty($this->initial) && $this->initial == 'checked')
  91.         {
  92.             echo ' checked = "checked"';
  93.         }
  94.         echo ' id = "', $this->genId(), '" name = "', $this->name, '" type = "checkbox"';
  95.         if (!empty($this->value)) echo ' value = "', $this->value, '"';
  96.         echo '/>';
  97.         echo '<label for = "', $this->genId(), '">', $this->label, '</label>';
  98.         echo '</div>', "\n";
  99.  
  100.         return;
  101.     }
  102. }
Documentation generated on Thu, 19 Jul 2007 15:01:57 -0400 by phpDocumentor 1.4.0RC2