1
|
QuickSkin Methods:
|
2
|
|
3
|
QuickSkin::set( $property, $value )
|
4
|
Assigns content to a template property. Can be strings, no arrays.
|
5
|
(Please read the properties.txt document for examples).
|
6
|
|
7
|
QuickSkin::addtpl()
|
8
|
Loads a supplementary template to the main template. Primarily used for
|
9
|
advertising banners, right columns, login boxes or member menus, etc. All
|
10
|
functionality available to the main template is also available to the sub
|
11
|
template (variable substitution, etc.).
|
12
|
|
13
|
QuickSkin::assign()
|
14
|
Assigns content to a template placeholder or a list. Can be used on associative
|
15
|
arrays and scalars.
|
16
|
|
17
|
QuickSkin::append()
|
18
|
Appends content to a template placeholder. Can be used on associative arrays and
|
19
|
scalars.
|
20
|
|
21
|
QuickSkin::use_cache()
|
22
|
Activates the built in output cache. Checks if the executed script
|
23
|
(ref. $_SERVER[REQUEST URI]) has produced any output whithin a certain period of
|
24
|
time. If so, use_cache sends the cached page to the standard output (Browser) and
|
25
|
terminates any further script execution.
|
26
|
If no valid output is available, use_cache activates the PHP output buffer and returns
|
27
|
to the script form which it was called. During the following script execution, use_cache
|
28
|
captures all output that is send to the browser and stores it in a temporary cache file.
|
29
|
The filename of this cach file is a unique key that is created by modulating the current
|
30
|
script filename, its GET-parameters (REQUEST_URI) and the optional key parameter.
|
31
|
If any important logging is done by this script, this has to be done before use_cache
|
32
|
is called.
|
33
|
|
34
|
QuickSkin::result()
|
35
|
Parses template and returns result page (usually to a variable).
|
36
|
|
37
|
QuickSkin::output()
|
38
|
Parses template and sends to standard output (Browser).
|
39
|
|
40
|
QuickSkin::debug()
|
41
|
Activates the built in template debugger. Debug can be called instead of or in addition
|
42
|
to output. It prints a detailed list of all assigned variables and their content, the
|
43
|
compiled template and a the structured source template.
|
44
|
Debug can be very helpful for locating and removing errors in your template.
|
45
|
|
46
|
$contents = QuickSkin::getContents($param)
|
47
|
$param can be either a variable containing the contents, or a filename with full path.
|
48
|
Does some basic substitutions in advance of the class parsing the template and contents.
|
49
|
|