blob: 81f7439578a8dd1e0883c623215e61f6eafb7cb0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
<?php
// File: StorageAccess.php
// Namespace: kch42\ste
namespace kch42\ste;
/*
* Class: StorageAccess
* An interface.
* A StorageAccess implementation is used to access the templates from any storage.
* This means, that you are not limited to store the Templates inside directories, you can also use a database or something else.
*/
interface StorageAccess {
/*
* Constants: Template modes
*
* MODE_SOURCE - The Templates source
* MODE_TRANSCOMPILED - The transcompiled template
*/
const MODE_SOURCE = 0;
const MODE_TRANSCOMPILED = 1;
/*
* Function: load
* Loading a template.
*
* Parameters:
* $tpl - The name of the template.
* &$mode - Which mode is preferred? One of the <Template modes>.
* If <MODE_SOURCE>, the raw sourcecode is expected, if <MODE_TRANSCOMPILED> the transcompiled template *as a callable function* (expecting an <STECore> instance as first parameter) is expected.
* If the transcompiled version is not available or older than the source, you can set this parameter to <MODE_SOURCE> and return the source.
*
* Throws:
* A <CantLoadTemplate> exception if the template could not be loaded.
*
* Returns:
* Either the sourcecode or a callable function (first, and only parameter: an <STECore> instance).
*/
public function load($tpl, &$mode);
/*
* Function: save
* Saves a template.
*
* Throws:
* A <CantSaveTemplate> exception if the template could not be saved.
*
* Parameters:
* $tpl -The name of the template.
* $data - The data to be saved.
* $mode - A <Template mode> constant.
*/
public function save($tpl, $data, $mode);
}
|
