Markup/Renderer/Html.php

Show:

inherited

Classes
- \Zend_Markup_Renderer_Html

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
jump to top

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

 
                TYPE_CALLBACK
                = 4

inheritedInherited from: \Zend_Markup_Renderer_RendererAbstract::TYPE_CALLBACK

Inherited_from: \Zend_Markup_Renderer_RendererAbstract::TYPE_CALLBACK

 
                TYPE_REPLACE
                = 8

inheritedInherited from: \Zend_Markup_Renderer_RendererAbstract::TYPE_REPLACE

Inherited_from: \Zend_Markup_Renderer_RendererAbstract::TYPE_REPLACE

 
                TYPE_ALIAS
                = 16

inheritedInherited from: \Zend_Markup_Renderer_RendererAbstract::TYPE_ALIAS

Inherited_from: \Zend_Markup_Renderer_RendererAbstract::TYPE_ALIAS

Properties

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

static

Default attributes

Default valuearray('id' => '', 'class' => '', 'style' => '', 'lang' => '', 'title' => '')Details

Type: array

\Zend_Filter $_defaultFilter

inherited

Filter chain

Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_defaultFilter

Details

Type: \Zend_Filter
Inherited_from: \Zend_Markup_Renderer_RendererAbstract::$$_defaultFilter

string $_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

bool $_filter

inherited

What filter to use

Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_filter

Details

Type: bool
Inherited_from: \Zend_Markup_Renderer_RendererAbstract::$$_filter

string $_group = 'block'

The current group

Default value'block'Details

Type: string

array $_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 value

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

Details

Type: array

array $_markups = array()

inherited

Tag info

Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_markups

Default valuearray()Details

Type: array
Inherited_from: \Zend_Markup_Renderer_RendererAbstract::$$_markups

\Zend_Markup_Parser_ParserInterface $_parser

inherited

Parser

Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_parser

Details

Type: \Zend_Markup_Parser_ParserInterface
Inherited_from: \Zend_Markup_Renderer_RendererAbstract::$$_parser

\Zend_Loader_PluginLoader $_pluginLoader

inherited

Plugin loader for tags

Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_pluginLoader

Details

Type: \Zend_Loader_PluginLoader
Inherited_from: \Zend_Markup_Renderer_RendererAbstract::$$_pluginLoader

\Zend_Markup_Token $_token

inherited

The current token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::$$_token

Details

Type: \Zend_Markup_Token
Inherited_from: \Zend_Markup_Renderer_RendererAbstract::$$_token

Methods

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

Constructor

Parameters

Name	Type	Description
$options	array \| \Zend_Config

_defineDefaultMarkups() : void

Define the default markups

_execute(\Zend_Markup_Token $token) : string

inherited

Execute the token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_execute()

Parameters

Name	Type	Description
$token	\Zend_Markup_Token

Returns

Type	Description
string

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

Execute a replace token

Parameters

Name	Type	Description
$token	\Zend_Markup_Token
$markup	array

Returns

Type	Description
string

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

Execute a single replace token

Parameters

Name	Type	Description
$token	\Zend_Markup_Token
$markup	array

Returns

Type	Description
string

_filter(string $value) : string

inherited

Filter method

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_filter()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

_getGroup(\Zend_Markup_Token $token) : string | bool

inherited

Get the group of a token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_getGroup()

Parameters

Name	Type	Description
$token	\Zend_Markup_Token

Returns

Type	Description
string \| bool

_getMarkupName(\Zend_Markup_Token $token) : string

inherited

Get the markup name

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_getMarkupName()

Parameters

Name	Type	Description
$token	\Zend_Markup_Token

Returns

Type	Description
string

_getMarkupType(string $name) : false | int

inherited

Retrieve markup type

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_getMarkupType()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
false \| int

_render(\Zend_Markup_Token $token) : string

inherited

Render a single token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_render()

Parameters

Name	Type	Description
$token	\Zend_Markup_Token

Returns

Type	Description
string

_resolveMarkupName(string $name) : string

inherited

Resolve aliases for a markup name

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_resolveMarkupName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

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

inherited

Add a default filter

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addDefaultFilter()

Parameters

Name	Type	Description
$filter	string
$placement

addDefaultFilters() : void

Add the default filters

addFilter(\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

Name	Type	Description
$filter	\Zend_Filter_Interface
$markup	string
$placement	string

Returns

Type	Description
\Zend_Markup_Renderer_RendererAbstract

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

inherited

Add a render group

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addGroup()

Parameters

Name	Type	Description
$name	string
$allowedInside	array
$allowsInside	array

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

inherited

Add a new markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addMarkup()

Parameters

Name	Type	Description
$name	string
$type	string
$options	array

Returns

Type	Description
\Zend_Markup_Renderer_RendererAbstract

checkColor(string $color) : bool

static

Check if a color is a valid HTML color

Parameters

Name	Type	Description
$color	string

Returns

Type	Description
bool

clearMarkups() : void

inherited

Remove the default tags

Inherited from: \Zend_Markup_Renderer_RendererAbstract::clearMarkups()

getDefaultFilter() : void

inherited

Get the default filter

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getDefaultFilter()

getEncoding() : string

staticinherited

Get the renderer's encoding

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getEncoding()

Returns

Type	Description
string

getFilter(string $markup) : \Zend_Filter_Interface

inherited

Get the filter for an existing markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getFilter()

Parameters

Name	Type	Description
$markup	string

Returns

Type	Description
\Zend_Filter_Interface

getGroups() : array

inherited

Get group definitions

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getGroups()

Returns

Type	Description
array

getParser() : \Zend_Markup_Parser_ParserInterface

inherited

Get the parser

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getParser()

Returns

Type	Description
\Zend_Markup_Parser_ParserInterface

getPluginLoader() : \Zend_Loader_PluginLoader

inherited

Get the plugin loader

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getPluginLoader()

Returns

Type	Description
\Zend_Loader_PluginLoader

isValidUri(string $uri) : bool

static

Check if the URI is valid

Parameters

Name	Type	Description
$uri	string

Returns

Type	Description
bool

removeMarkup(string $name) : void

inherited

Remove a markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::removeMarkup()

Parameters

Name	Type	Description
$name	string

render( $value) : string

inherited

Render function

Inherited from: \Zend_Markup_Renderer_RendererAbstract::render()

Parameters

Name	Type	Description
$value

Returns

Type	Description
string

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

static

Render some attributes

Parameters

Name	Type	Description
$token	\Zend_Markup_Token
$attributes	array

Returns

Type	Description
string

setDefaultFilter(\Zend_Filter_Interface $filter) : void

inherited

Set the default filter

Inherited from: \Zend_Markup_Renderer_RendererAbstract::setDefaultFilter()

Parameters

Name	Type	Description
$filter	\Zend_Filter_Interface

setEncoding(string $encoding) : void

staticinherited

Set the renderer's encoding

Inherited from: \Zend_Markup_Renderer_RendererAbstract::setEncoding()

Parameters

Name	Type	Description
$encoding	string

setFilter(\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

Name	Type	Description
$filter	\Zend_Filter_Interface
$markup	string

Returns

Type	Description
\Zend_Markup_Renderer_RendererAbstract

setParser(\Zend_Markup_Parser_ParserInterface $parser) : \Zend_Markup_Renderer_RendererAbstract

inherited

Set the parser

Inherited from: \Zend_Markup_Renderer_RendererAbstract::setParser()

Parameters

Name	Type	Description
$parser	\Zend_Markup_Parser_ParserInterface

Returns

Type	Description
\Zend_Markup_Renderer_RendererAbstract

Markup/Renderer/Html.php

\Zend_Markup_Renderer_Htmljump to top

Constants

Properties

Methods

\Zend_Markup_Renderer_Html
jump to top