forked from wanze/TemplateEngineFactory
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TemplateEngineChunk.php
154 lines (130 loc) · 4 KB
/
TemplateEngineChunk.php
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php
/**
* Class TemplateEngineChunk
*
* Wrapper around ProcessWire's TemplateFile class to create "chunks". A chunk represents a small chunk of PHP logic
* associated with a template (view) to render its output. The view is rendered with the current active template engine.
*
* Example:
*
* Chunk-File: /site/templates/chunks/my-chunk.php
* Template-File (view): /site/templates/views/chunks/my-chunk.tpl
*
* Note that the path to the template file depends on the storage location of the active template engine.
*
*
* @author Stefan Wanzenried <[email protected]>
* @license http://www.gnu.org/licenses/gpl-2.0.txt GNU General Public License, version 2
*/
class TemplateEngineChunk extends WireData
{
/**
* @var TemplateEngine
*/
protected $view;
/**
* @var string
*/
protected $chunk_file;
/**
* @var
*/
protected $template_file;
/**
* @param string $chunk_file Path to the chunk file to load, relative to site/templates/ without suffix
* @param string $template_file Path to the corresponding template file (view) relative to the path where the engine stores its templates
* @throws WireException
*/
public function __construct($chunk_file, $template_file = '')
{
$this->setChunkFile($chunk_file);
$this->setTemplateFile($template_file);
}
/**
* Set a value
*
* @param string $key
* @param mixed $value
* @return $this
*
*/
public function set($key, $value)
{
switch ($key) {
case 'chunkFile':
return $this->setChunkFile($value);
case 'templateFile':
return $this->setTemplateFile($value);
}
return parent::set($key, $value);
}
/**
* @return mixed|string
*/
public function render()
{
if (!$this->view) {
return '';
}
$factory = $this->modules->get('TemplateEngineFactory');
$api_var = $factory->get('api_var');
// Temporarily store old $view global
$_view = $this->wire($api_var);
// Assign the template for this chunk to the global $view variable
$this->wire($api_var, $this->view);
$chunk = $this->getChunk();
// Process logic of chunk
$chunk->render();
$out = $this->view->render();
// Restore previous global
$this->wire($factory->get('api_var'), $_view);
return $out;
}
/**
* @param string $chunk_file The chunk file to load, relative to site/templates/ without suffix
* @throws WireException
* @return $this
*/
public function setChunkFile($chunk_file)
{
if (!is_file($this->getChunkPath($chunk_file))) {
throw new WireException("Chunk file does not exist: '{$chunk_file}'");
}
$this->chunk_file = $chunk_file;
return $this;
}
/**
* @param string $template_file The template file (view) that should be used to render this chunk
* @throws WireException
* @return $this
*/
public function setTemplateFile($template_file)
{
$template_file = ($template_file) ? $template_file : $this->chunk_file;
$this->template_file = $template_file;
$this->view = $this->wire('factory')->load($template_file);
if ($this->view === null) {
throw new WireException("View for chunk {$this->chunk_file} does not exist");
}
return $this;
}
/**
* Create the chunk file aka TemplateFile object
*
* @return TemplateFile
*/
protected function ___getChunk()
{
$chunk = new TemplateFile($this->getChunkPath($this->chunk_file));
$chunk->setArray($this->getArray());
return $chunk;
}
/**
* @param string $chunk_file
* @return string
*/
protected function getChunkPath($chunk_file)
{
return $this->wire('config')->paths->templates . $chunk_file . '.' . $this->wire('config')->templateExtension;
}
}