Zend Framework API Documentation » \Zend_Markup_Renderer

Constants

HTML renderer

category	Zend
package	Zend_Markup
subpackage	Renderer
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License
inherited_from	\Zend_Markup_Renderer_RendererAbstract

Methods

Constructor

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

inherited_from	\Zend_Markup_Renderer_RendererAbstract::__construct()

Parameters

$options

array\Zend_Config

Constructor

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

Inherited

Parameters

$options

array\Zend_Config

Add a default filter

addDefaultFilter(string $filter, $placement = \Zend_Filter::CHAIN_APPEND) : void

Inherited

Parameters

$filter

string

$placement

Add the default filters

addDefaultFilters() : void

inherited_from	\Zend_Markup_Renderer_RendererAbstract::addDefaultFilters()

Set the default filters

addDefaultFilters() : void

Inherited

Add a filter for an existing markup

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

Inherited

Parameters

$filter

\Zend_Filter_Interface

$markup

string

$placement

string

Returns

\Zend_Markup_Renderer_RendererAbstract

Add a render group

addGroup(string $name, array $allowedInside = array(), array $allowsInside = array()) : void

Inherited

Parameters

$name

string

$allowedInside

array

$allowsInside

array

Add a new markup

addMarkup(string $name, string $type, array $options) : \Zend_Markup_Renderer_RendererAbstract

Inherited

Parameters

$name

string

$type

string

$options

array

Returns

\Zend_Markup_Renderer_RendererAbstract

Check if a color is a valid HTML color

checkColor(string $color) : boolean

Static

Parameters

$color

string

Returns

boolean

Remove the default tags

clearMarkups() : void

Inherited

Get the default filter

getDefaultFilter() : void

Inherited

Get the renderer's encoding

getEncoding() : string

InheritedStatic

Returns

string

Get the filter for an existing markup

getFilter(string $markup) : \Zend_Filter_Interface

Inherited

Parameters

$markup

string

Returns

\Zend_Filter_Interface

Get group definitions

getGroups() : array

Inherited

Returns

array

Get the parser

getParser() : \Zend_Markup_Parser_ParserInterface

Inherited

Returns

\Zend_Markup_Parser_ParserInterface

Get the plugin loader

getPluginLoader() : \Zend_Loader_PluginLoader

Inherited

Returns

\Zend_Loader_PluginLoader

Check if the URI is valid

isValidUri(string $uri) : boolean

Static

Parameters

$uri

string

Returns

boolean

Remove a markup

removeMarkup(string $name) : void

Inherited

Parameters

$name

string

Render function

render($value) : string

Inherited

Parameters

$value

Returns

string

Render some attributes

renderAttributes(\Zend_Markup_Token $token, array $attributes = array()) : string

Static

Parameters

$token

\Zend_Markup_Token

$attributes

array

Returns

string

Set the default filter

setDefaultFilter(\Zend_Filter_Interface $filter) : void

Inherited

Parameters

$filter

\Zend_Filter_Interface

Set the renderer's encoding

setEncoding(string $encoding) : void

InheritedStatic

Parameters

$encoding

string

Set the filter for an existing

setFilter(\Zend_Filter_Interface $filter, string $markup) : \Zend_Markup_Renderer_RendererAbstract

Inherited

Parameters

$filter

\Zend_Filter_Interface

$markup

string

Returns

\Zend_Markup_Renderer_RendererAbstract

Set the parser

setParser(\Zend_Markup_Parser_ParserInterface $parser) : \Zend_Markup_Renderer_RendererAbstract

Inherited

Parameters

$parser

\Zend_Markup_Parser_ParserInterface

Returns

\Zend_Markup_Renderer_RendererAbstract

Define the default markups

_defineDefaultMarkups() : void

Execute the token

_execute(\Zend_Markup_Token $token) : string

Inherited

Parameters

$token

\Zend_Markup_Token

Returns

string

Execute a replace token

_executeReplace(\Zend_Markup_Token $token, array $markup) : string

inherited_from	\Zend_Markup_Renderer_RendererAbstract::_executeReplace()

Parameters

$token

\Zend_Markup_Token

$markup

array

Returns

string

Execute a replace token

_executeReplace(\Zend_Markup_Token $token, array $tag) : string

Inherited

Parameters

$token

\Zend_Markup_Token

$tag

array

Returns

string

Execute a single replace token

_executeSingleReplace(\Zend_Markup_Token $token, array $markup) : string

inherited_from	\Zend_Markup_Renderer_RendererAbstract::_executeSingleReplace()

Parameters

$token

\Zend_Markup_Token

$markup

array

Returns

string

Execute a single replace token

_executeSingleReplace(\Zend_Markup_Token $token, array $tag) : string

Inherited

Parameters

$token

\Zend_Markup_Token

$tag

array

Returns

string

Filter method

_filter(string $value) : string

Inherited

Parameters

$value

string

Returns

string

Get the group of a token

_getGroup(\Zend_Markup_Token $token) : string | boolean

Inherited

Parameters

$token

\Zend_Markup_Token

Returns

stringboolean

Get the markup name

_getMarkupName(\Zend_Markup_Token $token) : string

Inherited

Parameters

$token

Returns

string

Retrieve markup type

_getMarkupType(string $name) : false | integer

Inherited

Parameters

$name

string

Returns

falseinteger

Render a single token

_render(\Zend_Markup_Token $token) : string

Inherited

Parameters

$token

\Zend_Markup_Token

Returns

string

Resolve aliases for a markup name

_resolveMarkupName(string $name) : string

Inherited

Parameters

$name

string

Returns

string

Properties

Default attributes

$_defaultAttributes : array

Default

array('id' => '', 'class' => '', 'style' => '', 'lang' => '', 'title' => '')

Static

Filter chain

$_defaultFilter : \Zend_Filter

Default

Encoding

$_encoding : string

Default

'UTF-8'

Static

What filter to use

$_filter : boolean

Default

The current group

$_group : string

Default

'block'

inherited_from	\Zend_Markup_Renderer_RendererAbstract::_group

The current group

$_group : string

Default

Element groups

$_groups : array

Default

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())

inherited_from	\Zend_Markup_Renderer_RendererAbstract::_groups

Groups definition

$_groups : array

Default

array()

Tag info

$_markups : array

Default

array()

Parser

$_parser : \Zend_Markup_Parser_ParserInterface

Default

Plugin loader for tags

$_pluginLoader : \Zend_Loader_PluginLoader

Default

The current token

$_token : \Zend_Markup_Token

Default

Constants

TYPE_ALIAS

TYPE_ALIAS = 16

TYPE_CALLBACK

TYPE_CALLBACK = 4

TYPE_REPLACE

TYPE_REPLACE = 8