psfs /
core
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Template often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Template, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | class Template { |
||
| 15 | |||
| 16 | use SingletonTrait; |
||
| 17 | /** |
||
| 18 | * @var \Twig_Environment tpl |
||
| 19 | */ |
||
| 20 | protected $tpl; |
||
| 21 | protected $filters = array(); |
||
| 22 | |||
| 23 | protected $debug = false; |
||
| 24 | protected $public_zone = true; |
||
| 25 | private $status_code = 200; |
||
| 26 | |||
| 27 | /** |
||
| 28 | * @var \PSFS\base\Security $security |
||
| 29 | */ |
||
| 30 | protected $security; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * @var \PSFS\base\Cache $cache |
||
| 34 | */ |
||
| 35 | protected $cache; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * Constructor por defecto |
||
| 39 | */ |
||
| 40 | public function __construct() { |
||
| 41 | $this->setup(); |
||
| 42 | $this->addTemplateFunctions(); |
||
| 43 | $this->addTemplateTokens(); |
||
| 44 | $this->optimizeTemplates(); |
||
| 45 | } |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Método que devuelve el loader del Template |
||
| 49 | * @return \Twig_LoaderInterface |
||
| 50 | */ |
||
| 51 | public function getLoader() { |
||
| 54 | |||
| 55 | /** |
||
| 56 | * Método que activa la zona pública |
||
| 57 | * @param bool $public |
||
| 58 | * |
||
| 59 | * @return Template |
||
| 60 | */ |
||
| 61 | public function setPublicZone($public = true) { |
||
| 65 | |||
| 66 | /** |
||
| 67 | * Método que establece un header de http status code |
||
| 68 | * @param string $status |
||
| 69 | * |
||
| 70 | * @return Template |
||
| 71 | */ |
||
| 72 | public function setStatus($status = null) { |
||
| 73 | switch ($status) |
||
| 74 | { |
||
| 75 | //TODO implement all status codes |
||
| 76 | case '500': $this->status_code = "HTTP/1.0 500 Internal Server Error"; break; |
||
| 77 | case '404': $this->status_code = "HTTP/1.0 404 Not Found"; break; |
||
| 78 | case '403': $this->status_code = "HTTP/1.0 403 Forbidden"; break; |
||
| 79 | case '402': $this->status_code = "HTTP/1.0 402 Payment Required"; break; |
||
| 80 | case '401': $this->status_code = "HTTP/1.0 401 Unauthorized"; break; |
||
| 81 | case '400': $this->status_code = "HTTP/1.0 400 Bad Request"; break; |
||
| 82 | } |
||
| 83 | return $this; |
||
| 84 | } |
||
| 85 | |||
| 86 | /** |
||
| 87 | * Método que procesa la plantilla |
||
| 88 | * |
||
| 89 | * @param string $tpl |
||
| 90 | * @param array $vars |
||
| 91 | * @param array $cookies |
||
| 92 | * |
||
| 93 | * @return string HTML |
||
| 94 | */ |
||
| 95 | public function render($tpl, array $vars = array(), array $cookies = array()) { |
||
| 96 | $vars = $this->setDebugHeaders($vars); |
||
| 97 | $output = $this->dump($tpl, $vars); |
||
| 98 | |||
| 99 | return $this->output($output, 'text/html', $cookies); |
||
| 100 | } |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Servicio que establece las cabeceras de la respuesta |
||
| 104 | * @param string $contentType |
||
| 105 | * @param array $cookies |
||
| 106 | */ |
||
| 107 | private function setReponseHeaders($contentType = 'text/html', array $cookies = array()) { |
||
| 108 | $config = Config::getInstance(); |
||
| 109 | $powered = $config->get("poweredBy"); |
||
| 110 | if (empty($powered)) { |
||
| 111 | $powered = "@c15k0"; |
||
| 112 | } |
||
| 113 | header("X-Powered-By: $powered"); |
||
| 114 | $this->setStatusHeader(); |
||
| 115 | $this->setAuthHeaders(); |
||
| 116 | $this->setCookieHeaders($cookies); |
||
| 117 | header('Content-type: '.$contentType); |
||
| 118 | |||
| 119 | } |
||
| 120 | |||
| 121 | /** |
||
| 122 | * Servicio que devuelve el output |
||
| 123 | * @param string $output |
||
| 124 | * @param string $contentType |
||
| 125 | * @param array $cookies |
||
| 126 | * @return string HTML |
||
| 127 | */ |
||
| 128 | public function output($output = '', $contentType = 'text/html', array $cookies = array()) { |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Método que cierra y limpia los buffers de salida |
||
| 148 | */ |
||
| 149 | public function closeRender() { |
||
| 150 | $this->security->setSessionKey("lastRequest", array( |
||
| 151 | "url" => Request::getInstance()->getRootUrl().Request::requestUri(), |
||
| 152 | "ts" => microtime(true), |
||
| 153 | )); |
||
| 154 | $this->security->updateSession(); |
||
| 155 | exit; |
||
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Método que devuelve los datos cacheados con las cabeceras que tenía por entonces |
||
| 160 | * @param string $data |
||
| 161 | * @param string|null $headers |
||
| 162 | */ |
||
| 163 | public function renderCache($data, $headers = array()) { |
||
| 164 | ob_start(); |
||
| 165 | for ($i = 0, $ct = count($headers); $i < $ct; $i++) { |
||
| 166 | header($headers[$i]); |
||
| 167 | } |
||
| 168 | echo $data; |
||
| 169 | ob_flush(); |
||
| 170 | ob_end_clean(); |
||
| 171 | $this->closeRender(); |
||
| 172 | } |
||
| 173 | |||
| 174 | /** |
||
| 175 | * Método que añade una nueva ruta al path de Twig |
||
| 176 | * @param $path |
||
| 177 | * @param $domain |
||
| 178 | * |
||
| 179 | * @return Template |
||
| 180 | */ |
||
| 181 | public function addPath($path, $domain = '') { |
||
| 185 | |||
| 186 | /** |
||
| 187 | * Método que devuelve el contenido de una plantilla |
||
| 188 | * @param string $tpl |
||
| 189 | * @param array $vars |
||
| 190 | * @return string |
||
| 191 | */ |
||
| 192 | public function dump($tpl, array $vars = array()) { |
||
| 193 | $vars["__user__"] = $this->security->getUser(); |
||
| 194 | $vars["__admin__"] = $this->security->getAdmin(); |
||
| 195 | $vars["__profiles__"] = Security::getCleanProfiles(); |
||
| 196 | $vars["__flash__"] = Security::getInstance()->getFlashes(); |
||
| 197 | $dump = ''; |
||
| 198 | try { |
||
| 199 | $dump = $this->tpl->render($tpl, $vars); |
||
| 200 | }catch (\Exception $e) { |
||
| 201 | echo $e->getMessage()."<pre>".$e->getTraceAsString()."</pre>"; |
||
| 202 | } |
||
| 203 | return $dump; |
||
| 204 | } |
||
| 205 | |||
| 206 | /** |
||
| 207 | * Método que añade una función al motor de plantillas |
||
| 208 | * @param string $templateFunction |
||
| 209 | * @param $functionName |
||
| 210 | * |
||
| 211 | * @return Template |
||
| 212 | */ |
||
| 213 | protected function addTemplateFunction($templateFunction, $functionName) { |
||
| 214 | $function = new \Twig_SimpleFunction($templateFunction, $functionName); |
||
| 215 | $this->tpl->addFunction($function); |
||
| 216 | return $this; |
||
| 217 | } |
||
| 218 | |||
| 219 | /** |
||
| 220 | * Funcion Twig para los assets en las plantillas |
||
| 221 | * @return Template |
||
| 222 | */ |
||
| 223 | private function addAssetFunction() { |
||
| 226 | |||
| 227 | /** |
||
| 228 | * Función que pinta un formulario |
||
| 229 | * @return Template |
||
| 230 | */ |
||
| 231 | private function addFormsFunction() { |
||
| 234 | |||
| 235 | /** |
||
| 236 | * Función que pinta un campo de un formulario |
||
| 237 | * @return Template |
||
| 238 | */ |
||
| 239 | private function addFormWidgetFunction() |
||
| 243 | |||
| 244 | /** |
||
| 245 | * Función que pinta un botón de un formulario |
||
| 246 | * @return Template |
||
| 247 | */ |
||
| 248 | private function addFormButtonFunction() { |
||
| 251 | |||
| 252 | /** |
||
| 253 | * Método que devuelve un parámetro de configuración en la plantilla |
||
| 254 | * @return Template |
||
| 255 | */ |
||
| 256 | private function addConfigFunction() { |
||
| 259 | |||
| 260 | /** |
||
| 261 | * Método que añade la función path a Twig |
||
| 262 | * @return Template |
||
| 263 | */ |
||
| 264 | private function addRouteFunction() { |
||
| 267 | |||
| 268 | /** |
||
| 269 | * Método que copia directamente el recurso solicitado a la carpeta pública |
||
| 270 | * @return Template |
||
| 271 | */ |
||
| 272 | private function dumpResource() { |
||
| 275 | |||
| 276 | /** |
||
| 277 | * Servicio que regenera todas las plantillas |
||
| 278 | * @return array |
||
| 279 | */ |
||
| 280 | public function regenerateTemplates() { |
||
| 281 | $this->generateTemplatesCache(); |
||
| 282 | $domains = Cache::getInstance()->getDataFromFile(CONFIG_DIR.DIRECTORY_SEPARATOR."domains.json", Cache::JSON, true); |
||
| 283 | $translations = $this->parsePathTranslations($domains); |
||
| 287 | |||
| 288 | /** |
||
| 289 | * @param $tplDir |
||
| 290 | * @param string $domain |
||
| 291 | * |
||
| 292 | * @return mixed |
||
| 293 | */ |
||
| 294 | protected function generateTemplate($tplDir, $domain = '') { |
||
| 308 | |||
| 309 | /** |
||
| 310 | * Método que extrae el path de un string |
||
| 311 | * @param $path |
||
| 312 | * |
||
| 313 | * @return string |
||
| 314 | */ |
||
| 315 | public static function extractPath($path) { |
||
| 323 | |||
| 324 | /** |
||
| 325 | * Método que copia un recurso |
||
| 326 | * @param string $src |
||
| 327 | * @param string $dst |
||
| 328 | * @throws ConfigException |
||
| 329 | */ |
||
| 330 | public static function copyr($src, $dst) { |
||
| 344 | |||
| 345 | /** |
||
| 346 | * Método que devuelve los dominios de una plataforma |
||
| 347 | * @param bool $append |
||
| 348 | * @return array |
||
| 349 | */ |
||
| 350 | static public function getDomains($append = false) { |
||
| 361 | |||
| 362 | /** |
||
| 363 | * @param $cookies |
||
| 364 | */ |
||
| 365 | protected function setCookieHeaders($cookies) { |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Método que inyecta las cabeceras necesarias para la autenticación |
||
| 382 | */ |
||
| 383 | protected function setAuthHeaders() { |
||
| 392 | |||
| 393 | /** |
||
| 394 | * Método que establece el status code |
||
| 395 | */ |
||
| 396 | protected function setStatusHeader() { |
||
| 401 | |||
| 402 | /** |
||
| 403 | * Método que mete en las variables de las plantillas las cabeceras de debug |
||
| 404 | * @param array $vars |
||
| 405 | * |
||
| 406 | * @return array |
||
| 407 | */ |
||
| 408 | protected function setDebugHeaders(array $vars) |
||
| 422 | |||
| 423 | /** |
||
| 424 | * Función que devuelve el valor de una variable de sesión |
||
| 425 | * @return Template |
||
| 426 | */ |
||
| 427 | View Code Duplication | private function useSessionVars() { |
|
| 435 | |||
| 436 | /** |
||
| 437 | * Función que devuelve el valor de una variable de sesión flash |
||
| 438 | * @return Template |
||
| 439 | */ |
||
| 440 | View Code Duplication | private function existsFlash() { |
|
| 448 | |||
| 449 | /** |
||
| 450 | * Función que devuelve el valor de una variable de sesión flash |
||
| 451 | * @return Template |
||
| 452 | */ |
||
| 453 | private function useFlash() { |
||
| 463 | |||
| 464 | /** |
||
| 465 | * Método que añade todas las funciones de las plantillas |
||
| 466 | */ |
||
| 467 | private function addTemplateFunctions() { |
||
| 481 | |||
| 482 | /** |
||
| 483 | * Método que devuelve el motod de plantillas |
||
| 484 | * @return \Twig_Environment |
||
| 485 | */ |
||
| 486 | public function getTemplateEngine() { |
||
| 489 | |||
| 490 | /** |
||
| 491 | * Método que inicializa el motor de plantillas |
||
| 492 | */ |
||
| 493 | private function setup() { |
||
| 504 | |||
| 505 | /** |
||
| 506 | * Método que inyecta los parseadores |
||
| 507 | */ |
||
| 508 | private function addTemplateTokens() { |
||
| 513 | |||
| 514 | /** |
||
| 515 | * Método que inyecta las optimizaciones al motor de la plantilla |
||
| 516 | */ |
||
| 517 | private function optimizeTemplates() { |
||
| 521 | |||
| 522 | /** |
||
| 523 | * Method that extract all path tag for extracting translations |
||
| 524 | * @param array $domains |
||
| 525 | * |
||
| 526 | * @return array |
||
| 527 | */ |
||
| 528 | private function parsePathTranslations($domains) |
||
| 542 | |||
| 543 | /** |
||
| 544 | * Method that generate all template caches |
||
| 545 | */ |
||
| 546 | private function generateTemplatesCache() |
||
| 555 | } |
||
| 556 |
Loading history...
According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.
}
To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.