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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2021 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
/**
* Class for rendering partial-views, which are useful for reusing the same partial-views or updating specific parts of
* the page asynchronously, i.e., partials can be included into a view initially and updated in AJAX manner, later.
*/
class CPartial {
/**
* Directory list of MVC partials ordered by search priority.
*
* @static
*
* @var array
*/
private static $directories = ['local/app/partials', 'app/partials'];
/**
* Partial name.
*
* @var string
*/
private $name;
/**
* Data provided for partial.
*
* @var array
*/
private $data;
/**
* Directory where the partial file was found.
*
* @var string
*/
private $directory;
/**
* Create a partial based on partial name and data.
*
* @param string $name Partial name to search for.
* @param array $data Accessible data within the partial.
*
* @throws InvalidArgumentException if partial name not valid.
* @throws RuntimeException if partial not found or not readable.
*/
public function __construct($name, array $data = []) {
if (!preg_match('/^[a-z]+(\/[a-z]+)*(\.[a-z]+)*$/', $name)) {
throw new InvalidArgumentException(sprintf('Invalid partial name: "%s".', $name));
}
$file_path = null;
foreach (self::$directories as $directory) {
$file_path = $directory.'/'.$name.'.php';
if (is_file($file_path)) {
$this->directory = $directory;
break;
}
}
if ($this->directory === null) {
throw new RuntimeException(sprintf('Partial not found: "%s".', $name));
}
if (!is_readable($file_path)) {
throw new RuntimeException(sprintf('Partial not readable: "%s".', $file_path));
}
$this->name = $name;
$this->data = $data;
}
/**
* Render partial and return the output.
* Note: partial should only output textual content like HTML, JSON, scripts or similar.
*
* @throws RuntimeException if partial not found, not readable or returned false.
*
* @return string
*/
public function getOutput() {
$data = $this->data;
$file_path = $this->directory.'/'.$this->name.'.php';
ob_start();
if ((include $file_path) === false) {
ob_end_clean();
throw new RuntimeException(sprintf('Cannot render partial: "%s".', $file_path));
}
return ob_get_clean();
}
/**
* Get the contents of a PHP-preprocessed JavaScript file.
* Notes:
* - JavaScript file will be searched in the "js" subdirectory of the partial file.
* - A copy of $data variable will be available for using within the file.
*
* @param string $file_name
* @param array $data
*
* @throws RuntimeException if the file not found, not readable or returned false.
*
* @return string
*/
public function readJsFile(string $file_name, ?array $data = null): string {
$data = ($data === null) ? $this->data : $data;
$file_path = $this->directory.'/js/'.$file_name;
ob_start();
if ((include $file_path) === false) {
ob_end_clean();
throw new RuntimeException(sprintf('Cannot read file: "%s".', $file_path));
}
return ob_get_clean();
}
/**
* Include a PHP-preprocessed JavaScript file inline.
* Notes:
* - JavaScript file will be searched in the "js" subdirectory of the partial file.
* - A copy of $data variable will be available for using within the file.
*
* @param string $file_name
* @param array $data
*
* @throws RuntimeException if the file not found, not readable or returned false.
*/
public function includeJsFile(string $file_name, array $data = null) {
echo $this->readJsFile($file_name, $data);
}
/**
* Register custom directory of MVC partials. The last registered will have the first priority.
*
* @param string $directory
*/
public static function registerDirectory($directory) {
if (!in_array($directory, self::$directories)) {
array_unshift(self::$directories, $directory);
}
}
}
|
