paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
paulgoughbooks_old / trunk / system / View / Cell.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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\View; use CodeIgniter\Cache\CacheInterface; use CodeIgniter\View\Exceptions\ViewException; use Config\Services; use ReflectionMethod; /** * Class Cell * * A simple class that can call any other class that can be loaded, * and echo out it's result. Intended for displaying small blocks of * content within views that can be managed by other libraries and * not require they are loaded within controller. * * Used with the helper function, it's use will look like: * * viewCell('\Some\Class::method', 'limit=5 sort=asc', 60, 'cache-name'); * * Parameters are matched up with the callback method's arguments of the same name: * * class Class { * function method($limit, $sort) * } * * Alternatively, the params will be passed into the callback method as a simple array * if matching params are not found. * * class Class { * function method(array $params=null) * } * * @package CodeIgniter\View */ class Cell { /** * Instance of the current Cache Instance * * @var CacheInterface */ protected $cache; //-------------------------------------------------------------------- /** * Cell constructor. * * @param \CodeIgniter\Cache\CacheInterface $cache */ public function __construct(CacheInterface $cache) { $this->cache = $cache; } //-------------------------------------------------------------------- /** * Render a cell, returning its body as a string. * * @param string $library * @param null $params * @param integer $ttl * @param string|null $cacheName * * @return string * @throws \ReflectionException */ public function render(string $library, $params = null, int $ttl = 0, string $cacheName = null): string { list($class, $method) = $this->determineClass($library); // Is it cached? $cacheName = ! empty($cacheName) ? $cacheName : str_replace(['\\', '/'], '', $class) . $method . md5(serialize($params)); if (! empty($this->cache) && $output = $this->cache->get($cacheName)) { return $output; } // Not cached - so grab it... $instance = new $class(); if (method_exists($instance, 'initController')) { $instance->initController(Services::request(), Services::response(), Services::logger()); } if (! method_exists($instance, $method)) { throw ViewException::forInvalidCellMethod($class, $method); } // Try to match up the parameter list we were provided // with the parameter name in the callback method. $paramArray = $this->prepareParams($params); $refMethod = new ReflectionMethod($instance, $method); $paramCount = $refMethod->getNumberOfParameters(); $refParams = $refMethod->getParameters(); if ($paramCount === 0) { if (! empty($paramArray)) { throw ViewException::forMissingCellParameters($class, $method); } $output = $instance->{$method}(); } elseif (($paramCount === 1) && ( ( ! array_key_exists($refParams[0]->name, $paramArray)) || (array_key_exists($refParams[0]->name, $paramArray) && count($paramArray) !== 1) ) ) { $output = $instance->{$method}($paramArray); } else { $fireArgs = []; $method_params = []; foreach ($refParams as $arg) { $method_params[$arg->name] = true; if (array_key_exists($arg->name, $paramArray)) { $fireArgs[$arg->name] = $paramArray[$arg->name]; } } foreach ($paramArray as $key => $val) { if (! isset($method_params[$key])) { throw ViewException::forInvalidCellParameter($key); } } $output = $instance->$method(...array_values($fireArgs)); } // Can we cache it? if (! empty($this->cache) && $ttl !== 0) { $this->cache->save($cacheName, $output, $ttl); } return $output; } //-------------------------------------------------------------------- /** * Parses the params attribute. If an array, returns untouched. * If a string, it should be in the format "key1=value key2=value". * It will be split and returned as an array. * * @param $params * * @return array|null */ public function prepareParams($params) { if (empty($params) || ( ! is_string($params) && ! is_array($params))) { return []; } if (is_string($params)) { $new_params = []; $separator = ' '; if (strpos($params, ',') !== false) { $separator = ','; } $params = explode($separator, $params); unset($separator); foreach ($params as $p) { if (! empty($p)) { list($key, $val) = explode('=', $p); $new_params[trim($key)] = trim($val, ', '); } } $params = $new_params; unset($new_params); } if (is_array($params) && empty($params)) { return []; } return $params; } //-------------------------------------------------------------------- /** * Given the library string, attempts to determine the class and method * to call. * * @param string $library * * @return array */ protected function determineClass(string $library): array { // We don't want to actually call static methods // by default, so convert any double colons. $library = str_replace('::', ':', $library); list($class, $method) = explode(':', $library); if (empty($class)) { throw ViewException::forNoCellClass(); } if (! class_exists($class, true)) { throw ViewException::forInvalidCellClass($class); } if (empty($method)) { $method = 'index'; } return [ $class, $method, ]; } //-------------------------------------------------------------------- } |
Commits for paulgoughbooks_old/trunk/system/View/Cell.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |