psfs /
core
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) { |
||
| 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()) { |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Servicio que establece las cabeceras de la respuesta |
||
| 105 | * @param string $contentType |
||
| 106 | * @param array $cookies |
||
| 107 | */ |
||
| 108 | private function setReponseHeaders($contentType = 'text/html', array $cookies = array()) { |
||
| 121 | |||
| 122 | /** |
||
| 123 | * Servicio que devuelve el output |
||
| 124 | * @param string $output |
||
| 125 | * @param string $contentType |
||
| 126 | * @param array $cookies |
||
| 127 | * @return string HTML |
||
| 128 | */ |
||
| 129 | public function output($output = '', $contentType = 'text/html', array $cookies = array()) { |
||
| 149 | |||
| 150 | /** |
||
| 151 | * Método que cierra y limpia los buffers de salida |
||
| 152 | */ |
||
| 153 | public function closeRender() { |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Método que devuelve los datos cacheados con las cabeceras que tenía por entonces |
||
| 165 | * @param string $data |
||
| 166 | * @param string|null $headers |
||
| 167 | */ |
||
| 168 | public function renderCache($data, $headers = array()) { |
||
| 178 | |||
| 179 | /** |
||
| 180 | * Método que añade una nueva ruta al path de Twig |
||
| 181 | * @param $path |
||
| 182 | * @param $domain |
||
| 183 | * |
||
| 184 | * @return Template |
||
| 185 | */ |
||
| 186 | public function addPath($path, $domain = '') { |
||
| 190 | |||
| 191 | /** |
||
| 192 | * Método que devuelve el contenido de una plantilla |
||
| 193 | * @param string $tpl |
||
| 194 | * @param array $vars |
||
| 195 | * @return string |
||
| 196 | */ |
||
| 197 | public function dump($tpl, array $vars = array()) { |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Método que añade una función al motor de plantillas |
||
| 213 | * @param string $templateFunction |
||
| 214 | * @param $functionName |
||
| 215 | * |
||
| 216 | * @return Template |
||
| 217 | */ |
||
| 218 | protected function addTemplateFunction($templateFunction, $functionName) { |
||
| 223 | |||
| 224 | /** |
||
| 225 | * Funcion Twig para los assets en las plantillas |
||
| 226 | * @return Template |
||
| 227 | */ |
||
| 228 | private function addAssetFunction() { |
||
| 231 | |||
| 232 | /** |
||
| 233 | * Función que pinta un formulario |
||
| 234 | * @return Template |
||
| 235 | */ |
||
| 236 | private function addFormsFunction() { |
||
| 239 | |||
| 240 | /** |
||
| 241 | * Función que pinta un campo de un formulario |
||
| 242 | * @return Template |
||
| 243 | */ |
||
| 244 | private function addFormWidgetFunction() |
||
| 248 | |||
| 249 | /** |
||
| 250 | * Función que pinta un botón de un formulario |
||
| 251 | * @return Template |
||
| 252 | */ |
||
| 253 | private function addFormButtonFunction() { |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Método que devuelve un parámetro de configuración en la plantilla |
||
| 259 | * @return Template |
||
| 260 | */ |
||
| 261 | private function addConfigFunction() { |
||
| 264 | |||
| 265 | /** |
||
| 266 | * Método que añade la función path a Twig |
||
| 267 | * @return Template |
||
| 268 | */ |
||
| 269 | private function addRouteFunction() { |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Método que copia directamente el recurso solicitado a la carpeta pública |
||
| 275 | * @return Template |
||
| 276 | */ |
||
| 277 | private function addResourceFunction() { |
||
| 278 | return $this->addTemplateFunction("resource", TemplateFunctions::RESOURCE_FUNCTION); |
||
| 279 | } |
||
| 280 | |||
| 281 | /** |
||
| 282 | * @return Template |
||
| 283 | */ |
||
| 284 | private function addSessionFunction() { |
||
| 285 | return $this->addTemplateFunction("session", TemplateFunctions::SESSION_FUNCTION); |
||
| 286 | } |
||
| 287 | |||
| 288 | /** |
||
| 289 | * @return Template |
||
| 290 | */ |
||
| 291 | private function addExistsFlashFunction() { |
||
| 292 | return $this->addTemplateFunction("existsFlash", TemplateFunctions::EXISTS_FLASH_FUNCTION); |
||
| 293 | } |
||
| 294 | |||
| 295 | /** |
||
| 296 | * @return Template |
||
| 297 | */ |
||
| 298 | private function addGetFlashFunction() { |
||
| 299 | return $this->addTemplateFunction("getFlash", TemplateFunctions::GET_FLASH_FUNCTION); |
||
| 300 | } |
||
| 301 | |||
| 302 | /** |
||
| 303 | * Servicio que regenera todas las plantillas |
||
| 304 | * @return array |
||
| 305 | */ |
||
| 306 | public function regenerateTemplates() { |
||
| 307 | $this->generateTemplatesCache(); |
||
| 308 | $domains = Cache::getInstance()->getDataFromFile(CONFIG_DIR.DIRECTORY_SEPARATOR."domains.json", Cache::JSON, true); |
||
| 309 | if (is_array($domains)) { |
||
| 310 | $translations = $this->parsePathTranslations($domains); |
||
| 311 | } |
||
| 312 | $translations[] = _("Plantillas regeneradas correctamente"); |
||
| 313 | return $translations; |
||
| 314 | } |
||
| 315 | |||
| 316 | /** |
||
| 317 | * @param $tplDir |
||
| 318 | * @param string $domain |
||
| 319 | * |
||
| 320 | * @return mixed |
||
| 321 | */ |
||
| 322 | protected function generateTemplate($tplDir, $domain = '') { |
||
| 323 | $templatesDir = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($tplDir), \RecursiveIteratorIterator::LEAVES_ONLY); |
||
| 324 | foreach ($templatesDir as $file) { |
||
| 325 | // force compilation |
||
| 326 | if ($file->isFile()) { |
||
| 327 | try { |
||
| 328 | $this->tpl->loadTemplate(str_replace($tplDir.'/', '', $file)); |
||
| 329 | } catch (\Exception $e) { |
||
| 330 | Logger::log($e->getMessage(), LOG_ERR); |
||
| 331 | } |
||
| 332 | } |
||
| 333 | } |
||
| 334 | return str_replace("%d", $domain, str_replace("%s", $tplDir, _("Generando plantillas en path '%s' para el dominio '%d'"))); |
||
| 335 | } |
||
| 336 | |||
| 337 | /** |
||
| 338 | * Método que extrae el path de un string |
||
| 339 | * @param $path |
||
| 340 | * |
||
| 341 | * @return string |
||
| 342 | */ |
||
| 343 | public static function extractPath($path) { |
||
| 344 | $explodePath = explode(DIRECTORY_SEPARATOR, $path); |
||
| 345 | $realPath = array(); |
||
| 346 | for ($i = 0, $parts = count($explodePath) - 1; $i < $parts; $i++) { |
||
| 347 | $realPath[] = $explodePath[$i]; |
||
| 348 | } |
||
| 349 | return implode(DIRECTORY_SEPARATOR, $realPath); |
||
| 350 | } |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Método que devuelve los dominios de una plataforma |
||
| 354 | * @param bool $append |
||
| 355 | * @return array |
||
| 356 | */ |
||
| 357 | static public function getDomains($append = false) { |
||
| 368 | |||
| 369 | /** |
||
| 370 | * @param $cookies |
||
| 371 | */ |
||
| 372 | protected function setCookieHeaders($cookies) { |
||
| 386 | |||
| 387 | /** |
||
| 388 | * Método que inyecta las cabeceras necesarias para la autenticación |
||
| 389 | */ |
||
| 390 | protected function setAuthHeaders() { |
||
| 399 | |||
| 400 | /** |
||
| 401 | * Método que establece el status code |
||
| 402 | */ |
||
| 403 | protected function setStatusHeader() { |
||
| 408 | |||
| 409 | /** |
||
| 410 | * Método que mete en las variables de las plantillas las cabeceras de debug |
||
| 411 | * @param array $vars |
||
| 412 | * |
||
| 413 | * @return array |
||
| 414 | */ |
||
| 415 | protected function setDebugHeaders(array $vars) |
||
| 428 | |||
| 429 | /** |
||
| 430 | * Método que añade todas las funciones de las plantillas |
||
| 431 | */ |
||
| 432 | private function addTemplateFunctions() { |
||
| 433 | //Asignamos las funciones especiales |
||
| 434 | $this->addAssetFunction() |
||
| 435 | ->addFormsFunction() |
||
| 446 | |||
| 447 | /** |
||
| 448 | * Método que devuelve el motod de plantillas |
||
| 449 | * @return \Twig_Environment |
||
| 450 | */ |
||
| 451 | public function getTemplateEngine() { |
||
| 454 | |||
| 455 | /** |
||
| 456 | * Método que inicializa el motor de plantillas |
||
| 457 | */ |
||
| 458 | private function setup() { |
||
| 469 | |||
| 470 | /** |
||
| 471 | * Método que inyecta los parseadores |
||
| 472 | */ |
||
| 473 | private function addTemplateTokens() { |
||
| 478 | |||
| 479 | /** |
||
| 480 | * Método que inyecta las optimizaciones al motor de la plantilla |
||
| 481 | */ |
||
| 482 | private function optimizeTemplates() { |
||
| 486 | |||
| 487 | /** |
||
| 488 | * Method that extract all path tag for extracting translations |
||
| 489 | * @param array $domains |
||
| 490 | * |
||
| 491 | * @return array |
||
| 492 | */ |
||
| 493 | private function parsePathTranslations($domains) |
||
| 507 | |||
| 508 | /** |
||
| 509 | * Method that generate all template caches |
||
| 510 | */ |
||
| 511 | private function generateTemplatesCache() |
||
| 522 | } |
||
| 523 |
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.