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 |
||
| 13 | class Template |
||
| 14 | { |
||
| 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() |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Método que devuelve el loader del Template |
||
| 50 | * @return \Twig_LoaderInterface |
||
| 51 | */ |
||
| 52 | public function getLoader() |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Método que activa la zona pública |
||
| 59 | * @param bool $public |
||
| 60 | * |
||
| 61 | * @return Template |
||
| 62 | */ |
||
| 63 | public function setPublicZone($public = true) |
||
| 68 | |||
| 69 | /** |
||
| 70 | * Método que establece un header de http status code |
||
| 71 | * @param string $status |
||
| 72 | * |
||
| 73 | * @return Template |
||
| 74 | */ |
||
| 75 | public function setStatus($status = null) |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Método que procesa la plantilla |
||
| 103 | * |
||
| 104 | * @param string $tpl |
||
| 105 | * @param array $vars |
||
| 106 | * @param array $cookies |
||
| 107 | * |
||
| 108 | * @return string HTML |
||
| 109 | */ |
||
| 110 | public function render($tpl, array $vars = array(), array $cookies = array()) |
||
| 118 | |||
| 119 | /** |
||
| 120 | * Servicio que establece las cabeceras de la respuesta |
||
| 121 | * @param string $contentType |
||
| 122 | * @param array $cookies |
||
| 123 | */ |
||
| 124 | private function setReponseHeaders($contentType = 'text/html', array $cookies = array()) |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Servicio que devuelve el output |
||
| 141 | * @param string $output |
||
| 142 | * @param string $contentType |
||
| 143 | * @param array $cookies |
||
| 144 | * @return string HTML |
||
| 145 | */ |
||
| 146 | public function output($output = '', $contentType = 'text/html', array $cookies = array()) |
||
| 167 | |||
| 168 | /** |
||
| 169 | * Método que cierra y limpia los buffers de salida |
||
| 170 | */ |
||
| 171 | public function closeRender() |
||
| 181 | |||
| 182 | /** |
||
| 183 | * Método que devuelve los datos cacheados con las cabeceras que tenía por entonces |
||
| 184 | * @param string $data |
||
| 185 | * @param string|null $headers |
||
| 186 | */ |
||
| 187 | public function renderCache($data, $headers = array()) |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Método que añade una nueva ruta al path de Twig |
||
| 201 | * @param $path |
||
| 202 | * @param $domain |
||
| 203 | * |
||
| 204 | * @return Template |
||
| 205 | */ |
||
| 206 | public function addPath($path, $domain = '') |
||
| 211 | |||
| 212 | /** |
||
| 213 | * Método que devuelve el contenido de una plantilla |
||
| 214 | * @param string $tpl |
||
| 215 | * @param array $vars |
||
| 216 | * @return string |
||
| 217 | */ |
||
| 218 | public function dump($tpl, array $vars = array()) |
||
| 232 | |||
| 233 | /** |
||
| 234 | * Método que añade una función al motor de plantillas |
||
| 235 | * @param string $templateFunction |
||
| 236 | * @param $functionName |
||
| 237 | * |
||
| 238 | * @return Template |
||
| 239 | */ |
||
| 240 | protected function addTemplateFunction($templateFunction, $functionName) |
||
| 246 | |||
| 247 | /** |
||
| 248 | * Funcion Twig para los assets en las plantillas |
||
| 249 | * @return Template |
||
| 250 | */ |
||
| 251 | private function addAssetFunction() |
||
| 255 | |||
| 256 | /** |
||
| 257 | * Función que pinta un formulario |
||
| 258 | * @return Template |
||
| 259 | */ |
||
| 260 | private function addFormsFunction() |
||
| 264 | |||
| 265 | /** |
||
| 266 | * Función que pinta un campo de un formulario |
||
| 267 | * @return Template |
||
| 268 | */ |
||
| 269 | private function addFormWidgetFunction() |
||
| 273 | |||
| 274 | /** |
||
| 275 | * Función que pinta un botón de un formulario |
||
| 276 | * @return Template |
||
| 277 | */ |
||
| 278 | private function addFormButtonFunction() |
||
| 282 | |||
| 283 | /** |
||
| 284 | * Método que devuelve un parámetro de configuración en la plantilla |
||
| 285 | * @return Template |
||
| 286 | */ |
||
| 287 | private function addConfigFunction() |
||
| 291 | |||
| 292 | /** |
||
| 293 | * Método que añade la función path a Twig |
||
| 294 | * @return Template |
||
| 295 | */ |
||
| 296 | private function addRouteFunction() |
||
| 300 | |||
| 301 | /** |
||
| 302 | * Método que copia directamente el recurso solicitado a la carpeta pública |
||
| 303 | * @return Template |
||
| 304 | */ |
||
| 305 | private function addResourceFunction() |
||
| 309 | |||
| 310 | /** |
||
| 311 | * @return Template |
||
| 312 | */ |
||
| 313 | private function addSessionFunction() |
||
| 317 | |||
| 318 | /** |
||
| 319 | * @return Template |
||
| 320 | */ |
||
| 321 | private function addExistsFlashFunction() |
||
| 325 | |||
| 326 | /** |
||
| 327 | * @return Template |
||
| 328 | */ |
||
| 329 | private function addGetFlashFunction() |
||
| 333 | |||
| 334 | /** |
||
| 335 | * Servicio que regenera todas las plantillas |
||
| 336 | * @return array |
||
| 337 | */ |
||
| 338 | public function regenerateTemplates() |
||
| 349 | |||
| 350 | /** |
||
| 351 | * @param $tplDir |
||
| 352 | * @param string $domain |
||
| 353 | * |
||
| 354 | * @return mixed |
||
| 355 | */ |
||
| 356 | protected function generateTemplate($tplDir, $domain = '') |
||
| 371 | |||
| 372 | /** |
||
| 373 | * Método que extrae el path de un string |
||
| 374 | * @param $path |
||
| 375 | * |
||
| 376 | * @return string |
||
| 377 | */ |
||
| 378 | public static function extractPath($path) |
||
| 387 | |||
| 388 | /** |
||
| 389 | * Método que devuelve los dominios de una plataforma |
||
| 390 | * @param bool $append |
||
| 391 | * @return array |
||
| 392 | */ |
||
| 393 | static public function getDomains($append = false) |
||
| 405 | |||
| 406 | /** |
||
| 407 | * @param $cookies |
||
| 408 | */ |
||
| 409 | protected function setCookieHeaders($cookies) |
||
| 424 | |||
| 425 | /** |
||
| 426 | * Método que inyecta las cabeceras necesarias para la autenticación |
||
| 427 | */ |
||
| 428 | protected function setAuthHeaders() |
||
| 438 | |||
| 439 | /** |
||
| 440 | * Método que establece el status code |
||
| 441 | */ |
||
| 442 | protected function setStatusHeader() |
||
| 448 | |||
| 449 | /** |
||
| 450 | * Método que mete en las variables de las plantillas las cabeceras de debug |
||
| 451 | * @param array $vars |
||
| 452 | * |
||
| 453 | * @return array |
||
| 454 | */ |
||
| 455 | protected function setDebugHeaders(array $vars) |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Método que añade todas las funciones de las plantillas |
||
| 471 | */ |
||
| 472 | private function addTemplateFunctions() |
||
| 486 | |||
| 487 | /** |
||
| 488 | * Método que devuelve el motod de plantillas |
||
| 489 | * @return \Twig_Environment |
||
| 490 | */ |
||
| 491 | public function getTemplateEngine() |
||
| 495 | |||
| 496 | /** |
||
| 497 | * Método que inicializa el motor de plantillas |
||
| 498 | */ |
||
| 499 | private function setup() |
||
| 511 | |||
| 512 | /** |
||
| 513 | * Método que inyecta los parseadores |
||
| 514 | */ |
||
| 515 | private function addTemplateTokens() |
||
| 521 | |||
| 522 | /** |
||
| 523 | * Método que inyecta las optimizaciones al motor de la plantilla |
||
| 524 | */ |
||
| 525 | private function optimizeTemplates() |
||
| 530 | |||
| 531 | /** |
||
| 532 | * Method that extract all path tag for extracting translations |
||
| 533 | * @param array $domains |
||
| 534 | * |
||
| 535 | * @return array |
||
| 536 | */ |
||
| 537 | private function parsePathTranslations($domains) |
||
| 551 | |||
| 552 | /** |
||
| 553 | * Method that generate all template caches |
||
| 554 | */ |
||
| 555 | private function generateTemplatesCache() |
||
| 566 | } |
||
| 567 |
Loading history...
This check looks for assignments to scalar types that may be of the wrong type.
To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.