Zend_Markup_Renderer_RendererAbstract Class Reference

Public Member Functions
	__construct ($options=array())
	Constructor.
	setParser (Zend_Markup_Parser_ParserInterface $parser)
	Set the parser.
	getParser ()
	Get the parser.
	getPluginLoader ()
	Get the plugin loader.
	addMarkup ($name, $type, array $options)
	Add a new markup.
	removeMarkup ($name)
	Remove a markup.
	clearMarkups ()
	Remove the default tags.
	render ($value)
	Render function.
	getDefaultFilter ()
	Get the default filter.
	addDefaultFilter (Zend_Filter_Interface $filter, $placement=Zend_Filter::CHAIN_APPEND)
	Add a default filter.
	setDefaultFilter (Zend_Filter_Interface $filter)
	Set the default filter.
	getFilter ($markup)
	Get the filter for an existing markup.
	addFilter (Zend_Filter_Interface $filter, $markup, $placement=Zend_Filter::CHAIN_APPEND)
	Add a filter for an existing markup.
	setFilter (Zend_Filter_Interface $filter, $markup)
	Set the filter for an existing.
	addGroup ($name, array $allowedInside=array(), array $allowsInside=array())
	Add a render group.
	getGroups ()
	Get group definitions.
	addDefaultFilters ()
	Set the default filters.

Static Public Member Functions
static	setEncoding ($encoding)
	Set the renderer's encoding.
static	getEncoding ()
	Get the renderer's encoding.

Public Attributes
const	TYPE_CALLBACK = 4
const	TYPE_REPLACE = 8
const	TYPE_ALIAS = 16

Protected Member Functions
	_render (Zend_Markup_Token $token)
	Render a single token.
	_getGroup (Zend_Markup_Token $token)
	Get the group of a token.
	_execute (Zend_Markup_Token $token)
	Execute the token.
	_filter ($value)
	Filter method.
	_getMarkupName (Zend_Markup_Token $token)
	Get the markup name.
	_resolveMarkupName ($name)
	Resolve aliases for a markup name.
	_getMarkupType ($name)
	Retrieve markup type.
	_executeReplace (Zend_Markup_Token $token, $tag)
	Execute a replace token.
	_executeSingleReplace (Zend_Markup_Token $token, $tag)
	Execute a single replace token.

Protected Attributes
	$_markups = array()
	$_parser
	$_filter
	$_defaultFilter
	$_group
	$_groups = array()
	$_pluginLoader
	$_token

Static Protected Attributes
static	$_encoding = 'UTF-8'

Constructor & Destructor Documentation

__construct

(

$options = array()

)

Constructor.

Parameters

array | Zend_Config

$options

Returns

void

Member Function Documentation

_execute ( Zend_Markup_Token  $token )

protected

Execute the token.

Parameters

Zend_Markup_Token

$token

Returns

string

_executeReplace ( Zend_Markup_Token  $token,   $tag  )

protected

Execute a replace token.

Parameters

Zend_Markup_Token	$token
array	$tag

Returns

string

_executeSingleReplace ( Zend_Markup_Token  $token,   $tag  )

protected

Execute a single replace token.

Parameters

Zend_Markup_Token	$token
array	$tag

Returns

string

_filter (   $value )

protected

Filter method.

Parameters

string

$value

Returns

string

_getGroup ( Zend_Markup_Token  $token )

protected

Get the group of a token.

Parameters

Zend_Markup_Token

$token

Returns

string|bool

_getMarkupName ( Zend_Markup_Token  $token )

protected

Get the markup name.

Parameters

Zend_Markup_Token

Returns

string

_getMarkupType (   $name )

protected

Retrieve markup type.

Parameters

string

$name

Returns

false|int

_render ( Zend_Markup_Token  $token )

protected

Render a single token.

Parameters

Zend_Markup_Token

$token

Returns

string

_resolveMarkupName (   $name )

protected

Resolve aliases for a markup name.

Parameters

string

$name

Returns

string

addDefaultFilter	(	Zend_Filter_Interface	$filter,
			$placement = Zend_Filter::CHAIN_APPEND
	)

Add a default filter.

Parameters

string

$filter

Returns

void

addDefaultFilters ( )

abstract

Set the default filters.

Returns

void

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

Add a filter for an existing markup.

Parameters

Zend_Filter_Interface	$filter
string	$markup
string	$placement

Returns

Zend_Markup_Renderer_RendererAbstract

addGroup	(		$name,
		array	$allowedInside = array(),
		array	$allowsInside = array()
	)

Add a render group.

Parameters

string	$name
array	$allowedInside
array	$allowsInside

Returns

void

addMarkup	(		$name,
			$type,
		array	$options
	)

Add a new markup.

Parameters

string	$name
string	$type
array	$options

Returns

Zend_Markup_Renderer_RendererAbstract

clearMarkups

(

)

Remove the default tags.

Returns

void

getDefaultFilter

(

)

Get the default filter.

Returns

void

static getEncoding ( )

static

Get the renderer's encoding.

Returns

string

getFilter

(

$markup

)

Get the filter for an existing markup.

Parameters

string

$markup

Returns

Zend_Filter_Interface

getGroups

(

)

Get group definitions.

Returns

array

getParser

(

)

Get the parser.

Returns

Zend_Markup_Parser_ParserInterface

getPluginLoader

(

)

Get the plugin loader.

Returns

Zend_Loader_PluginLoader

removeMarkup

(

$name

)

Remove a markup.

Parameters

string

$name

Returns

void

render

(

$value

)

Render function.

Parameters

Zend_Markup_TokenList | string

$tokenList

Returns

string

setDefaultFilter

(

Zend_Filter_Interface

$filter

)

Set the default filter.

Parameters

Zend_Filter_Interface

$filter

Returns

void

static setEncoding (   $encoding )

static

Set the renderer's encoding.

Parameters

string

$encoding

Returns

void

setFilter	(	Zend_Filter_Interface	$filter,
			$markup
	)

Set the filter for an existing.

Parameters

Zend_Filter_Interface	$filter
string	$markup

Returns

Zend_Markup_Renderer_RendererAbstract

setParser

(

Zend_Markup_Parser_ParserInterface

$parser

)

Set the parser.

Parameters

Zend_Markup_Parser_ParserInterface

$parser

Returns

Zend_Markup_Renderer_RendererAbstract

Member Data Documentation

$_defaultFilter

protected

$_encoding = 'UTF-8'

staticprotected

$_filter

protected

$_group

protected

$_groups = array()

protected

$_markups = array()

protected

$_parser

protected

$_pluginLoader

protected

$_token

protected

const TYPE_ALIAS = 16

const TYPE_CALLBACK = 4

const TYPE_REPLACE = 8