Docs For Class RawPHPEngine

Description

Habari RawPHPEngine class

Located in /system/classes/rawphpengine.php (line 12)

TemplateEngine
   |
   --RawPHPEngine

Direct descendents

Class	Description
HiEngine	Habari HiEngine class

Variable Summary

mixed $available_templates

mixed $engine_vars

mixed $template_map

mixed $var_stack

Method Summary

RawPHPEngine __construct ()

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

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

boolean assigned (string $key)

void display (template $template)

void fetch (string $template)

boolean template_exists (string $template)

void __get (key $key)

boolean __isset (key $key)

void __set (key $key, value $value)

void __unset (key $key)

Variables

mixed $available_templates = null (line 16)

access: protected

mixed $engine_vars = array() (line 15)

access: protected

mixed $template_map = array() (line 17)

access: protected

mixed $var_stack = array() (line 18)

access: protected

Inherited Variables

Inherited from TemplateEngine

TemplateEngine::$template_dir

Methods

Constructor __construct (line 25)

Constructor for RawPHPEngine

Sets up default values for required settings.

access: public

RawPHPEngine __construct ()

Redefinition of:

TemplateEngine::__construct()

Redefined in descendants as:

HiEngine::__construct() : Constructor for HiEngine

append (line 167)

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 144)

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 156)

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 (string $key)

string $key: name of variable

Redefinition of:

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

display (line 81)

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

Redefined in descendants as:

HiEngine::display() : A function which outputs the result of a transposed

fetch (line 129)

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 103)

Returns the existance of the specified template name

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

boolean template_exists (string $template)

string $template: Name of template to detect

Redefinition of:

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

__get (line 36)

Tries to retrieve a variable from the internal array engine_vars.

Method returns the value if succesful, returns false otherwise.

access: public

void __get (key $key)

key $key: name of variable

Redefinition of:

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

__isset (line 70)

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 (key $key)

key $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 48)

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

access: public

void __set (key $key, value $value)

key $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 58)

Unassigns a variable to the template engine.

access: public

void __unset (key $key)

key $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()