Markup/Renderer/Html.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Markup  
Subpackage
Renderer  
Version
$Id: Html.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Markup_Renderer_Html

Package: Zend\Markup\Renderer
HTML renderer
Parent(s)
\Zend_Markup_Renderer_RendererAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Properties

>VPropertyprotectedarray $_defaultAttributes = array('id' => '', 'class' => '', 'style' => '', 'lang' => '', 'title' => '')
static
Default attributes
Default valuearray('id' => '', 'class' => '', 'style' => '', 'lang' => '', 'title' => '')Details
Type
array
>VPropertyprotected\Zend_Filter $_defaultFilter
>VPropertyprotectedstring $_encoding = 'UTF-8'
staticinherited
Encoding
Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_encoding
Default value'UTF-8'Details
Type
string
Inherited_from
\Zend_Markup_Renderer_RendererAbstract::$$_encoding  
>VPropertyprotectedbool $_filter
inherited
What filter to use
Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_filter
Details
Type
bool
Inherited_from
\Zend_Markup_Renderer_RendererAbstract::$$_filter  
>VPropertyprotectedstring $_group = 'block'
The current group
Default value'block'Details
Type
string
>VPropertyprotectedarray $_groups = array('block' => array('block', 'inline', 'block-empty', 'inline-empty', 'list'), 'inline' => array('inline', 'inline-empty'), 'list' => array('list-item'), 'list-item' => array('inline', 'inline-empty', 'list'), 'block-empty' => array(), 'inline-empty' => array())
Element groups
Default valuearray('block' => array('block', 'inline', 'block-empty', 'inline-empty', 'list'), 'inline' => array('inline', 'inline-empty'), 'list' => array('list-item'), 'list-item' => array('inline', 'inline-empty', 'list'), 'block-empty' => array(), 'inline-empty' => array())Details
Type
array
>VPropertyprotectedarray $_markups = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Markup_Renderer_RendererAbstract::$$_markups  
>VPropertyprotected\Zend_Markup_Parser_ParserInterface $_parser
>VPropertyprotected\Zend_Loader_PluginLoader $_pluginLoader
inherited
Plugin loader for tags
Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_pluginLoader
>VPropertyprotected\Zend_Markup_Token $_token
inherited
The current token
Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_token

Methods

methodpublic__construct(array | \Zend_Config $options = array()) : void

Constructor

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodprotected_defineDefaultMarkups() : void

Define the default markups

methodprotected_execute(\Zend_Markup_Token $token) : string
inherited

Execute the token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_execute()
Parameters
NameTypeDescription
$token\Zend_Markup_Token
Returns
TypeDescription
string
methodprotected_executeReplace(\Zend_Markup_Token $token, array $markup) : string

Execute a replace token

Parameters
NameTypeDescription
$token\Zend_Markup_Token
$markuparray
Returns
TypeDescription
string
methodprotected_executeSingleReplace(\Zend_Markup_Token $token, array $markup) : string

Execute a single replace token

Parameters
NameTypeDescription
$token\Zend_Markup_Token
$markuparray
Returns
TypeDescription
string
methodprotected_filter(string $value) : string
inherited

Filter method

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_filter()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
methodprotected_getGroup(\Zend_Markup_Token $token) : string | bool
inherited

Get the group of a token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_getGroup()
Parameters
NameTypeDescription
$token\Zend_Markup_Token
Returns
TypeDescription
string | bool
methodprotected_getMarkupName(\Zend_Markup_Token $token) : string
inherited

Get the markup name

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_getMarkupName()
Parameters
NameTypeDescription
$token\Zend_Markup_Token
Returns
TypeDescription
string
methodprotected_getMarkupType(string $name) : false | int
inherited

Retrieve markup type

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_getMarkupType()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
false | int
methodprotected_render(\Zend_Markup_Token $token) : string
inherited

Render a single token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_render()
Parameters
NameTypeDescription
$token\Zend_Markup_Token
Returns
TypeDescription
string
methodprotected_resolveMarkupName(string $name) : string
inherited

Resolve aliases for a markup name

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_resolveMarkupName()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
string
methodpublicaddDefaultFilter(string $filter,  $placement = \Zend_Filter::CHAIN_APPEND) : void
inherited

Add a default filter

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addDefaultFilter()
Parameters
NameTypeDescription
$filterstring
$placement
methodpublicaddDefaultFilters() : void

Add the default filters

methodpublicaddFilter(\Zend_Filter_Interface $filter, string $markup, string $placement = \Zend_Filter::CHAIN_APPEND) : \Zend_Markup_Renderer_RendererAbstract
inherited

Add a filter for an existing markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addFilter()
Parameters
NameTypeDescription
$filter\Zend_Filter_Interface
$markupstring
$placementstring
Returns
TypeDescription
\Zend_Markup_Renderer_RendererAbstract
methodpublicaddGroup(string $name, array $allowedInside = array(), array $allowsInside = array()) : void
inherited

Add a render group

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addGroup()
Parameters
NameTypeDescription
$namestring
$allowedInsidearray
$allowsInsidearray
methodpublicaddMarkup(string $name, string $type, array $options) : \Zend_Markup_Renderer_RendererAbstract
inherited

Add a new markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addMarkup()
Parameters
NameTypeDescription
$namestring
$typestring
$optionsarray
Returns
TypeDescription
\Zend_Markup_Renderer_RendererAbstract
methodpubliccheckColor(string $color) : bool
static

Check if a color is a valid HTML color

Parameters
NameTypeDescription
$colorstring
Returns
TypeDescription
bool
methodpublicclearMarkups() : void
inherited

Remove the default tags

Inherited from: \Zend_Markup_Renderer_RendererAbstract::clearMarkups()
methodpublicgetDefaultFilter() : void
inherited

Get the default filter

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getDefaultFilter()
methodpublicgetEncoding() : string
staticinherited

Get the renderer's encoding

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getEncoding()
Returns
TypeDescription
string
methodpublicgetFilter(string $markup) : \Zend_Filter_Interface
inherited

Get the filter for an existing markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getFilter()
Parameters
NameTypeDescription
$markupstring
Returns
TypeDescription
\Zend_Filter_Interface
methodpublicgetGroups() : array
inherited

Get group definitions

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getGroups()
Returns
TypeDescription
array
methodpublicgetPluginLoader() : \Zend_Loader_PluginLoader
inherited

Get the plugin loader

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getPluginLoader()
Returns
TypeDescription
\Zend_Loader_PluginLoader
methodpublicisValidUri(string $uri) : bool
static

Check if the URI is valid

Parameters
NameTypeDescription
$uristring
Returns
TypeDescription
bool
methodpublicremoveMarkup(string $name) : void
inherited

Remove a markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::removeMarkup()
Parameters
NameTypeDescription
$namestring
methodpublicrender( $value) : string
inherited

Render function

Inherited from: \Zend_Markup_Renderer_RendererAbstract::render()
Parameters
NameTypeDescription
$value
Returns
TypeDescription
string
methodpublicrenderAttributes(\Zend_Markup_Token $token, array $attributes = array()) : string
static

Render some attributes

Parameters
NameTypeDescription
$token\Zend_Markup_Token
$attributesarray
Returns
TypeDescription
string
methodpublicsetDefaultFilter(\Zend_Filter_Interface $filter) : void
inherited

Set the default filter

Inherited from: \Zend_Markup_Renderer_RendererAbstract::setDefaultFilter()
Parameters
NameTypeDescription
$filter\Zend_Filter_Interface
methodpublicsetEncoding(string $encoding) : void
staticinherited

Set the renderer's encoding

Inherited from: \Zend_Markup_Renderer_RendererAbstract::setEncoding()
Parameters
NameTypeDescription
$encodingstring
methodpublicsetFilter(\Zend_Filter_Interface $filter, string $markup) : \Zend_Markup_Renderer_RendererAbstract
inherited

Set the filter for an existing

Inherited from: \Zend_Markup_Renderer_RendererAbstract::setFilter()
Parameters
NameTypeDescription
$filter\Zend_Filter_Interface
$markupstring
Returns
TypeDescription
\Zend_Markup_Renderer_RendererAbstract
Documentation was generated by phpDocumentor 2.0.0a12.