CBTValue Class Reference

A dependency-tracking value class Callback functions should return one of these, unless they have no dependencies in which case they can return a string. More...

List of all members.

Public Member Functions

 CBTValue ($text= '', $deps=array(), $isTemplate=false)
 Create a new value.
 cat ($val)
 Concatenate two values, merging their dependencies.
 addDeps ($values)
 Add the dependencies of another value to this one.
 removeDeps ($deps)
 Remove a list of dependencies.
 setText ($text)
 getText ()
 getDeps ()
 execute (&$processor)
 If the value is a template, execute it.
 templateEscape ()
 If the value is plain text, escape it for inclusion in a template.
 isStatic ()
 Return true if the value has no dependencies.

Public Attributes

 $mText
 $mDeps
 $mIsTemplate


Detailed Description

A dependency-tracking value class Callback functions should return one of these, unless they have no dependencies in which case they can return a string.

Definition at line 50 of file CBTProcessor.php.


Member Function Documentation

CBTValue::addDeps ( values  ) 

Add the dependencies of another value to this one.

Definition at line 80 of file CBTProcessor.php.

Referenced by cat(), and execute().

CBTValue::cat ( val  ) 

Concatenate two values, merging their dependencies.

Definition at line 70 of file CBTProcessor.php.

References addDeps().

CBTValue::CBTValue ( text = '',
deps = array(),
isTemplate = false 
)

Create a new value.

Parameters:
$text String: , default ''.
$deps Array: what this value depends on
$isTemplate Bool: whether the result needs compilation/execution, default 'false'.

Definition at line 59 of file CBTProcessor.php.

References $text.

CBTValue::execute ( &$  processor  ) 

If the value is a template, execute it.

Definition at line 112 of file CBTProcessor.php.

References $processor, and addDeps().

CBTValue::getDeps (  ) 

Definition at line 107 of file CBTProcessor.php.

CBTValue::getText (  ) 

Definition at line 103 of file CBTProcessor.php.

CBTValue::isStatic (  ) 

Return true if the value has no dependencies.

Definition at line 138 of file CBTProcessor.php.

CBTValue::removeDeps ( deps  ) 

Remove a list of dependencies.

Definition at line 95 of file CBTProcessor.php.

CBTValue::setText ( text  ) 

Definition at line 99 of file CBTProcessor.php.

References $text.

CBTValue::templateEscape (  ) 

If the value is plain text, escape it for inclusion in a template.

Definition at line 131 of file CBTProcessor.php.

References cbt_escape().


Member Data Documentation

CBTValue::$mDeps

Definition at line 51 of file CBTProcessor.php.

CBTValue::$mIsTemplate

Definition at line 51 of file CBTProcessor.php.

CBTValue::$mText

Definition at line 51 of file CBTProcessor.php.


The documentation for this class was generated from the following file:

Generated on Sat Sep 5 02:08:34 2009 for MediaWiki by  doxygen 1.5.9