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

Source for file Template.php

Documentation is available at Template.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 Template
  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: Template.php 27 2007-07-19 18:47:54Z lfrost $
  25.  */
  26.  
  27. /**
  28.  * Required classes.
  29.  *
  30.  * @ignore
  31.  */
  32. Zend_Loader::loadClass('Zend_Config');
  33. Zend_Loader::loadClass('Zend_Config_Ini');
  34. Zend_Loader::loadClass('Cnz_Html_Element');
  35.  
  36. /**
  37.  * HTML Template class
  38.  *
  39.  * This is a template for creating new CNZ Framework classes.
  40.  *
  41.  * Example INI (defaults shown as comments):
  42.  *
  43.  * <pre><samp>
  44.  * [HtmlTemplate]
  45.  * foo     = "This is a template."
  46.  * fooFlag = on
  47.  * fooList = abc,def
  48.  * </samp></pre>
  49.  *
  50.  * @category   Cnz
  51.  * @package    Cnz_Html
  52.  * @subpackage Template
  53.  */
  54. class Cnz_Html_Template extends Cnz_Html_Element
  55. {
  56.     const    HAS_CONFIG    = true;
  57.  
  58.     /**#@+ @var array */
  59.     private $fooArray    = NULL;
  60.     /**#@-*/
  61.  
  62.     /**#@+ @var boolean */
  63.     private $fooFlag    = NULL;
  64.     /**#@-*/
  65.  
  66.     /**#@+ @var string */
  67.     private    $foo        = NULL;
  68.     /**#@-*/
  69.  
  70.     /* Getters/Setters ===================================================*/
  71.  
  72.     /** @return string Foo */
  73.     public function getFoo()
  74.     {
  75.         return $this->foo;
  76.     }
  77.  
  78.     /**
  79.      * @param string New foo
  80.      * @return void 
  81.      */
  82.     public function setFoo($foo)
  83.     {
  84.         $this->foo = $foo;
  85.         return;
  86.     }
  87.  
  88.     /* Methods ===========================================================*/
  89.  
  90.     /**
  91.      * Option fields:
  92.       *   foo
  93.      *
  94.      * Configuration fields:
  95.       *   foo
  96.       *   fooFlag
  97.       *   fooList
  98.      *
  99.      * @param  array $options Options
  100.      */
  101.     public function __construct(array $options = array())
  102.     {
  103.         parent::__construct($options);
  104.  
  105.         // Process options.
  106.         if (isset($options['foo'])) $this->foo = $options['foo'];
  107.         elseif (isset($this->config->foo)) $this->foo = $this->config->foo;
  108.  
  109.         // Process configuration.
  110.         if (isset($this->config->fooFlag)) $this->fooFlag = Cnz_Html::configFlag($this->config->fooFlag);
  111.         if (isset($this->config->fooList)) $this->fooArray = Cnz_Html::listToArray($this->config->fooList);
  112.  
  113.         return;
  114.     }
  115.  
  116.     /**
  117.      * @param  string $style Value for outermost style attribute
  118.      * @return void 
  119.      */
  120.     public function display($style = NULL)
  121.     {
  122.         $is = Cnz_Html::getIndentString();
  123.         $indent = Cnz_Html::indentGenerate();
  124.  
  125.         // REPLACE <div> WITH APPROPRIATE CONTAINER TAG
  126.         echo $indent, '<div class = "', $this->genStyles(), '"';
  127.         if (!empty($style)) echo ' style = "', $style, '"';
  128.         echo '>', "\n";
  129.         Cnz_Html::indentInc();
  130.         $indent = Cnz_Html::indentGenerate();
  131.  
  132.         // INSERT DISPLAY CODE HERE
  133.         echo '<p class = "', $this->genStyles(), '">', $foo, '</p>', "\n";
  134.  
  135.         Cnz_Html::indentDec();
  136.         $indent = Cnz_Html::indentGenerate();
  137.         echo $indent, '</div>', "\n";
  138.  
  139.         return;
  140.     }
  141. }
Documentation generated on Thu, 19 Jul 2007 15:02:17 -0400 by phpDocumentor 1.4.0RC2