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

Class: IsterTemplate

Source Location: /IsterTemplate.php

Class Overview

IsterObject
   |
   --IsterTemplate

This class represents a Template.


Author(s): Ingo Schramm   

Copyright: Copyright (c) 2005 Ister.ORG Ingo Schramm

Methods


Inherited Constants

Inherited Variables

Inherited Methods

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 Template.

Facade


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


[ Top ]


Class Methods


constructor IsterTemplate

object IsterTemplate( object IsterTemplateFactory $factory)

Constructor

Parameters:

object IsterTemplateFactory   $factory  

[ Top ]

method getIncluded

array getIncluded( )

[ Top ]

method getParser

object IsterParser &getParser( )

Fetch the current parser object by reference.

If no parser is present a new one will be created with the current language.


[ Top ]

method getParseResult

mixed getParseResult( )

Get the result of a previous parser run.

Useful for caching. The format is dependant of the currently used parser.


[ Top ]

method parse

boolean parse( [string $source = null], [integer $type = null], [string $name = null])

Parse the source using the current parser.

If no parser is present a new one will be created with the current language. If a source, type and/or name is specified, the settings given with setSource will be overwritten.


Parameters:

string   $source  
integer   $type  
string   $name  

[ Top ]

method setLanguage

boolean setLanguage( mixed $lang)

Set the template language.

[ Top ]

method setParser

boolean setParser( object IsterParser $parser)

Set the current parser object by reference.

Parameters:

object IsterParser   $parser  

[ Top ]

method setParseResult

boolean setParseResult( mixed $result)

Set the result of a previous parser run.

Useful for caching. The format is dependant of the currently used parser.


Parameters:

mixed   $result  

[ Top ]

method setProperty

boolean setProperty( path $path, array $array)

Set a property of the template.

Parameters:

path   $path  
array   $array  

[ Top ]

method setSource

boolean setSource( string $source, [integer $type = ISTER_TEMPLATE_FILE], [string $name = null])

Set the template's source.

Parameters:

string   $source  
integer   $type  
string   $name  

[ Top ]

method toString

string toString( )

Return a string representation of the template.

If called after parse() this will usually return the resulting document. The method will also destroy the parser object.


[ Top ]


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