Viewing file:  Common.php (12.79 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP Version 4 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.net/license/2_02.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.net so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Author: Adam Daniel <adaniel1@eesus.jnj.com> |
// +----------------------------------------------------------------------+
//
// $Id: Common.php,v 1.13 2006/10/08 14:10:46 avb Exp $
/**
* Base class for all HTML classes
*
* @author Adam Daniel <adaniel1@eesus.jnj.com>
* @category HTML
* @package HTML_Common
* @version 1.2.3
* @abstract
*/
/**
* Base class for all HTML classes
*
* @author Adam Daniel <adaniel1@eesus.jnj.com>
* @version 1.7
* @since PHP 4.0.3pl1
* @abstract
*/
class HTML_Common {
/**
* Associative array of table attributes
* @var array
* @access private
*/
var $_attributes = array();
/**
* Tab offset of the table
* @var int
* @access private
*/
var $_tabOffset = 0;
/**
* Tab string
* @var string
* @since 1.7
* @access private
*/
var $_tab = "\11";
/**
* Contains the line end string
* @var string
* @since 1.7
* @access private
*/
var $_lineEnd = "\12";
/**
* HTML comment on the object
* @var string
* @since 1.5
* @access private
*/
var $_comment = '';
/**
* Class constructor
* @param mixed $attributes Associative array of table tag attributes
* or HTML attributes name="value" pairs
* @param int $tabOffset Indent offset in tabs
* @access public
*/
function HTML_Common($attributes = null, $tabOffset = 0)
{
$this->setAttributes($attributes);
$this->setTabOffset($tabOffset);
} // end constructor
/**
* Returns the current API version
* @access public
* @returns double
*/
function apiVersion()
{
return 1.7;
} // end func apiVersion
/**
* Returns the lineEnd
*
* @since 1.7
* @access private
* @return string
*/
function _getLineEnd()
{
return $this->_lineEnd;
} // end func getLineEnd
/**
* Returns a string containing the unit for indenting HTML
*
* @since 1.7
* @access private
* @return string
*/
function _getTab()
{
return $this->_tab;
} // end func _getTab
/**
* Returns a string containing the offset for the whole HTML code
*
* @return string
* @access private
*/
function _getTabs()
{
return str_repeat($this->_getTab(), $this->_tabOffset);
} // end func _getTabs
/**
* Returns an HTML formatted attribute string
* @param array $attributes
* @return string
* @access private
*/
function _getAttrString($attributes)
{
$strAttr = '';
if (is_array($attributes)) {
$charset = HTML_Common::charset();
foreach ($attributes as $key => $value) {
$strAttr .= ' ' . $key . '="' . htmlspecialchars($value, ENT_COMPAT, $charset) . '"';
}
}
return $strAttr;
} // end func _getAttrString
/**
* Returns a valid atrributes array from either a string or array
* @param mixed $attributes Either a typical HTML attribute string or an associative array
* @access private
* @return array
*/
function _parseAttributes($attributes)
{
if (is_array($attributes)) {
$ret = array();
foreach ($attributes as $key => $value) {
if (is_int($key)) {
$key = $value = strtolower($value);
} else {
$key = strtolower($key);
}
$ret[$key] = $value;
}
return $ret;
} elseif (is_string($attributes)) {
$preg = "/(([A-Za-z_:]|[^\\x00-\\x7F])([A-Za-z0-9_:.-]|[^\\x00-\\x7F])*)" .
"([ \\n\\t\\r]+)?(=([ \\n\\t\\r]+)?(\"[^\"]*\"|'[^']*'|[^ \\n\\t\\r]*))?/";
if (preg_match_all($preg, $attributes, $regs)) {
for ($counter=0; $counter<count($regs[1]); $counter++) {
$name = $regs[1][$counter];
$check = $regs[0][$counter];
$value = $regs[7][$counter];
if (trim($name) == trim($check)) {
$arrAttr[strtolower(trim($name))] = strtolower(trim($name));
} else {
if (substr($value, 0, 1) == "\"" || substr($value, 0, 1) == "'") {
$value = substr($value, 1, -1);
}
$arrAttr[strtolower(trim($name))] = trim($value);
}
}
return $arrAttr;
}
}
} // end func _parseAttributes
/**
* Returns the array key for the given non-name-value pair attribute
*
* @param string $attr Attribute
* @param array $attributes Array of attribute
* @since 1.0
* @access private
* @return bool
*/
function _getAttrKey($attr, $attributes)
{
if (isset($attributes[strtolower($attr)])) {
return true;
} else {
return null;
}
} //end func _getAttrKey
/**
* Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes
* @param array $attr1 Original attributes array
* @param array $attr2 New attributes array
* @access private
*/
function _updateAttrArray(&$attr1, $attr2)
{
if (!is_array($attr2)) {
return false;
}
foreach ($attr2 as $key => $value) {
$attr1[$key] = $value;
}
} // end func _updateAtrrArray
/**
* Removes the given attribute from the given array
*
* @param string $attr Attribute name
* @param array $attributes Attribute array
* @since 1.4
* @access private
* @return void
*/
function _removeAttr($attr, &$attributes)
{
$attr = strtolower($attr);
if (isset($attributes[$attr])) {
unset($attributes[$attr]);
}
} //end func _removeAttr
/**
* Returns the value of the given attribute
*
* @param string $attr Attribute name
* @since 1.5
* @access public
* @return string|null returns null if an attribute does not exist
*/
function getAttribute($attr)
{
$attr = strtolower($attr);
if (isset($this->_attributes[$attr])) {
return $this->_attributes[$attr];
}
return null;
} //end func getAttribute
/**
* Sets the value of the attribute
*
* @param string Attribute name
* @param string Attribute value (will be set to $name if omitted)
* @access public
*/
function setAttribute($name, $value = null)
{
$name = strtolower($name);
if (is_null($value)) {
$value = $name;
}
$this->_attributes[$name] = $value;
} // end func setAttribute
/**
* Sets the HTML attributes
* @param mixed $attributes Either a typical HTML attribute string or an associative array
* @access public
*/
function setAttributes($attributes)
{
$this->_attributes = $this->_parseAttributes($attributes);
} // end func setAttributes
/**
* Returns the assoc array (default) or string of attributes
*
* @param bool Whether to return the attributes as string
* @since 1.6
* @access public
* @return mixed attributes
*/
function getAttributes($asString = false)
{
if ($asString) {
return $this->_getAttrString($this->_attributes);
} else {
return $this->_attributes;
}
} //end func getAttributes
/**
* Updates the passed attributes without changing the other existing attributes
* @param mixed $attributes Either a typical HTML attribute string or an associative array
* @access public
*/
function updateAttributes($attributes)
{
$this->_updateAttrArray($this->_attributes, $this->_parseAttributes($attributes));
} // end func updateAttributes
/**
* Removes an attribute
*
* @param string $attr Attribute name
* @since 1.4
* @access public
* @return void
*/
function removeAttribute($attr)
{
$this->_removeAttr($attr, $this->_attributes);
} //end func removeAttribute
/**
* Sets the line end style to Windows, Mac, Unix or a custom string.
*
* @param string $style "win", "mac", "unix" or custom string.
* @since 1.7
* @access public
* @return void
*/
function setLineEnd($style)
{
switch ($style) {
case 'win':
$this->_lineEnd = "\15\12";
break;
case 'unix':
$this->_lineEnd = "\12";
break;
case 'mac':
$this->_lineEnd = "\15";
break;
default:
$this->_lineEnd = $style;
}
} // end func setLineEnd
/**
* Sets the tab offset
*
* @param int $offset
* @access public
*/
function setTabOffset($offset)
{
$this->_tabOffset = $offset;
} // end func setTabOffset
/**
* Returns the tabOffset
*
* @since 1.5
* @access public
* @return int
*/
function getTabOffset()
{
return $this->_tabOffset;
} //end func getTabOffset
/**
* Sets the string used to indent HTML
*
* @since 1.7
* @param string $string String used to indent ("\11", "\t", ' ', etc.).
* @access public
* @return void
*/
function setTab($string)
{
$this->_tab = $string;
} // end func setTab
/**
* Sets the HTML comment to be displayed at the beginning of the HTML string
*
* @param string
* @since 1.4
* @access public
* @return void
*/
function setComment($comment)
{
$this->_comment = $comment;
} // end func setHtmlComment
/**
* Returns the HTML comment
*
* @since 1.5
* @access public
* @return string
*/
function getComment()
{
return $this->_comment;
} //end func getComment
/**
* Abstract method. Must be extended to return the objects HTML
*
* @access public
* @return string
* @abstract
*/
function toHtml()
{
return '';
} // end func toHtml
/**
* Displays the HTML to the screen
*
* @access public
*/
function display()
{
print $this->toHtml();
} // end func display
/**
* Sets the charset to use by htmlspecialchars() function
*
* Since this parameter is expected to be global, the function is designed
* to be called statically:
* <code>
* HTML_Common::charset('utf-8');
* </code>
* or
* <code>
* $charset = HTML_Common::charset();
* </code>
*
* @param string New charset to use. Omit if just getting the
* current value. Consult the htmlspecialchars() docs
* for a list of supported character sets.
* @return string Current charset
* @access public
* @static
*/
function charset($newCharset = null)
{
static $charset = 'ISO-8859-1';
if (!is_null($newCharset)) {
$charset = $newCharset;
}
return $charset;
} // end func charset
} // end class HTML_Common
?>
|