Docs For Class CMS

Description

Class CMS_modulesTags

represent all modules tags processing.

author: Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>

Located in /automne/classes/modules/modulesTags.php (line 27)

CMS_grandFather
   |
   --CMS_modulesTags

Method Summary

void __construct (integer $treatmentMode, integer $visualizationMode, &$treatedObject, object $treatedObject)

string computeTags (multidimentionnal $definition, [integer $level = 0])

void getParsingError ()

void getTags ([ $tagFilters = array()], [ $enclose = false])

array getWantedTags ()

void setDefinition ( $definition)

void setTreatmentParameters ([ $treatmentParameters = array()])

void treatContent ([ $enclose = false])

string treatWantedTag ( &$tag, [array $treatmentParameters = array()], string $tag)

string _getTags (multidimentionnal &$definition, $tagFilters, [integer $level = 0])

void _isWanted ( $node)

void _parse ( $options)

Methods

Constructor __construct (line 81)

Constructor.

initializes object.

access: public

void __construct (integer $treatmentMode, integer $visualizationMode, &$treatedObject, object $treatedObject)

integer $treatmentMode: The current treatment mode (see constants in cms_rc.php for accepted values).
integer $visualizationMode: The current visualization mode (see constants in cms_rc.php for accepted values).
object $treatedObject: The reference object to treat.
&$treatedObject

computeTags (line 316)

Compute recursively all parsed definition tags and send them to callback methods (according to $this->_tagsCallBack)

return: the PHP / HTML content computed

string computeTags (multidimentionnal $definition, [integer $level = 0])

integer $level: : the current level of recursion (default : 0)
multidimentionnal $definition: array $definition : the XML tags definition to compute

getParsingError (line 221)

void getParsingError ()

getTags (line 228)

void getTags ([ $tagFilters = array()], [ $enclose = false])

$tagFilters
$enclose

getWantedTags (line 110)

Get the tags to be treated by modules for the specified treatment mode, visualization mode and object.

return: of tags to be treated.
access: public

array getWantedTags ()

setDefinition (line 200)

void setDefinition ( $definition)

$definition

setTreatmentParameters (line 195)

void setTreatmentParameters ([ $treatmentParameters = array()])

$treatmentParameters

treatContent (line 288)

void treatContent ([ $enclose = false])

$enclose

treatWantedTag (line 137)

Treat given content tag by modules for the specified treatment mode, visualization mode and object.

return: the tag content treated.
access: public

string treatWantedTag ( &$tag, [array $treatmentParameters = array()], string $tag)

string $tag: The CMS_XMLTag.
array $treatmentParameters: : optionnal parameters used for the treatment. Usually an array of objects.
&$tag

_getTags (line 257)

Compute recursively all parsed definition tags and send them to callback methods (according to $this->_tagsCallBack)

return: the PHP / HTML content computed
access: private

string _getTags (multidimentionnal &$definition, $tagFilters, [integer $level = 0])

integer $level: : the current level of recursion (default : 0)
multidimentionnal &$definition: array $definition : the reference of the definition to compute
$tagFilters

_isWanted (line 375)

void _isWanted ( $node)

$node

_parse (line 204)

void _parse ( $options)

$options

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()

Class Constants

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL