@@ -30,247 +30,247 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | class TemplateHandler |
| 32 | 32 | { |
| 33 | - /** |
|
| 34 | - * Benchmark instance. |
|
| 35 | - * |
|
| 36 | - * @var string $benchmark |
|
| 37 | - */ |
|
| 38 | - protected $benchmark; |
|
| 33 | + /** |
|
| 34 | + * Benchmark instance. |
|
| 35 | + * |
|
| 36 | + * @var string $benchmark |
|
| 37 | + */ |
|
| 38 | + protected $benchmark; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * Nesting level of the output buffering mechanism. |
|
| 42 | - * |
|
| 43 | - * @var string $obLevel |
|
| 44 | - */ |
|
| 45 | - public $obLevel; |
|
| 40 | + /** |
|
| 41 | + * Nesting level of the output buffering mechanism. |
|
| 42 | + * |
|
| 43 | + * @var string $obLevel |
|
| 44 | + */ |
|
| 45 | + public $obLevel; |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * The functions of system what control errors and exceptions. |
|
| 49 | - * |
|
| 50 | - * @var string|object $system |
|
| 51 | - */ |
|
| 52 | - protected $system; |
|
| 47 | + /** |
|
| 48 | + * The functions of system what control errors and exceptions. |
|
| 49 | + * |
|
| 50 | + * @var string|object $system |
|
| 51 | + */ |
|
| 52 | + protected $system; |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * An array of variables to be passed to all templates. |
|
| 56 | - * |
|
| 57 | - * @var array $variables |
|
| 58 | - */ |
|
| 59 | - protected $variables = []; |
|
| 54 | + /** |
|
| 55 | + * An array of variables to be passed to all templates. |
|
| 56 | + * |
|
| 57 | + * @var array $variables |
|
| 58 | + */ |
|
| 59 | + protected $variables = []; |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Constructor. The TemplateHandler class instance. |
|
| 63 | - * |
|
| 64 | - * @return void |
|
| 65 | - */ |
|
| 66 | - public function __construct() |
|
| 67 | - { |
|
| 68 | - $this->system = new System; |
|
| 69 | - $this->benchmark = new Benchmark; |
|
| 70 | - $this->obLevel = $this->system->getOutputBufferLevel(); |
|
| 71 | - } |
|
| 61 | + /** |
|
| 62 | + * Constructor. The TemplateHandler class instance. |
|
| 63 | + * |
|
| 64 | + * @return void |
|
| 65 | + */ |
|
| 66 | + public function __construct() |
|
| 67 | + { |
|
| 68 | + $this->system = new System; |
|
| 69 | + $this->benchmark = new Benchmark; |
|
| 70 | + $this->obLevel = $this->system->getOutputBufferLevel(); |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * Clean Path: This makes nicer looking paths for the error output. |
|
| 75 | - * |
|
| 76 | - * @param string $file |
|
| 77 | - * |
|
| 78 | - * @return string |
|
| 79 | - */ |
|
| 80 | - public function cleanPath($file): string |
|
| 81 | - { |
|
| 82 | - if (strpos($file, appPath().DIRECTORY_SEPARATOR) === 0) { |
|
| 83 | - $file = appPath().DIRECTORY_SEPARATOR.substr($file, strlen(appPath().DIRECTORY_SEPARATOR)); |
|
| 84 | - } elseif (strpos($file, basePath().DIRECTORY_SEPARATOR) === 0) { |
|
| 85 | - $file = basePath().DIRECTORY_SEPARATOR.substr($file, strlen(basePath().DIRECTORY_SEPARATOR)); |
|
| 86 | - } elseif (strpos($file, configPath().DIRECTORY_SEPARATOR) === 0) { |
|
| 87 | - $file = configPath().DIRECTORY_SEPARATOR.substr($file, strlen(configPath().DIRECTORY_SEPARATOR)); |
|
| 88 | - } elseif (strpos($file, resourcePath().DIRECTORY_SEPARATOR) === 0) { |
|
| 89 | - $file = resourcePath().DIRECTORY_SEPARATOR.substr($file, strlen(resourcePath().DIRECTORY_SEPARATOR)); |
|
| 90 | - } |
|
| 73 | + /** |
|
| 74 | + * Clean Path: This makes nicer looking paths for the error output. |
|
| 75 | + * |
|
| 76 | + * @param string $file |
|
| 77 | + * |
|
| 78 | + * @return string |
|
| 79 | + */ |
|
| 80 | + public function cleanPath($file): string |
|
| 81 | + { |
|
| 82 | + if (strpos($file, appPath().DIRECTORY_SEPARATOR) === 0) { |
|
| 83 | + $file = appPath().DIRECTORY_SEPARATOR.substr($file, strlen(appPath().DIRECTORY_SEPARATOR)); |
|
| 84 | + } elseif (strpos($file, basePath().DIRECTORY_SEPARATOR) === 0) { |
|
| 85 | + $file = basePath().DIRECTORY_SEPARATOR.substr($file, strlen(basePath().DIRECTORY_SEPARATOR)); |
|
| 86 | + } elseif (strpos($file, configPath().DIRECTORY_SEPARATOR) === 0) { |
|
| 87 | + $file = configPath().DIRECTORY_SEPARATOR.substr($file, strlen(configPath().DIRECTORY_SEPARATOR)); |
|
| 88 | + } elseif (strpos($file, resourcePath().DIRECTORY_SEPARATOR) === 0) { |
|
| 89 | + $file = resourcePath().DIRECTORY_SEPARATOR.substr($file, strlen(resourcePath().DIRECTORY_SEPARATOR)); |
|
| 90 | + } |
|
| 91 | 91 | |
| 92 | - return $file; |
|
| 93 | - } |
|
| 92 | + return $file; |
|
| 93 | + } |
|
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Display memory usage in real-world units. Intended for use |
|
| 97 | - * with memory_get_usage, etc. |
|
| 98 | - * |
|
| 99 | - * @param int $bytes |
|
| 100 | - * |
|
| 101 | - * @return string |
|
| 102 | - */ |
|
| 103 | - public function displayMemory(int $bytes): string |
|
| 104 | - { |
|
| 105 | - if ($bytes < 1024) { |
|
| 106 | - return $bytes.'B'; |
|
| 107 | - } else if ($bytes < 1048576) { |
|
| 108 | - return round($bytes/1024, 2).'KB'; |
|
| 109 | - } |
|
| 95 | + /** |
|
| 96 | + * Display memory usage in real-world units. Intended for use |
|
| 97 | + * with memory_get_usage, etc. |
|
| 98 | + * |
|
| 99 | + * @param int $bytes |
|
| 100 | + * |
|
| 101 | + * @return string |
|
| 102 | + */ |
|
| 103 | + public function displayMemory(int $bytes): string |
|
| 104 | + { |
|
| 105 | + if ($bytes < 1024) { |
|
| 106 | + return $bytes.'B'; |
|
| 107 | + } else if ($bytes < 1048576) { |
|
| 108 | + return round($bytes/1024, 2).'KB'; |
|
| 109 | + } |
|
| 110 | 110 | |
| 111 | - return round($bytes/1048576, 2).'MB'; |
|
| 112 | - } |
|
| 111 | + return round($bytes/1048576, 2).'MB'; |
|
| 112 | + } |
|
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * Escapes a string for output in an HTML document. |
|
| 116 | - * |
|
| 117 | - * @param string $text |
|
| 118 | - * |
|
| 119 | - * @return string |
|
| 120 | - */ |
|
| 121 | - public function escape($text): string |
|
| 122 | - { |
|
| 123 | - $flags = ENT_QUOTES; |
|
| 114 | + /** |
|
| 115 | + * Escapes a string for output in an HTML document. |
|
| 116 | + * |
|
| 117 | + * @param string $text |
|
| 118 | + * |
|
| 119 | + * @return string |
|
| 120 | + */ |
|
| 121 | + public function escape($text): string |
|
| 122 | + { |
|
| 123 | + $flags = ENT_QUOTES; |
|
| 124 | 124 | |
| 125 | - // HHVM has all constants defined, but only ENT_IGNORE |
|
| 126 | - // works at the moment |
|
| 127 | - if (defined("ENT_SUBSTITUTE") && ! defined("HHVM_VERSION")) { |
|
| 128 | - $flags |= ENT_SUBSTITUTE; |
|
| 129 | - } else { |
|
| 130 | - $flags |= ENT_IGNORE; |
|
| 131 | - } |
|
| 125 | + // HHVM has all constants defined, but only ENT_IGNORE |
|
| 126 | + // works at the moment |
|
| 127 | + if (defined("ENT_SUBSTITUTE") && ! defined("HHVM_VERSION")) { |
|
| 128 | + $flags |= ENT_SUBSTITUTE; |
|
| 129 | + } else { |
|
| 130 | + $flags |= ENT_IGNORE; |
|
| 131 | + } |
|
| 132 | 132 | |
| 133 | - $text = str_replace(chr(9), ' ', $text); |
|
| 133 | + $text = str_replace(chr(9), ' ', $text); |
|
| 134 | 134 | |
| 135 | - return htmlspecialchars($text, $flags, "UTF-8"); |
|
| 136 | - } |
|
| 135 | + return htmlspecialchars($text, $flags, "UTF-8"); |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | - /** |
|
| 139 | - * Returns all variables for this helper. |
|
| 140 | - * |
|
| 141 | - * @return array |
|
| 142 | - */ |
|
| 143 | - public function getVariables(): array |
|
| 144 | - { |
|
| 145 | - return $this->variables; |
|
| 146 | - } |
|
| 138 | + /** |
|
| 139 | + * Returns all variables for this helper. |
|
| 140 | + * |
|
| 141 | + * @return array |
|
| 142 | + */ |
|
| 143 | + public function getVariables(): array |
|
| 144 | + { |
|
| 145 | + return $this->variables; |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Creates a syntax-highlighted version of a PHP file. |
|
| 150 | - * |
|
| 151 | - * @param string $file |
|
| 152 | - * @param int $lineNumber |
|
| 153 | - * @param int $lines |
|
| 154 | - * |
|
| 155 | - * @return bool|string |
|
| 156 | - * |
|
| 157 | - * @throws \Exception |
|
| 158 | - */ |
|
| 159 | - public function highlightFile($file, $lineNumber, $lines = 15) |
|
| 160 | - { |
|
| 161 | - if (empty ($file) || ! is_readable($file)) { |
|
| 162 | - return false; |
|
| 163 | - } |
|
| 148 | + /** |
|
| 149 | + * Creates a syntax-highlighted version of a PHP file. |
|
| 150 | + * |
|
| 151 | + * @param string $file |
|
| 152 | + * @param int $lineNumber |
|
| 153 | + * @param int $lines |
|
| 154 | + * |
|
| 155 | + * @return bool|string |
|
| 156 | + * |
|
| 157 | + * @throws \Exception |
|
| 158 | + */ |
|
| 159 | + public function highlightFile($file, $lineNumber, $lines = 15) |
|
| 160 | + { |
|
| 161 | + if (empty ($file) || ! is_readable($file)) { |
|
| 162 | + return false; |
|
| 163 | + } |
|
| 164 | 164 | |
| 165 | - // Set our highlight colors: |
|
| 166 | - if (function_exists('ini_set')) { |
|
| 167 | - ini_set('highlight.bg', '#000'); |
|
| 168 | - ini_set('highlight.comment', '#959595'); |
|
| 169 | - ini_set('highlight.default', '#818CF8'); |
|
| 170 | - ini_set('highlight.html', '#06B'); |
|
| 171 | - ini_set('highlight.keyword', '#F47E3A'); |
|
| 172 | - ini_set('highlight.string', '#57C60D'); |
|
| 173 | - } |
|
| 165 | + // Set our highlight colors: |
|
| 166 | + if (function_exists('ini_set')) { |
|
| 167 | + ini_set('highlight.bg', '#000'); |
|
| 168 | + ini_set('highlight.comment', '#959595'); |
|
| 169 | + ini_set('highlight.default', '#818CF8'); |
|
| 170 | + ini_set('highlight.html', '#06B'); |
|
| 171 | + ini_set('highlight.keyword', '#F47E3A'); |
|
| 172 | + ini_set('highlight.string', '#57C60D'); |
|
| 173 | + } |
|
| 174 | 174 | |
| 175 | - try { |
|
| 176 | - $origin = file_get_contents($file); |
|
| 177 | - } catch (Exception $e) { |
|
| 178 | - return false; |
|
| 179 | - } |
|
| 175 | + try { |
|
| 176 | + $origin = file_get_contents($file); |
|
| 177 | + } catch (Exception $e) { |
|
| 178 | + return false; |
|
| 179 | + } |
|
| 180 | 180 | |
| 181 | - $origin = str_replace(["\r\n", "\r"], "\n", $origin); |
|
| 182 | - $origin = explode("\n", highlight_string($origin , true)); |
|
| 183 | - $origin = str_replace('<br />', "\n", $origin [1]); |
|
| 181 | + $origin = str_replace(["\r\n", "\r"], "\n", $origin); |
|
| 182 | + $origin = explode("\n", highlight_string($origin , true)); |
|
| 183 | + $origin = str_replace('<br />', "\n", $origin [1]); |
|
| 184 | 184 | |
| 185 | - $origin = explode("\n", str_replace("\r\n", "\n", $origin)); |
|
| 185 | + $origin = explode("\n", str_replace("\r\n", "\n", $origin)); |
|
| 186 | 186 | |
| 187 | - // Get just the part to show |
|
| 188 | - $start = $lineNumber - (int) round($lines / 2); |
|
| 189 | - $start = $start < 0 ? 0 : $start; |
|
| 187 | + // Get just the part to show |
|
| 188 | + $start = $lineNumber - (int) round($lines / 2); |
|
| 189 | + $start = $start < 0 ? 0 : $start; |
|
| 190 | 190 | |
| 191 | - // Get just the lines we need to display, while keeping line numbers... |
|
| 192 | - $origin = array_splice($origin, $start, $lines, true); |
|
| 191 | + // Get just the lines we need to display, while keeping line numbers... |
|
| 192 | + $origin = array_splice($origin, $start, $lines, true); |
|
| 193 | 193 | |
| 194 | - // Used to format the line number in the source |
|
| 195 | - $format = '% '.strlen($start + $lines).'d'; |
|
| 194 | + // Used to format the line number in the source |
|
| 195 | + $format = '% '.strlen($start + $lines).'d'; |
|
| 196 | 196 | |
| 197 | - $out = ''; |
|
| 198 | - // Because the highlighting may have an uneven number |
|
| 199 | - // of open and close span tags on one line, we need |
|
| 200 | - // to ensure we can close them all to get the lines |
|
| 201 | - // showing correctly. |
|
| 202 | - $spans = 1; |
|
| 197 | + $out = ''; |
|
| 198 | + // Because the highlighting may have an uneven number |
|
| 199 | + // of open and close span tags on one line, we need |
|
| 200 | + // to ensure we can close them all to get the lines |
|
| 201 | + // showing correctly. |
|
| 202 | + $spans = 1; |
|
| 203 | 203 | |
| 204 | - foreach ($origin as $n => $row) { |
|
| 205 | - $spans += substr_count($row, '<span') - substr_count($row, '</span'); |
|
| 206 | - $row = str_replace(["\r", "\n"], ['', ''], $row); |
|
| 204 | + foreach ($origin as $n => $row) { |
|
| 205 | + $spans += substr_count($row, '<span') - substr_count($row, '</span'); |
|
| 206 | + $row = str_replace(["\r", "\n"], ['', ''], $row); |
|
| 207 | 207 | |
| 208 | - if (($n+$start+1) == $lineNumber) { |
|
| 209 | - preg_match_all('#<[^>]+>#', $row, $tags); |
|
| 210 | - $out .= sprintf("<span class='line highlight'><span class='number'>{$format}</span> %s\n</span>%s", |
|
| 211 | - $n + $start + 1, |
|
| 212 | - strip_tags($row), |
|
| 213 | - implode('', $tags[0]) |
|
| 214 | - ); |
|
| 215 | - } else { |
|
| 216 | - $out .= sprintf('<span class="number">'.$format.'</span> %s <span class="line">', $n + $start + 1, $row) ."\n"; |
|
| 217 | - } |
|
| 218 | - } |
|
| 208 | + if (($n+$start+1) == $lineNumber) { |
|
| 209 | + preg_match_all('#<[^>]+>#', $row, $tags); |
|
| 210 | + $out .= sprintf("<span class='line highlight'><span class='number'>{$format}</span> %s\n</span>%s", |
|
| 211 | + $n + $start + 1, |
|
| 212 | + strip_tags($row), |
|
| 213 | + implode('', $tags[0]) |
|
| 214 | + ); |
|
| 215 | + } else { |
|
| 216 | + $out .= sprintf('<span class="number">'.$format.'</span> %s <span class="line">', $n + $start + 1, $row) ."\n"; |
|
| 217 | + } |
|
| 218 | + } |
|
| 219 | 219 | |
| 220 | - $out .= str_repeat('</span>', $spans); |
|
| 220 | + $out .= str_repeat('</span>', $spans); |
|
| 221 | 221 | |
| 222 | - return '<pre class="code-blocks"><code>'.$out.'</code></pre>'; |
|
| 223 | - } |
|
| 222 | + return '<pre class="code-blocks"><code>'.$out.'</code></pre>'; |
|
| 223 | + } |
|
| 224 | 224 | |
| 225 | - /** |
|
| 226 | - * Sets the variables to be passed to all templates rendered |
|
| 227 | - * by this template helper. |
|
| 228 | - * |
|
| 229 | - * @param array $variables |
|
| 230 | - * |
|
| 231 | - * @return void |
|
| 232 | - */ |
|
| 233 | - public function setVariables(array $variables): void |
|
| 234 | - { |
|
| 235 | - $this->variables = $variables; |
|
| 236 | - } |
|
| 225 | + /** |
|
| 226 | + * Sets the variables to be passed to all templates rendered |
|
| 227 | + * by this template helper. |
|
| 228 | + * |
|
| 229 | + * @param array $variables |
|
| 230 | + * |
|
| 231 | + * @return void |
|
| 232 | + */ |
|
| 233 | + public function setVariables(array $variables): void |
|
| 234 | + { |
|
| 235 | + $this->variables = $variables; |
|
| 236 | + } |
|
| 237 | 237 | |
| 238 | - /** |
|
| 239 | - * Convert a string to a slug version of itself. |
|
| 240 | - * |
|
| 241 | - * @param string $original |
|
| 242 | - * |
|
| 243 | - * @return string |
|
| 244 | - */ |
|
| 245 | - public function slug($original): string |
|
| 246 | - { |
|
| 247 | - $slug = str_replace(" ", "-", $original); |
|
| 248 | - $slug = preg_replace('/[^\w\d\-\_]/i',' ', $slug); |
|
| 238 | + /** |
|
| 239 | + * Convert a string to a slug version of itself. |
|
| 240 | + * |
|
| 241 | + * @param string $original |
|
| 242 | + * |
|
| 243 | + * @return string |
|
| 244 | + */ |
|
| 245 | + public function slug($original): string |
|
| 246 | + { |
|
| 247 | + $slug = str_replace(" ", "-", $original); |
|
| 248 | + $slug = preg_replace('/[^\w\d\-\_]/i',' ', $slug); |
|
| 249 | 249 | |
| 250 | - return strtolower($slug); |
|
| 251 | - } |
|
| 250 | + return strtolower($slug); |
|
| 251 | + } |
|
| 252 | 252 | |
| 253 | - /** |
|
| 254 | - * Given an exception and status code will display the error to the client. |
|
| 255 | - * |
|
| 256 | - * @param string $template |
|
| 257 | - * |
|
| 258 | - * @return void |
|
| 259 | - */ |
|
| 260 | - public function render($template): void |
|
| 261 | - { |
|
| 262 | - $vars = $this->getVariables(); |
|
| 253 | + /** |
|
| 254 | + * Given an exception and status code will display the error to the client. |
|
| 255 | + * |
|
| 256 | + * @param string $template |
|
| 257 | + * |
|
| 258 | + * @return void |
|
| 259 | + */ |
|
| 260 | + public function render($template): void |
|
| 261 | + { |
|
| 262 | + $vars = $this->getVariables(); |
|
| 263 | 263 | |
| 264 | - $vars['template'] = $this; |
|
| 264 | + $vars['template'] = $this; |
|
| 265 | 265 | |
| 266 | - if ($this->system->getOutputBufferLevel() > $this->obLevel + 1) { |
|
| 267 | - @$this->system->endOutputBuffering(); |
|
| 268 | - } |
|
| 266 | + if ($this->system->getOutputBufferLevel() > $this->obLevel + 1) { |
|
| 267 | + @$this->system->endOutputBuffering(); |
|
| 268 | + } |
|
| 269 | 269 | |
| 270 | - // Instantiate the error view and prepare the vars |
|
| 271 | - call_user_func(function () { |
|
| 272 | - extract(func_get_arg(1)); |
|
| 273 | - include func_get_arg(0); |
|
| 274 | - }, $template, $vars); |
|
| 275 | - } |
|
| 270 | + // Instantiate the error view and prepare the vars |
|
| 271 | + call_user_func(function () { |
|
| 272 | + extract(func_get_arg(1)); |
|
| 273 | + include func_get_arg(0); |
|
| 274 | + }, $template, $vars); |
|
| 275 | + } |
|
| 276 | 276 | } |
| 277 | 277 | \ No newline at end of file |