* @author Kornel Lesiński
* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
* @version SVN: $Id: Defs.php 664 2009-07-10 23:10:34Z kornel $
* @link http://phptal.org/
*/
require_once 'PHPTAL/Namespace.php';
require_once 'PHPTAL/Namespace/Builtin.php';
require_once 'PHPTAL/Namespace/TAL.php';
require_once 'PHPTAL/Namespace/METAL.php';
require_once 'PHPTAL/Namespace/I18N.php';
require_once 'PHPTAL/Namespace/PHPTAL.php';
/**
* PHPTAL constants.
*
* This is a pseudo singleton class, a user may decide to provide
* his own singleton instance which will then be used by PHPTAL.
*
* This behaviour is mainly useful to remove builtin namespaces
* and provide custom ones.
*
* @package PHPTAL
* @subpackage Dom
* @author Laurent Bedubourg
*/
class PHPTAL_Dom_Defs
{
/**
* this is a singleton
*/
public static function getInstance()
{
if (!self::$_instance) {
self::$_instance = new PHPTAL_Dom_Defs();
}
return self::$_instance;
}
protected function __construct()
{
$this->registerNamespace(new PHPTAL_Namespace_TAL());
$this->registerNamespace(new PHPTAL_Namespace_METAL());
$this->registerNamespace(new PHPTAL_Namespace_I18N());
$this->registerNamespace(new PHPTAL_Namespace_PHPTAL());
}
/**
* true if it's empty in XHTML (e.g. ![]()
)
* it will assume elements with no namespace may be XHTML too.
*
* @param string $tagName local name of the tag
* @return bool
*/
public function isEmptyTagNS($namespace_uri, $local_name)
{
return ($namespace_uri === 'http://www.w3.org/1999/xhtml' || $namespace_uri === '')
&& in_array(strtolower($local_name), self::$XHTML_EMPTY_TAGS);
}
/**
* gives namespace URI for given registered (built-in) prefix
*/
public function prefixToNamespaceURI($prefix)
{
return isset($this->prefix_to_uri[$prefix]) ? $this->prefix_to_uri[$prefix] : false;
}
/**
* gives typical prefix for given (built-in) namespace
*/
public function namespaceURIToPrefix($uri)
{
return array_search($uri, $this->prefix_to_uri, true);
}
/**
* Returns true if the attribute is an xhtml boolean attribute.
*
* @param string $att local name
* @return bool
*/
public function isBooleanAttribute($att)
{
return in_array($att, self::$XHTML_BOOLEAN_ATTRIBUTES);
}
/**
* true if elements content is parsed as CDATA in text/html
* and also accepts /* * / as comments.
*/
public function isCDATAElementInHTML($namespace_uri, $local_name)
{
return ($local_name === 'script' || $local_name === 'style')
&& ($namespace_uri === 'http://www.w3.org/1999/xhtml' || $namespace_uri === '');
}
/**
* Returns true if the attribute is a valid phptal attribute
*
* Examples of valid attributes: tal:content, metal:use-slot
* Examples of invalid attributes: tal:unknown, metal:content
*
* @return bool
*/
public function isValidAttributeNS($namespace_uri, $local_name)
{
if (!$this->isHandledNamespace($namespace_uri)) return false;
$attrs = $this->namespaces_by_uri[$namespace_uri]->getAttributes();
return isset($attrs[$local_name]);
}
/**
* is URI registered (built-in) namespace
*/
public function isHandledNamespace($namespace_uri)
{
return isset($this->namespaces_by_uri[$namespace_uri]);
}
/**
* Returns true if the attribute is a phptal handled xml namespace
* declaration.
*
* Examples of handled xmlns: xmlns:tal, xmlns:metal
*
* @return bool
*/
public function isHandledXmlNs($qname, $value)
{
return substr(strtolower($qname), 0, 6) == 'xmlns:' && $this->isHandledNamespace($value);
}
/**
* return objects that holds information about given TAL attribute
*/
public function getNamespaceAttribute($namespace_uri, $local_name)
{
$attrs = $this->namespaces_by_uri[$namespace_uri]->getAttributes();
return $attrs[$local_name];
}
/**
* Register a PHPTAL_Namespace and its attribute into PHPTAL.
*/
public function registerNamespace(PHPTAL_Namespace $ns)
{
$prefix = strtolower($ns->getPrefix());
$this->namespaces_by_uri[$ns->getNamespaceURI()] = $ns;
$this->prefix_to_uri[$ns->getPrefix()] = $ns->getNamespaceURI();
foreach ($ns->getAttributes() as $name => $attribute) {
$key = $prefix.':'.strtolower($name);
$this->_dictionary[$key] = $attribute;
}
}
private static $_instance = null;
private $_dictionary = array();
private $namespaces_by_uri = array();
private $prefix_to_uri = array();
/**
* This array contains XHTML tags that must be echoed in a <tag/> form
* instead of the <tag></tag> form.
*
* In fact, some browsers does not support the later form so PHPTAL
* ensure these tags are correctly echoed.
*/
private static $XHTML_EMPTY_TAGS = array(
'area',
'base',
'basefont',
'br',
'col',
'frame',
'hr',
'img',
'input',
'isindex',
'link',
'meta',
'param',
);
/**
* This array contains XHTML boolean attributes, their value is self
* contained (ie: they are present or not).
*/
private static $XHTML_BOOLEAN_ATTRIBUTES = array(
'checked',
'compact',
'declare',
'defer',
'disabled',
'ismap',
'multiple',
'noresize',
'noshade',
'nowrap',
'readonly',
'selected',
);
}