From a47971aefd2bee45f4e57dd1fc3ea24bb370881f Mon Sep 17 00:00:00 2001 From: root Date: Sun, 29 Jun 2014 18:32:40 +0200 Subject: Some doco work. Changed main.bb and added a return link to all .bb files and began planning new entries for user orientated documentation. --- doc/old/html/classTemplate.html | 742 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 742 insertions(+) create mode 100644 doc/old/html/classTemplate.html (limited to 'doc/old/html/classTemplate.html') diff --git a/doc/old/html/classTemplate.html b/doc/old/html/classTemplate.html new file mode 100644 index 000000000..9ea7d2643 --- /dev/null +++ b/doc/old/html/classTemplate.html @@ -0,0 +1,742 @@ + + + + + + +The Red Matrix: Template Class Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Matrix +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Public Attributes | +Static Public Attributes | +Private Member Functions | +List of all members
+
+
Template Class Reference
+
+
+
+Inheritance diagram for Template:
+
+
+ + +ITemplateEngine + +
+ + + + + + +

+Public Member Functions

 replace_macros ($s, $r)
 
 get_markup_template ($file, $root='')
 
+ + + + + + + + + + + + + + + + + + + +

+Public Attributes

 $r
 
 $search
 
 $replace
 
 $stack = array()
 
 $nodes = array()
 
 $done = false
 
 $d = false
 
 $lang = null
 
 $debug =false
 
+ + + +

+Static Public Attributes

static $name ="internal"
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Member Functions

 _preg_error ()
 
 _push_stack ()
 
 _pop_stack ()
 
 _get_var ($name, $retNoKey=false)
 
 _replcb_if ($args)
 
 _replcb_for ($args)
 
 _replcb_inc ($args)
 
 _replcb_debug ($args)
 
 _replcb_node ($m)
 
 _replcb ($m)
 
 _build_nodes ($s)
 
 var_replace ($s)
 
 replace ($s, $r)
 
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
Template::_build_nodes ( $s)
+ 		+private
+
+ +

Referenced by replace_macros().

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Template::_get_var ( $name,
 $retNoKey = false 
)
+ 		+private
+
+ +

Referenced by _replcb_debug(), _replcb_for(), _replcb_if(), _replcb_inc(), and var_replace().

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Template::_pop_stack ()
+ 		+private
+
+ +

Referenced by _replcb_for(), and _replcb_inc().

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Template::_preg_error ()
+ 		+private
+
+ +

Referenced by _build_nodes(), and replace_macros().

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Template::_push_stack ()
+ 		+private
+
+ +

Referenced by _replcb_for(), and _replcb_inc().

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Template::_replcb ( $m)
+ 		+private
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Template::_replcb_debug ( $args)
+ 		+private
+
+

DEBUG node

+

{{ debug $var [$var [$var [...]]] }}{{ enddebug }}

+

replace node with

+
var_dump($var, $var, ...);
+
+
+ +
+
+ + + + + +
+ + + + + + + + +
Template::_replcb_for ( $args)
+ 		+private
+
+

FOR node

+

{{ for < $var>=""> as $name }}...{{ endfor }} {{ for < $var>=""> as $key=>$name }}...{{ endfor }}

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Template::_replcb_if ( $args)
+ 		+private
+
+

IF node

+

{{ if < $var>=""> }}...[{{ else }} ...] {{ endif }} {{ if < $var>="">==<val|$var> }}...[{{ else }} ...]{{ endif }} {{ if < $var>="">!=<val|$var> }}...[{{ else }} ...]{{ endif }}

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Template::_replcb_inc ( $args)
+ 		+private
+
+

INC node

+

{{ inc <templatefile> [with $var1=$var2] }}{{ endinc }}

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Template::_replcb_node ( $m)
+ 		+private
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Template::get_markup_template ( $file,
 $root = '' 
)
+
+ +

Implements ITemplateEngine.

+ +

Referenced by _replcb_inc().

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Template::replace ( $s,
 $r 
)
+ 		+private
+
+ +

Referenced by _replcb_for(), and _replcb_inc().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Template::replace_macros ( $s,
 $r 
)
+
+ +

Implements ITemplateEngine.

+ +

Referenced by replace().

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Template::var_replace ( $s)
+ 		+private
+
+

regexp: $ literal $ ([)? optional open square bracket ([a-zA-Z0-9-_]+.?)+ var name, followed by optional dot, repeated at least 1 time (?(1)]) if there was opened square bracket (subgrup 1), match close bracket

+ +

Referenced by replace_macros().

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
Template::$d = false
+
+ +
+
+ +
+
+ + + + +
Template::$debug =false
+
+ +
+
+ +
+
+ + + + +
Template::$done = false
+
+ +
+
+ +
+
+ + + + +
Template::$lang = null
+
+ +
+
+ +
+
+ + + + + +
+ + + + +
Template::$name ="internal"
+ 		+static
+
+ +

Referenced by _get_var().

+ +
+
+ +
+
+ + + + +
Template::$nodes = array()
+
+ +
+
+ +
+
+ + + + +
Template::$r
+
+ +

Referenced by _get_var(), _replcb_for(), _replcb_inc(), replace(), and replace_macros().

+ +
+
+ +
+
+ + + + +
Template::$replace
+
+ +
+
+ +
+
+ + + + +
Template::$search
+
+ +
+
+ +
+
+ + + + +
Template::$stack = array()
+
+ +
+
+
The documentation for this class was generated from the following file: +
+
+ -- cgit v1.2.3