From f18ecd10c746641a9f46392f24d8d87ed60d2de6 Mon Sep 17 00:00:00 2001 From: Kevin Chabowski Date: Fri, 25 Oct 2013 22:26:24 +0200 Subject: Removed source code documentation. Can be generated at any point. --- docu/nd/index/Classes.html | 45 ------------------------ docu/nd/index/Constants.html | 37 -------------------- docu/nd/index/Files.html | 33 ------------------ docu/nd/index/Functions.html | 65 ----------------------------------- docu/nd/index/General.html | 81 -------------------------------------------- docu/nd/index/Variables.html | 49 --------------------------- 6 files changed, 310 deletions(-) delete mode 100644 docu/nd/index/Classes.html delete mode 100644 docu/nd/index/Constants.html delete mode 100644 docu/nd/index/Files.html delete mode 100644 docu/nd/index/Functions.html delete mode 100644 docu/nd/index/General.html delete mode 100644 docu/nd/index/Variables.html (limited to 'docu/nd/index') diff --git a/docu/nd/index/Classes.html b/docu/nd/index/Classes.html deleted file mode 100644 index 7b2f5e8..0000000 --- a/docu/nd/index/Classes.html +++ /dev/null @@ -1,45 +0,0 @@ - - -Class Index - - - - - - - - - -
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
- -
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.
- - - -
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.
- -
- - - - - - - - -
Close
- - - \ No newline at end of file diff --git a/docu/nd/index/Constants.html b/docu/nd/index/Constants.html deleted file mode 100644 index be1aa6c..0000000 --- a/docu/nd/index/Constants.html +++ /dev/null @@ -1,37 +0,0 @@ - - -Constant Index - - - - - - - - - -
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
- - - - - -
- - - - - - - - -
Close
- - - \ No newline at end of file diff --git a/docu/nd/index/Files.html b/docu/nd/index/Files.html deleted file mode 100644 index 5418d4b..0000000 --- a/docu/nd/index/Files.html +++ /dev/null @@ -1,33 +0,0 @@ - - -File Index - - - - - - - - - -
File 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
S
 stupid_template_engine.php
- -
The implementation of the Stupid Template Engine.
- -
- - - - - - - - -
Close
- - - \ No newline at end of file diff --git a/docu/nd/index/Functions.html b/docu/nd/index/Functions.html deleted file mode 100644 index 3bc9e21..0000000 --- a/docu/nd/index/Functions.html +++ /dev/null @@ -1,65 +0,0 @@ - - -Function Index - - - - - - - - - -
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)
- - - -
public function call_tag($name,
$params,
$sub)
Calling a custom tag (builtin ones can not be called)
- - - -
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 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 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.
- - - -
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 save($tpl,
$data,
$mode)
Saves a template.
public function set_var_by_name($name,
$val)
Set a template variable by its name.
- - - -
function transcompile($ast) /* Transcompile and add some boilerplate code. */
Transcompiles an abstract syntax tree to PHP.
- -
- - - - - - - - -
Close
- - - \ No newline at end of file diff --git a/docu/nd/index/General.html b/docu/nd/index/General.html deleted file mode 100644 index 73eecbb..0000000 --- a/docu/nd/index/General.html +++ /dev/null @@ -1,81 +0,0 @@ - - -Index - - - - - - - - - -
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)
- - - -
The order of the blocks (an array)
Associative array of blocks (see the language definition).
- - - -
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.
- - - -
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.
- - - -
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
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.
- - - -
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.
- - - -
function transcompile($ast) /* Transcompile and add some boilerplate code. */
Transcompiles an abstract syntax tree to PHP.
- - - -
Associative array of all template variables.
- -
- - - - - - - - -
Close
- - - \ No newline at end of file diff --git a/docu/nd/index/Variables.html b/docu/nd/index/Variables.html deleted file mode 100644 index ae3494b..0000000 --- a/docu/nd/index/Variables.html +++ /dev/null @@ -1,49 +0,0 @@ - - -Variable Index - - - - - - - - - -
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.
- -
- - - - - - - - -
Close
- - - \ No newline at end of file -- cgit v1.2.3-70-g09d2