Markup/Renderer/RendererAbstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Markup
subpackage: Renderer
version: $Id: RendererAbstract.php 22198 2010-05-19 13:33:52Z kokx $
Classes: Zend_Markup_Renderer_RendererAbstract

Description

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.

Zend_Markup_Renderer_RendererAbstract
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Markup
subpackage: Renderer
Constants: TYPE_CALLBACK; TYPE_REPLACE; TYPE_ALIAS
Properties: $_markups; $_parser; $_filter; $_defaultFilter; $_group; $_groups; $_pluginLoader; $_token; $_encoding
Methods: __construct; setParser; getParser; getPluginLoader; setEncoding; getEncoding; addMarkup; removeMarkup; clearMarkups; render; _render; _getGroup; _execute; _filter; _getMarkupName; _resolveMarkupName; _getMarkupType; _executeReplace; _executeSingleReplace; getDefaultFilter; addDefaultFilter; setDefaultFilter; getFilter; addFilter; setFilter; addGroup; getGroups; addDefaultFilters

Description

Defines the basic rendering functionality

Constants

TYPE_CALLBACK
jump to class

 TYPE_CALLBACK = '4'

Details

value: 4

TYPE_REPLACE
jump to class

 TYPE_REPLACE = '8'

Details

value: 8

TYPE_ALIAS
jump to class

 TYPE_ALIAS = '16'

Details

value: 16

Properties

$_defaultFilter
jump to class

Zend_Filter $_defaultFilter = ''

Filter chain

Details

$_defaultFilter: Zend_Filter
visibility: protected
default
final: false
static: false

$_encoding
jump to class

string $_encoding = 'UTF-8'

Encoding

Details

$_encoding: string
visibility: protected
default: UTF-8
final: false
static: true

$_filter
jump to class

bool $_filter = ''

What filter to use

Details

$_filter: bool
visibility: protected
default
final: false
static: false

$_group
jump to class

string $_group = ''

The current group

Details

$_group: string
visibility: protected
default
final: false
static: false

$_groups
jump to class

array $_groups = 'array'

Groups definition

Details

$_groups: array
visibility: protected
default: array
final: false
static: false

$_markups
jump to class

array $_markups = 'array'

Tag info

Details

$_markups: array
visibility: protected
default: array
final: false
static: false

$_parser
jump to class

Zend_Markup_Parser_ParserInterface $_parser = ''

Parser

Details

$_parser: Zend_Markup_Parser_ParserInterface
visibility: protected
default
final: false
static: false

$_pluginLoader
jump to class

Zend_Loader_PluginLoader $_pluginLoader = ''

Plugin loader for tags

Details

$_pluginLoader: Zend_Loader_PluginLoader
visibility: protected
default
final: false
static: false

$_token
jump to class

Zend_Markup_Token $_token = ''

The current token

Details

$_token: Zend_Markup_Token
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

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

Constructor

Arguments

$options: arrayZend_Config

Details

visibility: public
final: false
static: false

_execute
jump to class

_execute(
          Zend_Markup_Token $token
          )
        
        :
        string

Execute the token

Arguments

$token: Zend_Markup_Token

Output

string

Details

visibility: protected
final: false
static: false

_executeReplace
jump to class

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

Execute a replace token

Arguments

$token: Zend_Markup_Token
$tag: array

Output

string

Details

visibility: protected
final: false
static: false

_executeSingleReplace
jump to class

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

Execute a single replace token

Arguments

$token: Zend_Markup_Token
$tag: array

Output

string

Details

visibility: protected
final: false
static: false

_filter
jump to class

_filter(
          string $value
          )
        
        :
        string

Filter method

Arguments

$value: string

Output

string

Details

visibility: protected
final: false
static: false

_getGroup
jump to class

_getGroup(
          Zend_Markup_Token $token
          )
        
        :
        string|bool

Get the group of a token

Arguments

$token: Zend_Markup_Token

Output

string|bool

Details

visibility: protected
final: false
static: false

_getMarkupName
jump to class

_getMarkupName(
           $token
          )
        
        :
        string

Get the markup name

Arguments

$token: Zend_Markup_Token

Output

string

Details

visibility: protected
final: false
static: false

_getMarkupType
jump to class

_getMarkupType(
          string $name
          )
        
        :
        false|int

Retrieve markup type

Arguments

$name: string

Output

false|int

Details

visibility: protected
final: false
static: false

_render
jump to class

_render(
          Zend_Markup_Token $token
          )
        
        :
        string

Render a single token

Arguments

$token: Zend_Markup_Token

Output

string

Details

visibility: protected
final: false
static: false

_resolveMarkupName
jump to class

_resolveMarkupName(
          string $name
          )
        
        :
        string

Resolve aliases for a markup name

Arguments

$name: string

Output

string

Details

visibility: protected
final: false
static: false

addDefaultFilter
jump to class

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

Add a default filter

Arguments

$filter: string
$placement

Details

visibility: public
final: false
static: false

addDefaultFilters
jump to class

addDefaultFilters(
          
          )
        
        :
        void

Set the default filters

Details

visibility: public
final: false
static: false

addFilter
jump to class

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

Add a filter for an existing markup

Arguments

$filter: Zend_Filter_Interface
$markup: string
$placement: string

Output

Zend_Markup_Renderer_RendererAbstract

Details

visibility: public
final: false
static: false

addGroup
jump to class

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

Add a render group

Arguments

$name: string
$allowedInside: array
$allowsInside: array

Details

visibility: public
final: false
static: false

addMarkup
jump to class

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

Add a new markup

Arguments

$name: string
$type: string
$options: array

Output

Zend_Markup_Renderer_RendererAbstract

Details

visibility: public
final: false
static: false

clearMarkups
jump to class

clearMarkups(
          
          )
        
        :
        void

Remove the default tags

Details

visibility: public
final: false
static: false

getDefaultFilter
jump to class

getDefaultFilter(
          
          )
        
        :
        void

Get the default filter

Details

visibility: public
final: false
static: false

getEncoding
jump to class

getEncoding(
          
          )
        
        :
        string

Get the renderer's encoding

Output

string

Details

visibility: public
final: false
static: true

getFilter
jump to class

getFilter(
          string $markup
          )
        
        :
        Zend_Filter_Interface

Get the filter for an existing markup

Arguments

$markup: string

Output

Zend_Filter_Interface

Details

visibility: public
final: false
static: false

getGroups
jump to class

getGroups(
          
          )
        
        :
        array

Get group definitions

Output

array

Details

visibility: public
final: false
static: false

getParser
jump to class

getParser(
          
          )
        
        :
        Zend_Markup_Parser_ParserInterface

Get the parser

Output

Zend_Markup_Parser_ParserInterface

Details

visibility: public
final: false
static: false

getPluginLoader
jump to class

getPluginLoader(
          
          )
        
        :
        Zend_Loader_PluginLoader

Get the plugin loader

Output

Zend_Loader_PluginLoader

Details

visibility: public
final: false
static: false

removeMarkup
jump to class

removeMarkup(
          string $name
          )
        
        :
        void

Remove a markup

Arguments

$name: string

Details

visibility: public
final: false
static: false

render
jump to class

render(
           $value
          )
        
        :
        string

Render function

Arguments

$value

Output

string

Details

visibility: public
final: false
static: false

setDefaultFilter
jump to class

setDefaultFilter(
          Zend_Filter_Interface $filter
          )
        
        :
        void

Set the default filter

Arguments

$filter: Zend_Filter_Interface

Details

visibility: public
final: false
static: false

setEncoding
jump to class

setEncoding(
          string $encoding
          )
        
        :
        void

Set the renderer's encoding

Arguments

$encoding: string

Details

visibility: public
final: false
static: true

setFilter
jump to class

setFilter(
          Zend_Filter_Interface $filter, string $markup
          )
        
        :
        Zend_Markup_Renderer_RendererAbstract

Set the filter for an existing

Arguments

$filter: Zend_Filter_Interface
$markup: string

Output

Zend_Markup_Renderer_RendererAbstract

Details

visibility: public
final: false
static: false

setParser
jump to class

setParser(
          Zend_Markup_Parser_ParserInterface $parser
          )
        
        :
        Zend_Markup_Renderer_RendererAbstract

Set the parser

Arguments

$parser: Zend_Markup_Parser_ParserInterface

Output

Zend_Markup_Renderer_RendererAbstract

Details

visibility: public
final: false
static: false

API Documentation

Markup/Renderer/RendererAbstract.php

Description

Zend_Markup_Renderer_RendererAbstractjump to top

Description

Constants

TYPE_CALLBACKjump to class

Details

TYPE_REPLACEjump to class

Details

TYPE_ALIASjump to class

Details

Properties

$_defaultFilterjump to class

Details

$_encodingjump to class

Details

$_filterjump to class

Details

$_groupjump to class

Details

$_groupsjump to class

Details

$_markupsjump to class

Details

$_parserjump to class

Details

$_pluginLoaderjump to class

Details

$_tokenjump to class

Details

Methods

__constructjump to class

Arguments

Details

_executejump to class

Arguments

Output

Details

_executeReplacejump to class

Arguments

Output

Details

_executeSingleReplacejump to class

Arguments

Output

Details

_filterjump to class

Arguments

Output

Details

_getGroupjump to class

Arguments

Output

Details

_getMarkupNamejump to class

Arguments

Output

Details

_getMarkupTypejump to class

Arguments

Output

Details

_renderjump to class

Arguments

Output

Details

_resolveMarkupNamejump to class

Arguments

Output

Details

addDefaultFilterjump to class

Arguments

Details

addDefaultFiltersjump to class

Details

addFilterjump to class

Arguments

Output

Details

Zend_Markup_Renderer_RendererAbstract
jump to top

TYPE_CALLBACK
jump to class

TYPE_REPLACE
jump to class

TYPE_ALIAS
jump to class

$_defaultFilter
jump to class

$_encoding
jump to class

$_filter
jump to class

$_group
jump to class

$_groups
jump to class

$_markups
jump to class

$_parser
jump to class

$_pluginLoader
jump to class

$_token
jump to class

__construct
jump to class

_execute
jump to class

_executeReplace
jump to class

_executeSingleReplace
jump to class

_filter
jump to class

_getGroup
jump to class

_getMarkupName
jump to class

_getMarkupType
jump to class

_render
jump to class

_resolveMarkupName
jump to class

addDefaultFilter
jump to class

addDefaultFilters
jump to class

addFilter
jump to class

addGroup
jump to class

addMarkup
jump to class

clearMarkups
jump to class

getDefaultFilter
jump to class

getEncoding
jump to class

getFilter
jump to class

getGroups
jump to class

getParser
jump to class

getPluginLoader
jump to class

removeMarkup
jump to class

render
jump to class

setDefaultFilter
jump to class

setEncoding
jump to class

setFilter
jump to class

setParser
jump to class