Docs For Class SmartyEngine

Class SmartyEngine

Description

Habari TemplateEngine abstract base class

Located in /system/classes/smartyengine.php (line 15)

TemplateEngine
   |
   --SmartyEngine

Method Summary

SmartyEngine __construct ()

void append (key $key, [value $value = ''])

void assign (key $key, [value $value = ''])

boolean assigned ( $name, string $key)

void display (template $template)

void fetch (string $template)

boolean template_exists (template $template)

void __get (name $key)

boolean __isset (string $key)

void __set (name $key, value $value)

void __unset (name $key)

Variables

Inherited Variables

Inherited from TemplateEngine

TemplateEngine::$template_dir

Methods

Constructor __construct (line 25)

Constructor for SmartyEngine

Sets up default values for required settings.

access: public

SmartyEngine __construct ()

Redefinition of:

TemplateEngine::__construct()

append (line 182)

Appends to an existing variable more values

access: public

void append (key $key, [value $value = ''])

key $key: name of variable
value $value: value of variable

Redefinition of:

TemplateEngine::append(): Appends to an existing variable more values

assign (line 154)

Assigns a variable to the template engine for use in constructing the template's output.

access: public

void assign (key $key, [value $value = ''])

key $key: name( s ) of variable
value $value: value of variable

Redefinition of:

TemplateEngine::assign(): Assigns a variable to the template engine for use in constructing the template's output.

assigned (line 171)

Detects if a variable is assigned to the template engine for use in constructing the template's output.

return: true if key is set, false if not set
access: public

boolean assigned ( $name, string $key)

string $key: name of variable
$name

Redefinition of:

TemplateEngine::assigned(): Detects if a variable is assigned to the template engine for use in constructing the template's output.

display (line 88)

A function which outputs the result of a transposed template to the output stream

access: public

void display (template $template)

template $template: Name of template to display

Redefinition of:

TemplateEngine::display(): A function which outputs the result of a transposed template to the output stream

fetch (line 140)

A function which returns the content of the transposed template as a string

access: public

void fetch (string $template)

string $template: Name of template to fetch

Redefinition of:

TemplateEngine::fetch(): A function which returns the content of the transposed template as a string

template_exists (line 114)

Returns the existance of the specified template name

return: True if the template exists, false if not
access: public

boolean template_exists (template $template)

template $template: Name of template to detect

Redefinition of:

TemplateEngine::template_exists(): Returns the existance of the specified template name

__get (line 43)

Tries to retrieve a variable from the internal array engine_vars.

Method returns the value if succesful, returns false otherwise.

access: public

void __get (name $key)

name $key: name of variable

Redefinition of:

TemplateEngine::__get(): Tries to retrieve a variable from the internal array engine_vars.

__isset (line 77)

Detects if a variable is assigned to the template engine for use in constructing the template's output.

return: true if name is set, false if not set
access: public

boolean __isset (string $key)

string $key: name of variable

Redefinition of:

TemplateEngine::__isset(): Detects if a variable is assigned to the template engine for use in constructing the template's output.

__set (line 55)

Assigns a variable to the template engine for use in constructing the template's output.

access: public

void __set (name $key, value $value)

name $key: name of variable
value $value: value of variable

Redefinition of:

TemplateEngine::__set(): Assigns a variable to the template engine for use in constructing the template's output.

__unset (line 65)

Unassigns a variable to the template engine.

access: public

void __unset (name $key)

name $key: name of variable

Redefinition of:

TemplateEngine::__unset(): Unassigns a variable to the template engine.

Inherited Methods

Inherited From TemplateEngine

TemplateEngine::__construct()
TemplateEngine::append()
TemplateEngine::assign()
TemplateEngine::assigned()
TemplateEngine::display()
TemplateEngine::fetch()
TemplateEngine::set_template_dir()
TemplateEngine::template_exists()
TemplateEngine::__get()
TemplateEngine::__isset()
TemplateEngine::__set()
TemplateEngine::__unset()

Documentation generated on Thu, 30 Oct 2008 20:31:27 +0100 by phpDocumentor 1.3.2