From a8eea9562d9961fb9b55ccbf4b01cc9c8bc10e63 Mon Sep 17 00:00:00 2001 From: Kevin Chabowski Date: Wed, 29 Feb 2012 22:22:28 +0100 Subject: Forgot to include the new documentation. --- docu/nd/index/Classes.html | 14 +++++++++++--- docu/nd/index/Constants.html | 2 +- docu/nd/index/Functions.html | 2 +- docu/nd/index/General.html | 24 ++++++++++++------------ docu/nd/index/Variables.html | 12 ++++++++++-- 5 files changed, 35 insertions(+), 19 deletions(-) (limited to 'docu/nd/index') diff --git a/docu/nd/index/Classes.html b/docu/nd/index/Classes.html index e61de72..d2bee20 100644 --- a/docu/nd/index/Classes.html +++ b/docu/nd/index/Classes.html @@ -11,13 +11,21 @@ if (browserType) {document.write("
");if (browserV -
Class Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
F
 FilesystemStorageAccess
S
 ste
 STECore
 StorageAccess
+
Class Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
C
 CantLoadTemplate
 CantSaveTemplate
F
 FatalRuntimeError
 FilesystemStorageAccess
R
 RuntimeError
S
 ste
 STECore
 StorageAccess
-
The default StorageAccess implementation for loading / saving templates into a directory structure.
+
An exception that a StorageAccess implementation can throw, if it is unable to load a template.
An exception that a StorageAccess implementation can throw, if it is unable to save a template.
-
Everything in this file is in this namespace.
The Core of STE
An interface.
+
An Exception a tag can throw, if a fatal (irreparable) runtime error occurred.
The default StorageAccess implementation for loading / saving templates into a directory structure.
+ + + +
An Exception that a tag can throw, if a non-fatal runtime error occurred.
+ + + +
Everything in this file is in this namespace.
The Core of STE
An interface.
diff --git a/docu/nd/index/Constants.html b/docu/nd/index/Constants.html index 3e2d330..53106b3 100644 --- a/docu/nd/index/Constants.html +++ b/docu/nd/index/Constants.html @@ -11,7 +11,7 @@ if (browserType) {document.write("
");if (browserV -
Constant Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
M
 MODE_SOURCE, ste
 MODE_TRANSCOMPILED, ste
T
 Template modes, ste
+
Constant Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
M
 MODE_SOURCE, FatalRuntimeError
 MODE_TRANSCOMPILED, FatalRuntimeError
T
 Template modes, FatalRuntimeError
The Templates source
The transcompiled template
diff --git a/docu/nd/index/Functions.html b/docu/nd/index/Functions.html index 5a9cff5..5087083 100644 --- a/docu/nd/index/Functions.html +++ b/docu/nd/index/Functions.html @@ -11,7 +11,7 @@ if (browserType) {document.write("
");if (browserV -
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 __construct
FilesystemStorageAccessSTECore
C
 call_tag, STECore
E
 evalbool, STECore
 exectemplate, STECore
G
 get_var_by_name, STECore
 get_var_reference, STECore
L
 load
STECoreStorageAccess
P
 parse, ste
 precompile, ste
R
 register_tag, STECore
S
 save, StorageAccess
 set_var_by_name, STECore
T
 transcompile, ste
+
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 __construct
FilesystemStorageAccessSTECore
C
 call_tag, STECore
E
 evalbool, STECore
 exectemplate, STECore
G
 get_var_by_name, STECore
 get_var_reference, STECore
L
 load
STECoreStorageAccess
P
 parse, FatalRuntimeError
 precompile, FatalRuntimeError
R
 register_tag, STECore
S
 save, StorageAccess
 set_var_by_name, STECore
T
 transcompile, FatalRuntimeError
public function __construct($src,
$transc)
public function __construct($storage_access)
diff --git a/docu/nd/index/General.html b/docu/nd/index/General.html index 25c3cbb..626bc81 100644 --- a/docu/nd/index/General.html +++ b/docu/nd/index/General.html @@ -11,7 +11,7 @@ if (browserType) {document.write("
");if (browserV -
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 __construct
FilesystemStorageAccessSTECore
B
$blockorder, STECore
$blocks, STECore
C
 call_tag, STECore
 Constants, ste
E
 evalbool, STECore
 exectemplate, STECore
F
 FilesystemStorageAccess
 Functions
FilesystemStorageAccesssteSTECoreStorageAccess
G
 get_var_by_name, STECore
 get_var_reference, STECore
L
 License
 load
STECoreStorageAccess
M
 MODE_SOURCE, ste
 MODE_TRANSCOMPILED, ste
P
 parse, ste
 precompile, ste
 Public variables, STECore
R
 register_tag, STECore
S
 save, StorageAccess
 set_var_by_name, STECore
 ste
 STECore
 StorageAccess
 stupid_template_engine.php
T
 Template modes, ste
 transcompile, ste
V
 Variables, STECore
$vars, STECore
+
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 __construct
FilesystemStorageAccessSTECore
B
$blockorder, STECore
$blocks, STECore
C
 call_tag, STECore
 CantLoadTemplate
 CantSaveTemplate
 Constants, FatalRuntimeError
E
 evalbool, STECore
 exectemplate, STECore
F
$fatal_error_on_missing_tag, STECore
 FatalRuntimeError
 FilesystemStorageAccess
 Functions
FatalRuntimeErrorFilesystemStorageAccessSTECoreStorageAccess
G
 get_var_by_name, STECore
 get_var_reference, STECore
L
 License
 load
STECoreStorageAccess
M
 MODE_SOURCE, FatalRuntimeError
 MODE_TRANSCOMPILED, FatalRuntimeError
$mute_runtime_errors, STECore
P
 parse, FatalRuntimeError
 precompile, FatalRuntimeError
 Public variables, STECore
R
 register_tag, STECore
 RuntimeError
S
 save, StorageAccess
 set_var_by_name, STECore
 ste
 STECore
 StorageAccess
 stupid_template_engine.php
T
 Template modes, FatalRuntimeError
 transcompile, FatalRuntimeError
V
 Variables, STECore
$vars, STECore
public function __construct($src,
$transc)
public function __construct($storage_access)
@@ -21,47 +21,47 @@ if (browserType) {document.write("
");if (browserV -
public function call_tag($name,
$params,
$sub)
Calling a custom tag (builtin ones can not be called)
+
public function call_tag($name,
$params,
$sub)
Calling a custom tag (builtin ones can not be called)
An exception that a StorageAccess implementation can throw, if it is unable to load a template.
An exception that a StorageAccess implementation can throw, if it is unable to save a template.
-
public function evalbool($txt)
Test, if a text represents false (an empty / only whitespace text) or true (everything else).
public function exectemplate($tpl)
Executes a template and returns the result.
+
public function evalbool($txt)
Test, if a text represents false (an empty / only whitespace text) or true (everything else).
public function exectemplate($tpl)
Executes a template and returns the result.
-
The default StorageAccess implementation for loading / saving templates into a directory structure.
+
If True, STE will throw a FatalRuntimeError if a tag was called that was not registered, otherwise (default) a regular RuntimeError will be thrown and automatically handled by STE (see <$mute_runtime_errors>).
An Exception a tag can throw, if a fatal (irreparable) runtime error occurred.
The default StorageAccess implementation for loading / saving templates into a directory structure.
-
public function get_var_by_name($name)
Get a template variable by its name.
public function &get_var_reference($name,
$create_if_not_exist)
Get a reference to a template variable using a variable name.
+
public function get_var_by_name($name)
Get a template variable by its name.
public function &get_var_reference($name,
$create_if_not_exist)
Get a reference to a template variable using a variable name.
-
This file is licensed under the MIT/X11 License.
public function load($tpl,  
$quiet = False)
Load a template and return its result (blocks not included, use exectemplate for this).
public function load($tpl,
&$mode)
Loading a template.
+
This file is licensed under the MIT/X11 License.
public function load($tpl,  
$quiet = False)
Load a template and return its result (blocks not included, use exectemplate for this).
public function load($tpl,
&$mode)
Loading a template.
-
The Templates source
The transcompiled template
+
The Templates source
The transcompiled template
If True (default) a RuntimeError exception will result in no output from the tag, if False a error message will be written to output.
-
function parse($code,
$tpl)
Parsing a STE T/PL template.
function precompile($code)
Precompiling STE T/PL templates.
+
function parse($code,
$tpl)
Parsing a STE T/PL template.
function precompile($code)
Precompiling STE T/PL templates.
-
public function register_tag($name,
$callback)
Register a custom tag.
+
public function register_tag($name,
$callback)
Register a custom tag.
An Exception that a tag can throw, if a non-fatal runtime error occurred.
-
public function save($tpl,
$data,
$mode)
Saves a template.
public function set_var_by_name($name,
$val)
Set a template variable by its name.
Everything in this file is in this namespace.
The Core of STE
An interface.
The implementation of the Stupid Template Engine.
+
public function save($tpl,
$data,
$mode)
Saves a template.
public function set_var_by_name($name,
$val)
Set a template variable by its name.
Everything in this file is in this namespace.
The Core of STE
An interface.
The implementation of the Stupid Template Engine.
-
function transcompile($ast) /* Transcompile and add some boilerplate code. */
Transcompiles an abstract syntax tree to PHP.
+
function transcompile($ast) /* Transcompile and add some boilerplate code. */
Transcompiles an abstract syntax tree to PHP.
-
Associative array of all template variables.
+
Associative array of all template variables.
diff --git a/docu/nd/index/Variables.html b/docu/nd/index/Variables.html index 96ac427..115906e 100644 --- a/docu/nd/index/Variables.html +++ b/docu/nd/index/Variables.html @@ -11,17 +11,25 @@ if (browserType) {document.write("
");if (browserV -
Variable Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
B
$blockorder, STECore
$blocks, STECore
P
 Public variables, STECore
V
$vars, STECore
+
Variable Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
B
$blockorder, STECore
$blocks, STECore
F
$fatal_error_on_missing_tag, STECore
M
$mute_runtime_errors, STECore
P
 Public variables, STECore
V
$vars, STECore
The order of the blocks (an array)
Associative array of blocks (see the language definition).
+ +
If True, STE will throw a FatalRuntimeError if a tag was called that was not registered, otherwise (default) a regular RuntimeError will be thrown and automatically handled by STE (see <$mute_runtime_errors>).
+ + + +
If True (default) a RuntimeError exception will result in no output from the tag, if False a error message will be written to output.
+ + -
Associative array of all template variables.
+
Associative array of all template variables.
-- cgit v1.2.3-54-g00ecf