Docs For Class KTemplateAbstract

KTemplateAbstract __construct(

$config)

Constructor

Prevent creating instances of this class by making the contructor private

Tags:

access:

public

Overridden in child classes as:

ComDefaultTemplateAbstract::__construct(): Constructor

Overrides KObject::__construct() (Constructor)

Parameters:

object An

$config

optional KConfig object with configuration options

[ Top ]

KTemplate addFilter(
array
$filters)

Adds one or more filters for template transformation

Tags:

access:

public

Parameters:

array

$filters

Array of one or more behaviors to add.

[ Top ]

mixed findFile(
string
$file)

Searches for the file

Tags:

return:	The full path and file name for the target file, or FALSE if the file is not found
access:	public

Overridden in child classes as:

ComDefaultTemplateAbstract::findFile(): Searches for the file

Parameters:

string

$file

The file path to look for.

[ Top ]

mixed getData(
)

Get the template data

Tags:

access:

public

[ Top ]

KTemplateFilterInterface getFilter(

$filter)

Get a filter by identifier

Tags:

access:

public

Parameters:

$filter

[ Top ]

KTemplateHelperInterface getHelper(
mixed
$helper, [array
$config = array()])

Get a template helper

Tags:

access:

public

Parameters:

mixed	$helper	KServiceIdentifierInterface
array	$config	An optional associative array of configuration settings

[ Top ]

string getPath(
)

Get the template path

Tags:

access:

public

[ Top ]

KTemplateStack getStack(
)

Get the template object stack

Tags:

access:

public

[ Top ]

KViewAbstract getView(
)

Get the view object attached to the template

Tags:

access:

public

[ Top ]

bool handleError(

$code, 
$message, [
$file = ''], [
$line = 0], [
$context = array()])

Handle template errors

Tags:

access:

public

Parameters:

	$code
	$message
	$file
	$line
	$context

[ Top ]

boolean hasFilter(
string
$filter)

Check if a filter exists

Tags:

return:	TRUE if the filter exists, FALSE otherwise
access:	public

Parameters:

string

$filter

The name of the filter

[ Top ]

KTemplateAbstract loadFile(
string
$file, [array
$data = array()], [boolean
$process = true])

Load a template by path

Tags:

access:

public

Overridden in child classes as:

ComDefaultTemplateAbstract::loadFile(): Load a template by path -- first look in the templates folder for an override

Parameters:

string	$file	The template path
array	$data	An associative array of data to be extracted in local template scope
boolean	$process	If TRUE process the data using a tmpl stream. Default TRUE.

[ Top ]

KTemplateAbstract loadIdentifier(
string
$template, [array
$data = array()], [boolean
$process = true])

Load a template by identifier

This functions only accepts full identifiers of the format

com:[//application/]component.view.[.path].name

Tags:

access:

public

Parameters:

string	$template	The template identifier
array	$data	An associative array of data to be extracted in local template scope
boolean	$process	If TRUE process the data using a tmpl stream. Default TRUE.

[ Top ]

KTemplateAbstract loadString(
string
$string, [array
$data = array()], [boolean
$process = true])

Load a template from a string

Tags:

access:

public

Parameters:

string	$string	The template contents
array	$data	An associative array of data to be extracted in local template scope
boolean	$process	If TRUE process the data using a tmpl stream. Default TRUE.

[ Top ]

string parse(
)

Parse the template

This function passes the template throught read filter chain and returns the result.

Tags:

return:	The parsed data
access:	public

Overridden in child classes as:

ComDefaultTemplateAbstract::parse(): Parse the template

[ Top ]

string render(
)

Render the template

This function passes the template throught write filter chain and returns the result.

Tags:

return:	The rendered data
access:	public

[ Top ]

string renderHelper(
string
$identifier, [array
$config = array()])

Load a template helper

This functions accepts a partial identifier, in the form of helper.function. If a partial identifier is passed a full identifier will be created using the template identifier.

Tags:

return:	Helper output
access:	public

Parameters:

string	$identifier	Name of the helper, dot separated including the helper function to call
array	$config	An optional associative array of configuration settings

[ Top ]

KControllerAbstract setView(
mixed
$view)

Method to set a view object attached to the controller

Tags:

throws:	KDatabaseRowsetException If the identifier is not a view identifier
access:	public

Parameters:

mixed

$view

An object that implements KObjectServiceable, KServiceIdentifier object or valid identifier string

[ Top ]

void _initialize(

$config)

Initializes the options for the object

Called from __construct() as a first step of object instantiation.

Tags:

access:

protected

Overrides KObject::_initialize() (Initializes the options for the object)

Parameters:

object An

$config

optional KConfig object with configuration options.

[ Top ]

bool __destroy(
)

Destructor

Hanlde sandbox shutdown. Clean all output buffers and display the latest error if an error is found.

Tags:

access:

public

[ Top ]

KTemplateAbstract __sandbox(
boolean
0)

Process the template using a simple sandbox

This function passes the template through the read filter chain before letting the PHP parser executed it. The result is buffered.

Tags:

access:

private

Parameters:

boolean

0

If TRUE apply write filters. Default FALSE.

[ Top ]

string __toString(
)

Renders the template and returns the result

Tags:

access:

public

[ Top ]

Class: KTemplateAbstract

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Class: KObject

Inherited Methods

Class: KObject

Class Details

Tags:

Class Variables

static $_errors = array( 1 => 'Fatal Error', 2 => 'Warning', 4 => 'Parse Error', 8 => 'Notice', 64 => 'Compile Error', 256 => 'User Error', 512 => 'User Warning', 2048 => 'Strict', 4096 => 'Recoverable Error' )

Tags:

$_contents = ''

Tags:

$_data = array()

Tags:

$_filters = array()

Tags:

$_path =

Tags:

$_stack =

Tags:

$_view =

Tags:

Class Methods

constructor __construct [line 84]

Tags:

Parameters:

method addFilter [line 357]

Tags:

Parameters:

method findFile [line 413]

Tags:

Parameters:

method getData [line 163]

Tags:

method getFilter [line 382]

Tags:

Parameters:

method getHelper [line 471]

Tags:

Parameters:

method getPath [line 153]

Tags:

method getStack [line 173]

Tags:

method getView [line 183]

Tags:

method handleError [line 498]

Tags:

Parameters:

method hasFilter [line 346]

Tags:

Parameters:

method loadFile [line 267]

Tags:

Parameters:

method loadIdentifier [line 241]

Tags:

Parameters:

method loadString [line 289]

Tags:

Parameters:

method parse [line 330]

Tags:

method render [line 312]

Tags:

method renderHelper [line 448]

Tags:

Parameters:

method setView [line 206]

Tags:

Parameters:

method _initialize [line 135]

Tags:

Parameters:

method __destroy [line 112]

static $_errors = array(
1 => 'Fatal Error',
2 => 'Warning',
4 => 'Parse Error',
8 => 'Notice',
64 => 'Compile Error',
256 => 'User Error',
512 => 'User Warning',
2048 => 'Strict',
4096 => 'Recoverable Error'
)