Class: T24Parser

Source Location: /T24Parser.php

Class Overview

IsterObject
   |
   --IsterParser
      |
      --T24Parser

This class represents a parser for the T24 template language.

Author(s): Ingo Schramm

Methods

Inherited Constants

Inherited Variables

Inherited Methods

Class: IsterParser

IsterParser::IsterParser(): Constructor

Class: IsterObject

IsterObject::IsterObject(): Constructor
IsterObject::abstractMethodError(): Report attempt to call an abstract method.
IsterObject::addLogger(): Add an IsterLogger to process log messages.
IsterObject::deleteLogger(): Delete an already registered IsterLogger.
IsterObject::getLoggerNames(): Fetch the names of all currently registered IsterLoggers.
IsterObject::getMem(): Return maximum amount of memory an application has allocated at this point.
IsterObject::log(): Trigger a log message.
IsterObject::passPHPmessage(): Catch PHP E_WARNING and E_NOTICE messages.
IsterObject::serialize(): Serialize the object.
IsterObject::setLogLocal(): Set logging local for the current object.
IsterObject::setupLogger(): Setup a logger.
IsterObject::triggerError(): Alias for log();
IsterObject::unserialize(): Unserialize the object.
IsterObject::__sleep(): Executed prior to serialize().
IsterObject::__wakeup(): Executed prior to unserialize().

Class Details

This class represents a parser for the T24 template language.

For a description of buildin functions see T24FunctionContainer.

 <html>
 <head>
 <title><?t24 TITLE ?></title>
 </head>
 <body>
 <h1><?t24 TITLE ?></h1>
 </body>
 </html>
 ---
 require_once('IsterTemplate.php');
 require_once('IsterTemplateFactory.php');
 
 $t = new IsterTemplate( new IsterTemplateFactory );
 $t->setLanguage('t24');
 $t->setProperty('/template', array('TITLE', 'Test Template');
 $t->parse('file.tmpl');
 print $t->toString();
 ---
 <html>
 <head>
 <title>Test Template</title>
 </head>
 <body>
 <h1>Test Template</h1>
 </body>
 </html>

copyright:	Copyright (c) 2005 Ister.ORG Ingo Schramm
author:	Ingo Schramm
see:	T24FunctionContainer

[ Top ]

Class Methods

constructor T24Parser

T24Parser T24Parser(
[object T24FunctionContainer
$level = 0])

Constructor

Parameters:

object T24FunctionContainer

$level

[ Top ]

method destroy

boolean destroy(
)

Explicitly run garbage collection.

[ Top ]

method getChild

object T24Parser &getChild(
array
$set)

Get a child parser of this parser object.

Will return an object without any source but with all properties cloned. The parent name of child is set to the name of the cloning parser.

Parameters:

array

$set

variable value pairs to define for the new parser

[ Top ]

method getIncluded

array getIncluded(
)

Get array of all properties set with parserSetProperty().

[ Top ]

method getName

string getName(
)

Get the name of the current source.

[ Top ]

method getParseResult

array getParseResult(
)

Get the result of the parser run before execution of the result.

Useful for caching.

[ Top ]

method getProperties

array getProperties(
)

Get array with names of included sources.

see:

T24IncludeTree::getIncluded()

[ Top ]

method parseFile

boolean parseFile(
string
$source)

Parse the given source.

Parameters:

string

$source

[ Top ]

method parserSetProperty

boolean parserSetProperty(
string
$path, array
$array)

Set properties of the parser.

Recognized paths:

 // pass array of variables and values to fill the template
  '/template', array('var1' => $val1,
                    'var2  => $val2,
                     [...]
                    )
 
 // setup the parser
 '/parser', array('include_path',       '.',     //include path of template files
                  'function_separator', ':',     //identify buildin functions
                  'tag_open',           '<?t24', //open a template tag
                  'tag_close',          '?>'     //close a template tag
                  'comment_open',       '<!--',  //for commenting unregistered
                  'comment_close',      '-->',   //for commenting unregistered
                  'policy_unregistered',t24SKIP  //how to treat unregistered vars
                  )
 // register callback methods
 '/register/method', array('method' => &$object)
 '/register/alias',  array('method' => 'alias')

Possible values for 'policy_unregistered':

t24WARN - trigger a warning
t24SKIP - skip silently
t24KEEP - keep the variable as written in template
t24COMMENT - comment the variable out using 'comment_open' and 'comment_close'

Note: A callback method will receive one single array of parameters.

Parameters:

string	$path
array	$array

[ Top ]

method parseString

boolean parseString(
string
$source, [string
$name = ''])

Parse the given source.

Parameters:

string	$source
string	$name

[ Top ]

method setContainer

boolean setContainer(
object T24FunctionContainer
&$fcontainer, object T24IncludeTree
&$inctree)

Set required objects to initialize this.

Parameters:

object T24FunctionContainer	&$fcontainer
object T24IncludeTree	&$inctree

[ Top ]

method setParent

boolean setParent(
string
$parent)

Set the name of the parent for cild parsers.

Parameters:

string

$parent

[ Top ]

method setParseResult

boolean setParseResult(
array
$result)

Set the result of a previous parser run as the current result.

Useful for caching.

Parameters:

array

$result

[ Top ]

method toString

string toString(
)

Return the string representation of the current state of the template.

[ Top ]

Documentation generated on Tue, 20 Dec 2005 11:22:04 +0100 by phpDocumentor 1.3.0RC4

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