Ister PHP Documentation - Docs For Class T24FunctionContainer

This class represents a set of buildin functions for T24 template language.

General syntax for buildin functions:

 <?t24 :<function> <arg1> <arg2> ... ?>
 
 strings are possible:
 <?t24 :<function> <arg1> "<arg2> <arg2>" '<arg3> <arg3>' ... ?>

It is possible to add more buildin functions e.g. by extending this class. On the other hand, this may not a simple task as it needs knowledge of the internal interaction of the different T24 objects.

Each of the buildin functions will get the parameter buffer from the parser, a reference to the current internal parse tree and the index of the parse tree where this function was called.

The contents of the parameter buffer is as follows:

 $parbuf[0]      - function name
 $parbuf[1..n-1] - function arguments
 $parbuf[n]      - line number

The builins c_repeat() and c_invoke() expect some registered methods to call. Such a method will receive one single array of arguments.

For a description of buildin functions and how to use them see the links below.

copyright:	Copyright (c) 2005 Ister.ORG Ingo Schramm
author:	Ingo Schramm
see:	IsterMethodProxy
see:	T24FunctionContainer::c_include(), T24FunctionContainer::c_invoke(), T24FunctionContainer::c_set(), T24FunctionContainer::c_repeat(), T24FunctionContainer::c_if(), T24FunctionContainer::c_else(), T24FunctionContainer::c_end()

constructor T24FunctionContainer

T24FunctionContainer T24FunctionContainer(
)

Constructor

[ Top ]

method c_else

boolean c_else(
array
$parbuf, object T24TemplateTree
&$tree, integer
$idx)

Define an alternative.

 <?t24 :if DO == 1 ?>
 YES
 <?t24 :else ?>
 NO
 <?t24 :end ?>

Parameters:

array	$parbuf
object T24TemplateTree	&$tree
integer	$idx

[ Top ]

method c_end

boolean c_end(
array
$parbuf, object T24TemplateTree
&$tree, integer
$idx)

End the most recent block.

see:

T24FunctionContainer::c_if(), T24FunctionContainer::c_repeat()

Parameters:

array	$parbuf
object T24TemplateTree	&$tree
integer	$idx

[ Top ]

method c_if

boolean c_if(
array
$parbuf, object T24TemplateTree
&$tree, integer
$idx)

Test if a condition is true.

 <?t24 :if VAR == 1 ?>Hello World!<?t24 :end ?>
 
 <?t24 :if <var> ?>                // true if <var> is true
 <?t24 :if <var> def ?>            // true if <var> not null
 <?t24 :if <var> z  ?>             // true if (string) <var> has zero length
 <?t24 :if <var> nz ?>             // true if (string) <var> has nonzero length
 <?t24 :if <var> eq  <string>  ?>  // true if (string) <var> equals <string>
 <?t24 :if <var> neq <string>  ?>  // true if (string) <var> not equals <string>
 <?t24 :if <var> ==  <integer> ?>  // true if <var> equals <integer>
 <?t24 :if <var> !=  <integer> ?>  // true if <var> not equals <integer>
 <?t24 :if <var> >   <integer> ?>  // true if <var> is greater than <integer>
 <?t24 :if <var> <   <integer> ?>  // true if <var> is lesser than <integer>
 <?t24 :if <var> >=  <integer> ?>  // true if <var> is greater or equal <integer>
 <?t24 :if <var> <=  <integer> ?>  // true if <var> is lesser or eaqual <integer>

see:

T24FunctionContainer::c_not(), T24FunctionContainer::c_else()

Parameters:

array	$parbuf
object T24TemplateTree	&$tree
integer	$idx

[ Top ]

method c_include

boolean c_include(
array
$parbuf, object T24TemplateTree
&$tree, integer
$idx)

Include another template.

 <?t24 :include <path>       [file]                          ?>
 <?t24 :include <methodname> string [<arg1> [<arg2> [...]]]  ?>

For string ressources, the name of the string will be composed of the method name and arguments, concatenated with a single space. This may be usefulf if you want to establish some caching mechanism.

 <?t24 :include getString string 23 ?>
 ---
 Name of included ressource now: "getString 23"

Parameters:

array	$parbuf
object T24TemplateTree	&$tree
integer	$idx

[ Top ]

method c_invoke

boolean c_invoke(
array
$parbuf, object T24TemplateTree
&$tree, integer
$idx)

Invoke a registered method.

 class test {
    function example($array) {
       return 'example: '.implode('+',$array);
    }
 }
 $class = new test;
 $template->setProperty('/register/method', array('example' => $class);
 ---
 <?t24 :invoke example arg1 arg2 arg3 ?>
 ---
 example: arg1+arg2+arg3

Method should return a string, otherwise the empty string will be inserted. You may use explicit type cast to ensure this.

Parameters:

array	$parbuf
object T24TemplateTree	&$tree
integer	$idx

[ Top ]

method c_not

boolean c_not(
array
$parbuf, object T24TemplateTree
&$tree, integer
$idx)

Test if a condition is false.

 <?t24 :not VAR == 1 ?>Hello World!<?t24 :end ?>

see:

T24FunctionContainer::c_if(), T24FunctionContainer::c_else()

Parameters:

array	$parbuf
object T24TemplateTree	&$tree
integer	$idx

[ Top ]

method c_repeat

boolean c_repeat(
array
$parbuf, object T24TemplateTree
&$tree, integer
$idx)

Define a block template.

The registered method should return an array of variable => value pairs. The loop will stop when the method returns null. The variables returned by the method are only visible inside the current block or subsequent blocks.

 class test {
    function test {
       $this->counter = 0;
    }
 
    function repeater() {
       if($this->counter == 3)
         return null;
       return array('COUNTER' => ++$this->counter);
    }
 }
 $class = new test;
 $template->setProperty('/register/method', array('repeater' => $class);
 ---
 <?t24 :repeat repeater ?>
 <?t24 COUNTER ?>
 <?t24 :end ?>
 ---
 1
 2
 3

Parameters:

array	$parbuf
object T24TemplateTree	&$tree
integer	$idx

[ Top ]

method c_set

boolean c_set(
array
$parbuf, object T24TemplateTree
&$tree, integer
$idx)

Assign a value to a variable.

 <?t24 :set scalar 1 ?>
 <?t24 :set array  1 2 3 4 ?>
 <?t24 :set string1 '1 2 "3" 4' ?>
 <?t24 :set string2 "1 2 '3' 4" ?>

Parameters:

array	$parbuf
object T24TemplateTree	&$tree
integer	$idx

[ Top ]

method destroy

boolean destroy(
)

Explicitly run garbage collection.

[ Top ]

method executeFunction

boolean executeFunction(
string
$name, array
$parbuf, object T24TemplateTree
&$tree, integer
$idx)

Execute a buildin function

Parameters:

string	$name
array	$parbuf
object T24TemplateTree	&$tree
integer	$idx

[ Top ]

method setParser

boolean setParser(
object T24Parser
&$parser)

Set parser this object belongs to.

Parameters:

object T24Parser

&$parser

[ Top ]

Class: T24FunctionContainer

Class Overview

Methods

Inherited Constants

Inherited Variables

Inherited Methods

Class: IsterObject

Class Details

Class Methods

constructor T24FunctionContainer

method c_else

method c_end

method c_if

method c_include

method c_invoke

method c_not

method c_repeat

method c_set

method destroy

method executeFunction

method setParser

	template
	[ doc home ] [ class tree: template ] [ index: template ] [ all elements ]