API Documentation

Markup/Renderer/Html.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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Markup  
subpackage
Renderer  
version
$Id: Html.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Markup_Renderer_Html

HTML renderer

Extends from
\Zend_Markup_Renderer_RendererAbstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Markup  
subpackage
Renderer  

Properties

Propertyprotectedarray  $_defaultAttributes= 'array'
static

Default attributes

Default valuearrayDetails
Type
array
Propertyprotectedstring  $_group= 'block'

The current group

Default valueblockDetails
Type
string
Propertyprotectedarray  $_groups= 'array'

Element groups

Default valuearrayDetails
Type
array

Methods

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

Constructor

Parameters
Name Type Description
$options array|\Zend_Config
methodprotected_defineDefaultMarkups( ) : void

Define the default markups

methodprotected_execute( \Zend_Markup_Token $token ) : string

Execute the token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_execute()
Parameters
Name Type Description
$token \Zend_Markup_Token
Returns
Type Description
string
methodprotected_executeReplace( \Zend_Markup_Token $token, array $markup ) : string

Execute a replace token

Parameters
Name Type Description
$token \Zend_Markup_Token
$markup array
Returns
Type Description
string
methodprotected_executeSingleReplace( \Zend_Markup_Token $token, array $markup ) : string

Execute a single replace token

Parameters
Name Type Description
$token \Zend_Markup_Token
$markup array
Returns
Type Description
string
methodprotected_filter( string $value ) : string
Parameters
Name Type Description
$value string
Returns
Type Description
string
methodprotected_getGroup( \Zend_Markup_Token $token ) : string|bool

Get the group of a token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_getGroup()
Parameters
Name Type Description
$token \Zend_Markup_Token
Returns
Type Description
stringbool
methodprotected_getMarkupName(  $token ) : string

Get the markup name

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_getMarkupName()
Parameters
Name Type Description
$token Zend_Markup_Token
Returns
Type Description
string
methodprotected_getMarkupType( string $name ) : false|int

Retrieve markup type

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_getMarkupType()
Parameters
Name Type Description
$name string
Returns
Type Description
falseint
methodprotected_render( \Zend_Markup_Token $token ) : string

Render a single token

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_render()
Parameters
Name Type Description
$token \Zend_Markup_Token
Returns
Type Description
string
methodprotected_resolveMarkupName( string $name ) : string

Resolve aliases for a markup name

Inherited from: \Zend_Markup_Renderer_RendererAbstract::_resolveMarkupName()
Parameters
Name Type Description
$name string
Returns
Type Description
string
methodpublicaddDefaultFilter( string $filter,  $placement = Zend_Filter ) : void

Add a default filter

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addDefaultFilter()
Parameters
Name Type Description
$filter string
$placement
methodpublicaddDefaultFilters( ) : void

Add the default filters

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

Add a filter for an existing markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addFilter()
Parameters
Name Type Description
$filter \Zend_Filter_Interface
$markup string
$placement string
Returns
Type Description
\Zend_Markup_Renderer_RendererAbstract
methodpublicaddGroup( string $name, array $allowedInside = array, array $allowsInside = array ) : void

Add a render group

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addGroup()
Parameters
Name Type Description
$name string
$allowedInside array
$allowsInside array
methodpublicaddMarkup( string $name, string $type, array $options ) : \Zend_Markup_Renderer_RendererAbstract

Add a new markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::addMarkup()
Parameters
Name Type Description
$name string
$type string
$options array
Returns
Type Description
\Zend_Markup_Renderer_RendererAbstract
methodpubliccheckColor( string $color ) : bool
static

Check if a color is a valid HTML color

Parameters
Name Type Description
$color string
Returns
Type Description
bool
methodpublicclearMarkups( ) : void

Remove the default tags

Inherited from: \Zend_Markup_Renderer_RendererAbstract::clearMarkups()
methodpublicgetDefaultFilter( ) : void

Get the default filter

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getDefaultFilter()
methodpublicgetEncoding( ) : string
static

Get the renderer's encoding

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getEncoding()
Returns
Type Description
string
methodpublicgetFilter( string $markup ) : \Zend_Filter_Interface

Get the filter for an existing markup

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getFilter()
Parameters
Name Type Description
$markup string
Returns
Type Description
\Zend_Filter_Interface
methodpublicgetGroups( ) : array

Get group definitions

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getGroups()
Returns
Type Description
array
methodpublicgetPluginLoader( ) : \Zend_Loader_PluginLoader

Get the plugin loader

Inherited from: \Zend_Markup_Renderer_RendererAbstract::getPluginLoader()
Returns
Type Description
\Zend_Loader_PluginLoader
methodpublicisValidUri( string $uri ) : bool
static

Check if the URI is valid

Parameters
Name Type Description
$uri string
Returns
Type Description
bool
methodpublicremoveMarkup( string $name ) : void
Parameters
Name Type Description
$name string
methodpublicrender(  $value ) : string

Render function

Inherited from: \Zend_Markup_Renderer_RendererAbstract::render()
Parameters
Name Type Description
$value
Returns
Type Description
string
methodpublicrenderAttributes( \Zend_Markup_Token $token, array $attributes = array ) : string
static

Render some attributes

Parameters
Name Type Description
$token \Zend_Markup_Token
$attributes array
Returns
Type Description
string
methodpublicsetDefaultFilter( \Zend_Filter_Interface $filter ) : void

Set the default filter

Inherited from: \Zend_Markup_Renderer_RendererAbstract::setDefaultFilter()
Parameters
Name Type Description
$filter \Zend_Filter_Interface
methodpublicsetEncoding( string $encoding ) : void
static

Set the renderer's encoding

Inherited from: \Zend_Markup_Renderer_RendererAbstract::setEncoding()
Parameters
Name Type Description
$encoding string
methodpublicsetFilter( \Zend_Filter_Interface $filter, string $markup ) : \Zend_Markup_Renderer_RendererAbstract

Set the filter for an existing

Inherited from: \Zend_Markup_Renderer_RendererAbstract::setFilter()
Parameters
Name Type Description
$filter \Zend_Filter_Interface
$markup string
Returns
Type Description
\Zend_Markup_Renderer_RendererAbstract
Documentation was generated by DocBlox 0.13.3.