Markup/Renderer/RendererAbstract.php
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Markup
- Subpackage
- Renderer
- Version
- $Id$
\Zend_Markup_Renderer_RendererAbstract
Package: Zend_Markup\Renderer





















Defines the basic rendering functionality
- Children
- \Zend_Markup_Renderer_Html
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties
Methods


__construct(array | \Zend_Config $options = array()) : void
Constructor
Parameters
Name | Type | Description |
---|---|---|
$options | array | \Zend_Config |


_execute(\Zend_Markup_Token $token) : string
Execute the token
Parameters
Returns
Name | Type | Description |
---|---|---|
$token | \Zend_Markup_Token |
Type | Description |
---|---|
string |


_executeReplace(\Zend_Markup_Token $token, array $tag) : string
Execute a replace token
Parameters
Returns
Name | Type | Description |
---|---|---|
$token | \Zend_Markup_Token | |
$tag | array |
Type | Description |
---|---|
string |


_executeSingleReplace(\Zend_Markup_Token $token, array $tag) : string
Execute a single replace token
Parameters
Returns
Name | Type | Description |
---|---|---|
$token | \Zend_Markup_Token | |
$tag | array |
Type | Description |
---|---|
string |


_filter(string $value) : string
Filter method
Parameters
Returns
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
string |


_getGroup(\Zend_Markup_Token $token) : string | bool
Get the group of a token
Parameters
Returns
Name | Type | Description |
---|---|---|
$token | \Zend_Markup_Token |
Type | Description |
---|---|
string | bool |


_getMarkupName( $token) : string
Get the markup name
Parameters
Returns
Name | Type | Description |
---|---|---|
$token |
Type | Description |
---|---|
string |


_getMarkupType(string $name) : false | int
Retrieve markup type
Parameters
Returns
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
false | int |


_render(\Zend_Markup_Token $token) : string
Render a single token
Parameters
Returns
Name | Type | Description |
---|---|---|
$token | \Zend_Markup_Token |
Type | Description |
---|---|
string |


_resolveMarkupName(string $name) : string
Resolve aliases for a markup name
Parameters
Returns
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string |


addDefaultFilter(string $filter, $placement = \Zend_Filter::CHAIN_APPEND) : void
Add a default filter
Parameters
Name | Type | Description |
---|---|---|
$filter | string | |
$placement |


addFilter(\Zend_Filter_Interface $filter, string $markup, string $placement = \Zend_Filter::CHAIN_APPEND) : \Zend_Markup_Renderer_RendererAbstract
Add a filter for an existing markup
Parameters
Returns
Name | Type | Description |
---|---|---|
$filter | \Zend_Filter_Interface | |
$markup | string | |
$placement | string |
Type | Description |
---|---|
\Zend_Markup_Renderer_RendererAbstract |


addGroup(string $name, array $allowedInside = array(), array $allowsInside = array()) : void
Add a render group
Parameters
Name | Type | Description |
---|---|---|
$name | string | |
$allowedInside | array | |
$allowsInside | array |


addMarkup(string $name, string $type, array $options) : \Zend_Markup_Renderer_RendererAbstract
Add a new markup
Parameters
Returns
Name | Type | Description |
---|---|---|
$name | string | |
$type | string | |
$options | array |
Type | Description |
---|---|
\Zend_Markup_Renderer_RendererAbstract |


getFilter(string $markup) : \Zend_Filter_Interface
Get the filter for an existing markup
Parameters
Returns
Name | Type | Description |
---|---|---|
$markup | string |
Type | Description |
---|---|
\Zend_Filter_Interface |


getParser() : \Zend_Markup_Parser_ParserInterface
Get the parser
Returns
Type | Description |
---|---|
\Zend_Markup_Parser_ParserInterface |


getPluginLoader() : \Zend_Loader_PluginLoader
Get the plugin loader
Returns
Type | Description |
---|---|
\Zend_Loader_PluginLoader |


render( $value) : string
Render function
Parameters
Returns
Name | Type | Description |
---|---|---|
$value |
Type | Description |
---|---|
string |


setDefaultFilter(\Zend_Filter_Interface $filter) : void
Set the default filter
Parameters
Name | Type | Description |
---|---|---|
$filter | \Zend_Filter_Interface |


setEncoding(string $encoding) : void
static
Set the renderer's encoding
Parameters
Name | Type | Description |
---|---|---|
$encoding | string |


setFilter(\Zend_Filter_Interface $filter, string $markup) : \Zend_Markup_Renderer_RendererAbstract
Set the filter for an existing
Parameters
Returns
Name | Type | Description |
---|---|---|
$filter | \Zend_Filter_Interface | |
$markup | string |
Type | Description |
---|---|
\Zend_Markup_Renderer_RendererAbstract |


setParser(\Zend_Markup_Parser_ParserInterface $parser) : \Zend_Markup_Renderer_RendererAbstract
Set the parser
Parameters
Returns
Name | Type | Description |
---|---|---|
$parser | \Zend_Markup_Parser_ParserInterface |
Type | Description |
---|---|
\Zend_Markup_Renderer_RendererAbstract |