Docs For Class n2f_template

Description

N2F Dynamic Template Extension (for use with the n2f_template class)

Located in /system/extensions/tpl.dynamic.ext.php (line 52)

n2f_events
   |
   --n2f_template_dynamic

Class Constant Summary

flag_alias_exempt = 4

flag_cache_exempt = 2

flag_render_exempt = 1

Method Summary

static boolean addAlias (string $text, string $file, string $module, [string $base = null], [string $skin = null])

static null addGlobalAlias (string $text, string $file, string $module)

static boolean handle_addField (n2f_template $tpl, string $key, mixed $val)

static array handle_addFields (n2f_template $tpl, array $fields)

static mixed handle_fetch (n2f_template $tpl, $fields)

static boolean handle_render (n2f_template $tpl)

static boolean isAlias (n2f_template &$tpl, string $al_text, n2f_template $tpl)

static null setFlags (n2f_template &$tpl, [integer $flags = null], n2f_template $tpl)

Variables

Inherited Variables

Inherited from n2f_events

n2f_events::$events

Methods

static method addAlias (line 283)

Add an alias globally for dynamic templates.

access: public

static boolean addAlias (string $text, string $file, string $module, [string $base = null], [string $skin = null])

string $text: Text the system will use to recognize the alias (<%$text%>)
string $file: File the alias refers to
string $module: Module the alias file resides in
string $base: Base the alias module resides in
string $skin: Skin the file resides in

static method addGlobalAlias (line 331)

Add a 'global' alias for dynamic templates that expects a specific skin module/file.

access: public

static null addGlobalAlias (string $text, string $file, string $module)

string $text: Text the system will use to recognize the alias (<%$text%>)
string $file: File the alias refers to
string $module: Module the alias file resides in

static method handle_addField (line 77)

Handle N2F_TPLEVT_ADD_FIELD event from n2f_template class.

access: public

static boolean handle_addField (n2f_template $tpl, string $key, mixed $val)

n2f_template $tpl: The object calling this method.
string $key: The key of the field being added.
mixed $val: The value of the field being added.

static method handle_addFields (line 93)

Handle N2F_TPLEVT_ADD_FIELDS event from n2f_template class.

access: public

static array handle_addFields (n2f_template $tpl, array $fields)

n2f_template $tpl: The object calling this method.
array $fields: The array of fields being set.

static method handle_fetch (line 248)

Handle N2F_TPLEVT_FETCH

access: public

static mixed handle_fetch (n2f_template $tpl, $fields)

n2f_template $tpl
array $fields

static method handle_render (line 108)

Handle N2F_TPLEVT_RENDER event from n2f_template class.

access: public

static boolean handle_render (n2f_template $tpl)

n2f_template $tpl: The object calling this method.

static method isAlias (line 387)

Sets a n2f_template object to have 'alias' status to prevent infinite recursion.

access: public

static boolean isAlias (n2f_template &$tpl, string $al_text, n2f_template $tpl)

n2f_template $tpl: Current n2f_template object being modified
string $al_text: Text registered with system to recognize alias
n2f_template &$tpl

static method setFlags (line 360)

Sets flag(s) on an active template object to alter the template object's behavior.

access: public

static null setFlags (n2f_template &$tpl, [integer $flags = null], n2f_template $tpl)

n2f_template $tpl: Current n2f_template object being modified
integer $flags: Flag(s) being set on template
n2f_template &$tpl

Inherited Methods

Inherited From n2f_events

n2f_events::__construct()
n2f_events::addEvent()
n2f_events::hitEvent()
n2f_events::hookEvent()

Class Constants

flag_alias_exempt = 4 (line 67)

Flag to keep aliases from being found on a particular node.

flag_cache_exempt = 2 (line 62)

Flag to set a node as exempt from being cached.

flag_render_exempt = 1 (line 57)

Flag to set a node as exempt from the full render process

Class n2f_template_dynamic

Inherited Variables

Inherited Methods