Source for file TElement.php

Documentation is available at TElement.php

<?php
namespace Adianti\Widget\Base;
/**
* Base class for all HTML Elements
*
* @version 7.4
* @package widget
* @subpackage base
* @author Pablo Dall'Oglio
* @copyright Copyright (c) 2006 Adianti Solutions Ltd. (http://www.adianti.com.br)
* @license http://www.adianti.com.br/framework-license
*/
class TElement
{
private $tagname; // tag name
private $properties; // tag properties
private $wrapped;
private $useLineBreaks;
private $useSingleQuotes;
private $afterElement;
protected $children;
private static $voidelements;
private $hidden;
/**
* Class Constructor
* @param $tagname tag name
*/
public function __construct($tagname)
{
// define the element name
$this->tagname = $tagname;
$this->useLineBreaks = TRUE;
$this->useSingleQuotes = FALSE;
$this->wrapped = FALSE;
$this->hidden = FALSE;
$this->properties = [];
if (empty(self::$voidelements))
{
self::$voidelements = array('area', 'base', 'br', 'col', 'command', 'embed', 'hr',
'img', 'input', 'keygen', 'link', 'meta', 'param', 'source', 'track', 'wbr');
}
}
/**
* Create an element
* @param $tagname Element name
* @param $value Element value
* @param $attributes Element attributes
*/
public static function tag($tagname, $value, $attributes = NULL)
{
$object = new TElement($tagname);
if (is_array($value))
{
foreach ($value as $element)
{
$object->add($element);
}
}
else
{
$object->add($value);
}
if ($attributes)
{
foreach ($attributes as $att_name => $att_value)
{
$object->$att_name = $att_value;
}
}
return $object;
}
/**
* hide object
*/
public function hide()
{
$this->hidden = true;
}
/**
* Insert element after
*/
public function after($element)
{
$this->afterElement = $element;
}
/**
* Return the after element
*/
public function getAfterElement()
{
return $this->afterElement;
}
/**
* Change the element name
* @param $tagname Element name
*/
public function setName($tagname)
{
$this->tagname = $tagname;
}
/**
* Returns tag name
*/
public function getName()
{
return $this->tagname;
}
/**
* Define if the element is wrapped inside another one
* @param @bool Boolean TRUE if is wrapped
*/
protected function setIsWrapped($bool)
{
$this->wrapped = $bool;
}
/**
* Return if the element is wrapped inside another one
*/
public function getIsWrapped()
{
return $this->wrapped;
}
/**
* Set tag property
* @param $name Property Name
* @param $value Property Value
*/
public function setProperty($name, $value)
{
// objects and arrays are not set as properties
if (is_scalar($value))
{
// store the property's value
$this->properties[$name] = $value;
}
}
/**
* Set element properties
*/
public function setProperties($properties)
{
foreach ($properties as $property => $value)
{
if (is_null($value))
{
unset($this->properties[$property]);
}
else
{
$this->properties[$property] = $value;
}
}
}
/**
* Return a property
* @param $name property name
*/
public function getProperty($name)
{
return isset($this->properties[$name]) ? $this->properties[$name] : null;
}
/**
* Return element properties
*/
public function getProperties()
{
return $this->properties;
}
/**
* Intercepts whenever someones assign a new property's value
* @param $name Property Name
* @param $value Property Value
*/
public function __set($name, $value)
{
// objects and arrays are not set as properties
if (is_scalar($value))
{
// store the property's value
$this->properties[$name] = $value;
}
}
/**
* Intercepts whenever someones unset a property's value
* @param $name Property Name
*/
public function __unset($name)
{
unset($this->properties[$name]);
}
/**
* Returns a property's value
* @param $name Property Name
*/
public function __get($name)
{
if (isset($this->properties[$name]))
{
return $this->properties[$name];
}
}
/**
* Returns is a property's is set
* @param $name Property Name
*/
public function __isset($name)
{
return isset($this->properties[$name]);
}
/**
* Clone the object
*/
public function __clone()
{
// verify if the tag has child elements
if ($this->children)
{
// iterate all child elements
foreach ($this->children as $key => $child)
{
if (is_object($child))
{
$this->children[$key] = clone $child;
}
else
{
$this->children[$key] = $child;
}
}
}
}
/**
* Add an child element
* @param $child Any object that implements the show() method
*/
public function add($child)
{
$this->children[] = $child;
if ($child instanceof TElement)
{
$child->setIsWrapped( TRUE );
}
}
/**
* Insert an child element
* @param $position Element position
* @param $child Any object that implements the show() method
*/
public function insert($position, $child)
{
array_splice( $this->children, $position, 0, array($child) );
if ($child instanceof TElement)
{
$child->setIsWrapped( TRUE );
}
}
/**
* Set the use of linebreaks
* @param $linebreaks boolean
*/
public function setUseLineBreaks($linebreaks)
{
$this->useLineBreaks = $linebreaks;
}
/**
* Set the use of single quotes
* @param $singlequotes boolean
*/
public function setUseSingleQuotes($singlequotes)
{
$this->useSingleQuotes = $singlequotes;
}
/**
* Del an child element
* @param $child Any object that implements the show() method
*/
public function del($object)
{
foreach ($this->children as $key => $child)
{
if ($child === $object) // same instance
{
unset($this->children[$key]);
}
}
}
/**
* get children
*/
public function getChildren()
{
return $this->children;
}
/**
* Find child element
* @param $element tag name
* @param $properties match properties
*/
public function find($element, $properties = null)
{
if ($this->children)
{
foreach ($this->children as $child)
{
if ($child instanceof TElement)
{
if ($child->getName() == $element)
{
$match = true;
if ($properties)
{
foreach ($properties as $key => $value)
{
if ($child->getProperty($key) !== $value)
{
$match = false;
}
}
}
if ($match)
{
return array_merge([$child], $child->find($element, $properties));
}
}
return $child->find($element, $properties);
}
}
}
return [];
}
/**
* Get an child element
* @param $position Element position
*/
public function get($position)
{
return $this->children[$position];
}
/**
* Opens the tag
*/
public function openTag()
{
// exibe a tag de abertura
echo "<{$this->tagname}";
if ($this->properties)
{
// percorre as propriedades
foreach ($this->properties as $name=>$value)
{
if ($this->useSingleQuotes)
{
$value = str_replace("'", ''', $value);
echo " {$name}='{$value}'";
}
else
{
$value = str_replace('"', '"', $value);
echo " {$name}=\"{$value}\"";
}
}
}
if (in_array($this->tagname, self::$voidelements))
{
echo '/>';
}
else
{
echo '>';
}
}
/**
* BC only
*/
public function open()
{
$this->openTag();
}
/**
* Shows the tag
*/
public function show()
{
if ($this->hidden)
{
return;
}
// open the tag
$this->openTag();
// verify if the tag has child elements
if ($this->children)
{
if (count($this->children)>1)
{
if ($this->useLineBreaks)
{
echo "\n";
}
}
// iterate all child elements
foreach ($this->children as $child)
{
if ($child instanceof self)
{
$child->setUseLineBreaks($this->useLineBreaks);
}
// verify if the child is an object
if (is_object($child))
{
$child->show();
}
// otherwise, the child is a scalar
else if ((is_string($child)) or (is_numeric($child)))
{
echo $child;
}
}
}
if (!in_array($this->tagname, self::$voidelements))
{
// closes the tag
$this->closeTag();
}
if (!empty($this->afterElement))
{
$this->afterElement->show();
}
}
/**
* Closes the tag
*/
public function closeTag()
{
echo "</{$this->tagname}>";
if ($this->useLineBreaks)
{
echo "\n";
}
}
/**
* BC only
*/
public function close()
{
$this->closeTag();
}
/**
* Converts the object into a string
*/
public function __toString()
{
return $this->getContents();
}
/**
* Returns the element content as a string
*/
public function getContents()
{
ob_start();
$this->show();
$content = ob_get_contents();
ob_end_clean();
return $content;
}
/**
* Clear element children
*/
public function clearChildren()
{
$this->children = array();
}

Adianti Solutions

API

Source for file TElement.php