* @package phpHtmlLib
*
* @copyright LGPL - See LICENCE
*
*/
/**
* make sure we include the parent class.
*/
require_once(PHPHTMLLIB_ABSPATH ."/XMLTagClass.inc" );
/**
* Base class for all HTML Tag classes.
* Tag class renders an html tag, its
* attributes, the content (if any),
* and close tag (if needed).
*
* @author Walter A. Boring IV
* @link http://phphtmllib.sourceforge.net
* @package phpHtmlLib
*/
class HTMLTagClass extends XMLTagClass {
/**
* the list of tag attributes that we
* should create a clickable link for
* when in debug mode.
*
* We comment this declaration out
* to save memory, since only a small
* number of tags use it
*
* @var array
* @access private
*/
//var $_debug_link_attributes = array("background");
/**
* The list of attributes not to render
* if $GLOBALS["HTML_RENDER_TYPE"] is "XHTML STRICT"
*
* We comment this declaration out
* to save memory, since only a small
* number of tags use it
*
*/
//var $_xhtml_strict_attributes = array();
/**
* The list of attributes that we want to run
* htmlentities() on if we are in XHTML_STRICT
* mode. Otherwise the validator complains about
* html characters such as &.
*
* We comment this declaration out
* to save memory, since only a small
* number of tags use it
*
* @var array.
* @access private
*/
//var $_htmlentities_attributes = array();
/**
* Class Constructor
*
* {@source }
*
* @param array - Associative array of
* name="value" pairs of
* tag atributes.
* ie array("border"=>0, "class"=>"hover");
*
* @param mixed You can have any number
* of parameters that will
* be added to the content
* of the tag automatically.
*/
function HTMLTagClass( $attributes=NULL ) {
if ( $attributes ) {
$this->set_tag_attributes( $attributes );
}
//set the default tag options
$this->_set_flags();
//add the content if any.
$num_args = func_num_args();
for ($i = 1; $i < $num_args; $i++) {
$this->add(func_get_arg($i));
}
//what version of html is this tag going to
//be rendered as?
//this is a magic test. It assumes that
//someone has created the define for
//HTML_RENDER_TYPE
if ( $GLOBALS["HTML_RENDER_TYPE"] == XHTML ||
$GLOBALS["HTML_RENDER_TYPE"] == XHTML_STRICT ) {
$this->_flags |= _XHTMLCOMPLIANT;
}
//if the tag is depricated
//we raise an alert.
if ( $this->_flags & _DEPRICATED ) {
trigger_error(htmlspecialchars($this->_tag) . " has been depricated in HTML 4.0", E_USER_NOTICE);
}
}
/**
* Renders the tag, attributes, content and close tag.
*
* {@source }
*
* @param int $indent_level the indentation level for this tag.
* @param boolean output in html viewable mode
* @return string
*/
function render($indent_level=NULL, $output_debug=0) {
//try and guess the indentation flags
//based on the data
$this->_prepare_flags();
if ( $indent_level==NULL ) {
$indent_level = 0;
}
$html = $this->_render_tag($indent_level, $output_debug);
if ( $this->_flags & _CONTENTREQUIRED) {
$html .= $this->_render_content($indent_level, $output_debug);
}
if ( $this->_flags & _CLOSETAGREQUIRED ) {
$html .= $this->_render_close_tag($indent_level, $output_debug);
}
return $html;
}
//****************************************************************
// HTML specific routines
//****************************************************************
/**
* This function is a shorthand helper
* to setting the style attribute on a
* tag.
*
* {@source }
*
* @param string - the style value.
* @return none
*/
function set_style( $value ) {
$this->set_tag_attribute("style", $value);
}
/**
* This function is a shorthand helper
* to setting the class attribute on a
* tag.
*
* {@source }
*
* @param string - the class value.
* @return none
*/
function set_class( $value ) {
$this->set_tag_attribute("class", $value);
}
/**
* This function is a shorthand helper
* to setting the id attribute on a
* tag.
*
* {@source }
*
* @param string - the class value.
* @return none
*/
function set_id( $value ) {
$this->set_tag_attribute("id", $value);
}
//****************************************************************
// Tag rendering routines.
//****************************************************************
/**
* renders the open tag. is
*
* {@source }
* @access private
*
* @param int the indentation level for this tag.
* @return string
*/
function _render_tag($indent_level, $output_debug=0) {
if ( $output_debug ) {
//lets call the special render tag debug function
return $this->_render_tag_debug( $indent_level );
} else {
return parent::_render_open_tag($indent_level, $this->_flags & _XHTMLCOMPLIANT);
}
}
/**
* Renders all of the content.
* Content can be raw strings, or tag objects.
*
* {@source }
* @access private
*
* @param int the indentation level for this tag.
* @return string
*/
function _render_content($indent_level, $output_debug=0) {
if ( $output_debug ) {
return $this->_render_content_debug( $indent_level );
} else {
return parent::_render_content( $indent_level, $output_debug);
}
}
/**
* Renders the close tag (if needed)
*
* {@source }
* @access private
*
* @param int the indentation level for this tag.
* @return string
*/
function _render_close_tag($indent_level, $output_debug=0) {
if ( $output_debug ) {
return $this->_render_close_tag_debug( $indent_level );
} else {
return parent::_render_close_tag($indent_level);
}
}
/**
* This renders that open tag in debug mode.
* We do this as a seperate function,
* so we can override this by the child
* tag, so it can add a link on content or
* one of the attributes.
*
* {@source }
* @access private
*
* @param int the indentation level
* @return string
*/
function _render_tag_debug($indent_level) {
$indent = $this->_render_indent($indent_level, TRUE);
$tag_prefix = htmlspecialchars( (@$this->_tag_prefix ? $this->_tag_prefix : _TAG_PREFIX));
$tab_postfix = htmlspecialchars( (@$this->_tag_postfix ? $this->_tag_postfix : _TAG_SUFFIX));
$str = $indent . $tag_prefix. "";
$str .= $this->_tag . "";
if ( ($this->_flags & _XHTMLCOMPLIANT) && !($this->_flags & _ALWAYS_UPPERCASE) ) {
//we have to have the tag name be lower case.
$str = strtolower( $str );
}
foreach( $this->_attributes as $name => $value) {
$str .= $this->_build_attribute_string($name, $value, TRUE);
}
//if we want to output xhtml compliant code, we have to
//render a special tag closing.
if ( $this->_flags & _XHTMLCOMPLIANT ) {
//we have to render a special close for the
//open tag, if the tag doesn't require a close
//tag or content.
if ( !($this->_flags & _CLOSETAGREQUIRED) && !($this->_flags & _NOFINISHSLASHXHTML) ) {
$html = $str . " />";
} else {
$html = $str.">";
}
} else {
$html = $str.">";
}
if ( $this->_flags & _NEWLINEAFTEROPENTAG ) {
$html .= " \n";
}
return $html;
}
/**
* This renders the content in debug mode.
* lets us wrap the content w/ a
* so it acts like view source.
*
* Content can be raw strings, or tag objects.
*
* {@source }
* @access private
*
* @param int the indentation level for this tag.
* @return string
*/
function _render_content_debug($indent_level) {
$html = '';
//walk through the content
for ($x=0; $x<=$this->_data_count; $x++) {
$item = &$this->_content[$x];
if (method_exists($item, "render")) {
if (($this->_flags & _COLLAPSE) && method_exists($item, "set_collapse")) {
$item->set_collapse(TRUE, FALSE);
}
if ($indent_level == INDENT_LEFT_JUSTIFY) {
$indent = INDENT_LEFT_JUSTIFY;
} else {
$indent = $indent_level + 1;
}
$html .= $item->render($indent, TRUE);
} else {
if ($this->_flags & _COLLAPSE) {
$html .= htmlspecialchars($item);
} else {
if ($indent_level == INDENT_LEFT_JUSTIFY) {
$indent = INDENT_LEFT_JUSTIFY;
} else {
$indent = $indent_level + 1;
}
$indent = $this->_render_indent($indent, TRUE);
if ( $this->_flags & _NEWLINEAFTEROPENTAG ) {
$item = htmlspecialchars($item);
$item = str_replace("\n", " \n" . $indent, $item);
$html .= $indent . "" .$item . " \n";
} else {
$item = htmlspecialchars($item);
$item = str_replace("\n", " \n" . $indent, $item);
$html .= $item;
}
}
}
}
return $html;
}
/**
* this renders the close tag in debugging mode.
*
* {@source }
* @access private
*
* @param int the indentation level for this tag.
* @return string
*/
function _render_close_tag_debug( $indent_level ) {
$indent ="";
if ( ($this->_flags & _INDENT) && ($this->_flags & _NEWLINEAFTEROPENTAG) ) {
$indent = $this->_render_indent($indent_level, TRUE);
}
$str = $indent . "</" . "";
$str .= $this->_tag . ">";
if ( $this->_flags & _XHTMLCOMPLIANT ) {
$str = strtolower( $str );
}
if ( $this->_flags & _NEWLINEAFTERCLOSETAG ) {
$str .= " \n";
}
return $str;
}
//****************************************************************
// Utility functions for attributes.
//****************************************************************
/**
* this builds an attribute for a tag.
* It also filters out any attributes
* that shouldn't be rendered if they
* are in the $this->_xhtml_strict_attributes
* array and HTML_RENDER_TYPE = XHTML STRICT
*
* {@source }
* @access private
*
* @param string - $name attribute name
* @param mixed - $value attribute value
* @return the tag attribute name=value pair.
* to be added to the tag.
*/
function _build_attribute_string($name, $value, $debug=0) {
if ( $debug ) {
//hack to make non name-value pair work.
//ie