Orion PHP  0.11.12
The PHP5.3 framework
Orion\Core\Renderer\Base Interface Reference

List of all members.

Public Member Functions

 __construct ()
 assign ($key, $value, $nocache)
 clearCache ($template, $cache_id)
 isCached ($template, $cache_id, $compile_id)
 render ($file, $cache_id, $compile_id)
 renderView ($file, $master, $cache_id, $compile_id)
 addJS ($rawjs)
 includeJS ($jsfile)
 includeCSS ($cssfile)

Detailed Description

Orion Renderer base interface.

If your template engine does not support one of those methods, you still have to define them. Just put the default return value inside them for compatibility.

Author:
Thibaut Despoulain BSD 4-clauses
Version:
0.11.12

Definition at line 18 of file base.php.


Constructor & Destructor Documentation

Orion\Core\Renderer\Base::__construct ( )

Member Function Documentation

Orion\Core\Renderer\Base::addJS ( rawjs)

Adds raw javascript script to template

Parameters:
String$rawjs
Orion\Core\Renderer\Base::assign ( key,
value,
nocache 
)

assigns a template variable.

Parameters:
array | string$blockthe template variable name(s)
mixed$valuethe value to assign
boolean$nocacheif true any output of this variable will be not cached
Orion\Core\Renderer\Base::clearCache ( template,
cache_id 
)

Clears a template cache file

Parameters:
String$fileTemplate path
String$cache_idThe caching identifier (if supported by renderer)
String$compile_idThe compile identifier (if supported by renderer)
Orion\Core\Renderer\Base::includeCSS ( cssfile)

Includes a CSS file

Parameters:
String$cssfileCSS file path
Orion\Core\Renderer\Base::includeJS ( jsfile)

Includes a javascript file

Parameters:
String$jsfileJavascript file path
Orion\Core\Renderer\Base::isCached ( template,
cache_id,
compile_id 
)

Checks if a template file is cached

Parameters:
String$fileTemplate path
String$cache_idThe caching identifier (if supported by renderer)
String$compile_idThe compile identifier (if supported by renderer)
Returns:
Boolean Default=FALSE
Orion\Core\Renderer\Base::render ( file,
cache_id,
compile_id 
)

Render a single template file

Parameters:
String$fileTemplate path
String$cache_idThe caching identifier (if supported by renderer)
String$compile_idThe compile identifier (if supported by renderer)
Orion\Core\Renderer\Base::renderView ( file,
master,
cache_id,
compile_id 
)

Render a view file, extending a master template

Parameters:
String$fileView template path
String$masterMaster template path (if supported by renderer)
String$cache_idThe caching identifier (if supported by renderer)
String$compile_idThe compile identifier (if supported by renderer)

The documentation for this interface was generated from the following file: