Public Member Functions | |
| getResponseProxy () | |
| get ($name) | |
| set ($name, $value) | |
| setA (array $values) | |
| reset () | |
| fetch (array $prm=array()) | |
| render ($prm) | |
| __toString () | |
| __get ($name) | |
| __set ($name, $val) | |
| getAttr ($name) | |
| setAttr ($name, $value) | |
| getCfg () | |
Protected Member Functions | |
| afterInit () | |
| _fetch ($file) | |
| findTpl (array $prm, array $name) | |
| beforeInit () | |
Protected Attributes | |
| $vars = array() | |
| $responseProxy | |
| $cfg | |
Detailed Description
Template
Definition at line 10 of file tpl.class.php.
Member Function Documentation
◆ __get()
| __get | ( | $name | ) |
Get a variable, with a convenient way $tpl->name
- Parameters
-
string $name Name to set
- Returns
- mixed|null The value or null if not existing
- See also
- get
Definition at line 219 of file tpl.class.php.
◆ __set()
| __set | ( | $name, | |
| $val | |||
| ) |
Set a variable, with a convenient way $tpl->name = $value
- Parameters
-
string $name Name to set mixed $value Value to set
- See also
- set
Definition at line 230 of file tpl.class.php.
◆ __toString()
| __toString | ( | ) |
◆ _fetch()
|
protected |
Make really the fetch
- Parameters
-
string $file Template file path
- Returns
- string Content fetched
Definition at line 155 of file tpl.class.php.
◆ afterInit()
|
protected |
Definition at line 26 of file tpl.class.php.
◆ beforeInit()
|
protectedinherited |
Call just before the configuration initialisation
Definition at line 35 of file object.class.php.
◆ fetch()
| fetch | ( | array | $prm = array() | ) |
Fetch the template
- Parameters
-
array $prm Array parameter for retrieve the tpl file (exemple: used to force the tpl extension via tplExt) return string The result fetched
- See also
- file::nyroExists
Definition at line 83 of file tpl.class.php.
◆ findTpl()
|
protected |
Find the template file
- Parameters
-
array $prm Parameter used in file::nyroExists array $name Template name
- Returns
- string|null The first template file path found or null
Definition at line 172 of file tpl.class.php.
◆ get()
| get | ( | $name | ) |
Get a variable value for the fetch
- Parameters
-
string $name Variable name
- Returns
- mixed|null The value or null if not existing
Definition at line 45 of file tpl.class.php.
◆ getAttr()
|
inherited |
Get an attribute
- Parameters
-
string $name Attribute name
- Returns
- mixed|null The attribute or null if not set
Definition at line 48 of file object.class.php.
◆ getCfg()
|
inherited |
◆ getResponseProxy()
| getResponseProxy | ( | ) |
Get the response proxy used in this tpl
- Returns
- response_proxy
Definition at line 35 of file tpl.class.php.
◆ render()
| render | ( | $prm | ) |
Render an other tpl. To be used inside the tpl
- Parameters
-
array $prm Possibile keys: - string module Module to used (default: module used for the current tpl)
- string action Action to call
- other parameters must be used for the call to the module_abstract::exec method or module_abstract::publish
Definition at line 188 of file tpl.class.php.
◆ reset()
| reset | ( | ) |
Clear all the variables
Definition at line 72 of file tpl.class.php.
◆ set()
| set | ( | $name, | |
| $value | |||
| ) |
Set a variable for the fecth
- Parameters
-
string $name Variable name mixed $value The value
Definition at line 55 of file tpl.class.php.
◆ setA()
| setA | ( | array | $values | ) |
Set multiple variables using an array
- Parameters
-
array $values The values
- See also
- set
Definition at line 65 of file tpl.class.php.
◆ setAttr()
|
inherited |
Set an attribute
- Parameters
-
string $name Attribute name mixed $value Attribute value
Definition at line 58 of file object.class.php.
Field Documentation
◆ $cfg
|
protectedinherited |
Definition at line 17 of file object.class.php.
◆ $responseProxy
|
protected |
Definition at line 24 of file tpl.class.php.
◆ $vars
|
protected |
Definition at line 17 of file tpl.class.php.
The documentation for this class was generated from the following file:
