Markup/Renderer/RendererAbstract.php

Show:

inherited

Classes
- \Zend_Markup_Renderer_RendererAbstract

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

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

 
                TYPE_CALLBACK
                = 4

 
                TYPE_REPLACE
                = 8

 
                TYPE_ALIAS
                = 16

Properties

\Zend_Filter $_defaultFilter

Filter chain

Details

Type: \Zend_Filter

string $_encoding = 'UTF-8'

static

Encoding

Default value'UTF-8'Details

Type: string

bool $_filter

What filter to use

Details

Type: bool

string $_group

The current group

Details

Type: string

array $_groups = array()

Groups definition

Default valuearray()Details

Type: array

array $_markups = array()

Tag info

Default valuearray()Details

Type: array

\Zend_Markup_Parser_ParserInterface $_parser

Parser

Details

Type: \Zend_Markup_Parser_ParserInterface

\Zend_Loader_PluginLoader $_pluginLoader

Plugin loader for tags

Details

Type: \Zend_Loader_PluginLoader

\Zend_Markup_Token $_token

The current token

Details

Type: \Zend_Markup_Token

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

Name	Type	Description
$token	\Zend_Markup_Token

Returns

Type	Description
string

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

Execute a replace token

Parameters

Name	Type	Description
$token	\Zend_Markup_Token
$tag	array

Returns

Type	Description
string

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

Execute a single replace token

Parameters

Name	Type	Description
$token	\Zend_Markup_Token
$tag	array

Returns

Type	Description
string

_filter(string $value) : string

Filter method

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

_getGroup(\Zend_Markup_Token $token) : string | bool

Get the group of a token

Parameters

Name	Type	Description
$token	\Zend_Markup_Token

Returns

Type	Description
string \| bool

_getMarkupName( $token) : string

Get the markup name

Parameters

Name	Type	Description
$token

Returns

Type	Description
string

_getMarkupType(string $name) : false | int

Retrieve markup type

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
false \| int

_render(\Zend_Markup_Token $token) : string

Render a single token

Parameters

Name	Type	Description
$token	\Zend_Markup_Token

Returns

Type	Description
string

_resolveMarkupName(string $name) : string

Resolve aliases for a markup name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

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

Add a default filter

Parameters

Name	Type	Description
$filter	string
$placement

addDefaultFilters() : void

abstract

Set the default filters

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

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

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

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

Returns

Type	Description
\Zend_Markup_Renderer_RendererAbstract

clearMarkups() : void

Remove the default tags

getDefaultFilter() : void

Get the default filter

getEncoding() : string

static

Get the renderer's encoding

Returns

Type	Description
string

getFilter(string $markup) : \Zend_Filter_Interface

Get the filter for an existing markup

Parameters

Name	Type	Description
$markup	string

Returns

Type	Description
\Zend_Filter_Interface

getGroups() : array

Get group definitions

Returns

Type	Description
array

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

removeMarkup(string $name) : void

Remove a markup

Parameters

Name	Type	Description
$name	string

render( $value) : string

Render function

Parameters

Name	Type	Description
$value

Returns

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

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

Set the parser

Parameters

Name	Type	Description
$parser	\Zend_Markup_Parser_ParserInterface

Returns

Type	Description
\Zend_Markup_Renderer_RendererAbstract

Markup/Renderer/RendererAbstract.php

\Zend_Markup_Renderer_RendererAbstractjump to top

Constants

Properties

Methods

\Zend_Markup_Renderer_RendererAbstract
jump to top