Markup/Renderer/RendererAbstract.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-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

>VConstant  TYPE_CALLBACK = 4
>VConstant  TYPE_REPLACE = 8
>VConstant  TYPE_ALIAS = 16

Properties

>VPropertyprotected\Zend_Filter $_defaultFilter
Filter chain
Details
Type
\Zend_Filter
>VPropertyprotectedstring $_encoding = 'UTF-8'
static
Encoding
Default value'UTF-8'Details
Type
string
>VPropertyprotectedbool $_filter
What filter to use
Details
Type
bool
>VPropertyprotectedstring $_group
The current group
Details
Type
string
>VPropertyprotectedarray $_groups = array()
Groups definition
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_markups = array()
Tag info
Default valuearray()Details
Type
array
>VPropertyprotected\Zend_Markup_Parser_ParserInterface $_parser
Parser
>VPropertyprotected\Zend_Loader_PluginLoader $_pluginLoader
Plugin loader for tags
>VPropertyprotected\Zend_Markup_Token $_token
The current token

Methods

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

Constructor

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodprotected_execute(\Zend_Markup_Token $token) : string

Execute the token

Parameters
NameTypeDescription
$token\Zend_Markup_Token
Returns
TypeDescription
string
methodprotected_executeReplace(\Zend_Markup_Token $token, array $tag) : string

Execute a replace token

Parameters
NameTypeDescription
$token\Zend_Markup_Token
$tagarray
Returns
TypeDescription
string
methodprotected_executeSingleReplace(\Zend_Markup_Token $token, array $tag) : string

Execute a single replace token

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

Filter method

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
methodprotected_getGroup(\Zend_Markup_Token $token) : string | bool

Get the group of a token

Parameters
NameTypeDescription
$token\Zend_Markup_Token
Returns
TypeDescription
string | bool
methodprotected_getMarkupName( $token) : string

Get the markup name

Parameters
NameTypeDescription
$token
Returns
TypeDescription
string
methodprotected_getMarkupType(string $name) : false | int

Retrieve markup type

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
false | int
methodprotected_render(\Zend_Markup_Token $token) : string

Render a single token

Parameters
NameTypeDescription
$token\Zend_Markup_Token
Returns
TypeDescription
string
methodprotected_resolveMarkupName(string $name) : string

Resolve aliases for a markup name

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
string
methodpublicaddDefaultFilter(string $filter,  $placement = \Zend_Filter::CHAIN_APPEND) : void

Add a default filter

Parameters
NameTypeDescription
$filterstring
$placement
methodpublicaddDefaultFilters() : void
abstract

Set the default filters

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

Add a filter for an existing markup

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

Add a render group

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

Add a new markup

Parameters
NameTypeDescription
$namestring
$typestring
$optionsarray
Returns
TypeDescription
\Zend_Markup_Renderer_RendererAbstract
methodpublicclearMarkups() : void

Remove the default tags

methodpublicgetDefaultFilter() : void

Get the default filter

methodpublicgetEncoding() : string
static

Get the renderer's encoding

Returns
TypeDescription
string
methodpublicgetFilter(string $markup) : \Zend_Filter_Interface

Get the filter for an existing markup

Parameters
NameTypeDescription
$markupstring
Returns
TypeDescription
\Zend_Filter_Interface
methodpublicgetGroups() : array

Get group definitions

Returns
TypeDescription
array
methodpublicgetParser() : \Zend_Markup_Parser_ParserInterface

Get the parser

methodpublicgetPluginLoader() : \Zend_Loader_PluginLoader

Get the plugin loader

Returns
TypeDescription
\Zend_Loader_PluginLoader
methodpublicremoveMarkup(string $name) : void

Remove a markup

Parameters
NameTypeDescription
$namestring
methodpublicrender( $value) : string

Render function

Parameters
NameTypeDescription
$value
Returns
TypeDescription
string
methodpublicsetDefaultFilter(\Zend_Filter_Interface $filter) : void

Set the default filter

Parameters
NameTypeDescription
$filter\Zend_Filter_Interface
methodpublicsetEncoding(string $encoding) : void
static

Set the renderer's encoding

Parameters
NameTypeDescription
$encodingstring
methodpublicsetFilter(\Zend_Filter_Interface $filter, string $markup) : \Zend_Markup_Renderer_RendererAbstract

Set the filter for an existing

Parameters
NameTypeDescription
$filter\Zend_Filter_Interface
$markupstring
Returns
TypeDescription
\Zend_Markup_Renderer_RendererAbstract
Documentation was generated by phpDocumentor 2.2.0 .