File Source for Element.php

<?php
/**
* CNZ Framework
*
* A Framework for Creating and Using Complex Web Elements
*
* The purpose of this framework is to provide a library of high-level objects
* to facilitate common HTML coding tasks, such as menus, tables, and forms.
* The intent is to reduce repetitive HTML coding as much as possible, replacing
* it with a combination of configuration files and style sheets with
* standardized naming conventions.
*
* This framework is built on and requires the
* {@link http://framework.zend.com/ Zend Framework}.
*
* @category Cnz
* @package Cnz_Html
*
* @author Lyle Frost <lfrost@cnz.com>
* @copyright Copyright (c) 2006-2007 Citadel Network <{@link http://www.citadelnetwork.com/}>
* @filesource
* @license http://www.citadelnetwork.com/license/cnzframework New BSD License
* @version $Id: Element.php 27 2007-07-19 18:47:54Z lfrost $
*/
/**
* Required classes.
*
* @ignore
*/
Zend_Loader::loadClass('Zend_Config');
Zend_Loader::loadClass('Zend_Config_Ini');
/**
* HTML Element class
*
* This is an abstract base class for all high-level HTML display elements. Its
* primary function is to generate the configuration section names and style
* names in a standardized way.
*
* The configuration section name is generated as
*
* <pre>
* HtmlType[-name]
* </pre>
*
* where type is third field of class name and name is the element name passed
* to the constructor. For example, Cnz_Html_Form_Checkbox with a name of pay
* would yield HtmlFormPay.
*
* The style name is generated as
*
* <pre>
* type[Subtype][-name][-suffix]
* </pre>
*
* This design allows for a single default configuration section and/or style,
* with the ability to override the defaults for special elements.
*
* Some elements will have special style suffixes (e.g., hilighted table rows).
* For example, a highlighted table row with the custom name <kbd>team</kbd>
* would have the following returned by <kbd>genStyles()</kbd>.
*
* <pre>
* table table-team table-hilight table-team-hilight
* </pre>
*
* Subtypes are only used for situations where the same HTML tag has different
* structural roles in the same complex element. For example, a form will use
* a div block to format the label for a field as well as the field itself, but
* different styling will normally be desired for these. For example, a form
* label with the custom name pay would have the following returned by
* <kbd>genStyles()</kbd>.
*
* <pre>
* formLabel formLabel-pay
* </pre>
*
* This allows the definition of default styles with overrides for named tables
* and special cases. Remember that the order of the style names in the class
* attribute is irrelevant. The order in the style sheet is what matters. The
* more specific styles should occur below the more general styles.
*
* HTML id values can also be generated with <kbd>genId()</kbd>. This is
* generated as
*
* <pre>
* type[-name]
* </pre>
*
* @category Cnz
* @package Cnz_Html
*/
abstract class Cnz_Html_Element
{
const CONFIG_PREFIX = 'Html';
const STYLE_SEPARATOR = '-';
/**#@+ @var string */
private $baseStyleName = NULL;
/**#@-*/
/**#@+ @var boolean */
protected $customConfigFlag = false;
protected $customStyleFlag = false;
/**#@-*/
/**#@+ @var string */
protected $configFile = NULL;
protected $configSection = NULL;
protected $name = NULL;
/**#@-*/
/** @var Zend_Config */
protected $config = NULL;
/** @var Cnz_Element */
protected $master = NULL;
/* Getters/Setters ===================================================*/
/** @return string Name */
public function getName()
{
return $this->name;
}
/* Abstract Methods ==================================================*/
/**
* @param string $style Value for outermost style attribute
* @return void
*/
public abstract function display($style = NULL);
/* Methods ===========================================================*/
/**
* Option fields:
* string name Element name
* Cnz_Element master Master element
* string filename Configuration filename
* boolean config Has custom configuration
* boolean style Has custom style
*
* Configuration fields:
* none
*
* @param array $options Associative array of common options.
* @return void
*/
public function __construct(array &$options = array())
{
// Process options.
if (isset($options['name'])) $this->name = strtolower($options['name']);
if (isset($options['master'])) $this->master = $options['master'];
else $this->master = $options['master'] = $this;
if (isset($options['filename'])) $this->configFile = $_SERVER['DOCUMENT_ROOT'] . '/../cfg/' . $options['filename'];
if (!empty($this->name))
{
if (isset($options['config'])) $this->customConfigFlag = (boolean)$options['config'];
if (isset($options['style'])) $this->customStyleFlag = (boolean)$options['style'];
}
if (empty($this->configFile)) $this->configFile = Cnz_Html::getHtmlConfigFile();
// Generate the configuration section and style names.
$type = $this->extractBaseName();
$this->configSection = self::CONFIG_PREFIX . ucfirst($type);
if ($this->customConfigFlag)
{
$this->configSection .= '-' . $this->name;
}
$this->baseStyleName = $type;
// Load configuration.
if (defined(get_class($this) . '::HAS_CONFIG'))
{
$this->config = new Zend_Config_Ini($this->configFile, $this->configSection);
}
return;
}
/**
* Extracts the third field of the class name.
*
* @return string Third field of the class name.
*/
private function extractBaseName()
{
$type = get_class($this);
$subType = strstr($type, 'Html_');
if ($subType === false)
{
trigger_error("Invalid object name $type.", E_USER_ERROR
);
}
$subType = strtolower(substr($subType, 5));
$end = strpos($subType, '_');
if ($end > 0) $subType = substr($subType, 0, $end);
return $subType;
}
/**
* Generates the id attribute value.
*
* @param string $number
* @return string Value for use with HTML id attribute
*/
protected function genId($number = NULL)
{
$baseStyleName = $this->baseStyleName;
$s = $baseStyleName;
if (!empty($this->master) && $this !== $this->master)
{
$s .= self::STYLE_SEPARATOR . $this->master->getName();
}
if (!empty($this->name))
{
$s .= self::STYLE_SEPARATOR . $this->name;
}
if (!empty($number))
{
$s .= self::STYLE_SEPARATOR . $number;
}
return $s;
}
/**
* Generates the class attribute value.
*
* @param string $subtype Style name subtype
* @param string $suffix Style name suffix
* @return string List of styles for use with HTML class attribute
*/
protected function genStyles($subtype = NULL, $suffix = NULL)
{
$baseStyleName = $this->baseStyleName;
if (!empty($subtype))
{
$baseStyleName .= ucfirst(strtolower($subtype));
}
if ($this->customStyleFlag)
{
if (!empty($subtype))
{
$styleName = $this->baseStyleName . ucfirst(strtolower($subtype)) . self::STYLE_SEPARATOR . $this->master->getName();
}
else
{
$styleName = $this->baseStyleName . self::STYLE_SEPARATOR . $this->master->getName();
}
}
$s = $baseStyleName;
if (!empty($styleName)) $s .= ' ' . $styleName;
if (!empty($suffix))
{
$s .= ' ' . $baseStyleName . self::STYLE_SEPARATOR . $suffix;
if ($this->customStyleFlag) $s .= ' ' . $styleName . self::STYLE_SEPARATOR . $suffix;
}
return $s;
}
}

Source for file Element.php