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 EMTBase 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 EMTBase, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | class EMTBase |
||
| 18 | {
|
||
| 19 | private $_text = ""; |
||
| 20 | private $inited = false; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * Список Трэтов, которые надо применить к типогрфированию |
||
| 24 | * |
||
| 25 | * @var array |
||
| 26 | */ |
||
| 27 | protected $trets = array() ; |
||
| 28 | protected $trets_index = array() ; |
||
| 29 | protected $tret_objects = array() ; |
||
| 30 | |||
| 31 | public $ok = false; |
||
| 32 | public $debug_enabled = false; |
||
| 33 | public $logging = false; |
||
| 34 | public $logs = array(); |
||
| 35 | public $errors = array(); |
||
| 36 | public $debug_info = array(); |
||
| 37 | |||
| 38 | private $use_layout = false; |
||
| 39 | private $class_layout_prefix = false; |
||
| 40 | private $use_layout_set = false; |
||
| 41 | public $disable_notg_replace = false; |
||
| 42 | public $remove_notg = false; |
||
| 43 | |||
| 44 | public $settings = array(); |
||
| 45 | |||
| 46 | protected function log($str, $data = null) |
||
| 51 | |||
| 52 | protected function tret_log($tret, $str, $data = null) |
||
| 56 | |||
| 57 | protected function error($info, $data = null) |
||
| 62 | |||
| 63 | protected function tret_error($tret, $info, $data = null) |
||
| 67 | |||
| 68 | protected function debug($class, $place, &$after_text, $after_text_raw = "") |
||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | protected $_safe_blocks = array(); |
||
| 83 | |||
| 84 | |||
| 85 | /** |
||
| 86 | * Включить режим отладки, чтобы посмотреть последовательность вызовов |
||
| 87 | * третов и правил после |
||
| 88 | * |
||
| 89 | */ |
||
| 90 | public function debug_on() |
||
| 94 | |||
| 95 | /** |
||
| 96 | * Включить режим отладки, чтобы посмотреть последовательность вызовов |
||
| 97 | * третов и правил после |
||
| 98 | * |
||
| 99 | */ |
||
| 100 | public function log_on() |
||
| 104 | |||
| 105 | /** |
||
| 106 | * Добавление защищенного блока |
||
| 107 | * |
||
| 108 | * <code> |
||
| 109 | * Jare_Typograph_Tool::addCustomBlocks('<span>', '</span>');
|
||
| 110 | * Jare_Typograph_Tool::addCustomBlocks('\<nobr\>', '\<\/span\>', true);
|
||
| 111 | * </code> |
||
| 112 | * |
||
| 113 | * @param string $id идентификатор |
||
| 114 | * @param string $open начало блока |
||
| 115 | * @param string $close конец защищенного блока |
||
| 116 | * @param string $tag тэг |
||
| 117 | * @return void |
||
| 118 | */ |
||
| 119 | private function _add_safe_block($id, $open, $close, $tag) |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Список защищенных блоков |
||
| 131 | * |
||
| 132 | * @return array |
||
| 133 | */ |
||
| 134 | public function get_all_safe_blocks() |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Удаленного блока по его номеру ключа |
||
| 141 | * |
||
| 142 | * @param string $id идентифиактор защищённого блока |
||
| 143 | * @return void |
||
| 144 | */ |
||
| 145 | public function remove_safe_block($id) |
||
| 151 | |||
| 152 | |||
| 153 | /** |
||
| 154 | * Добавление защищенного блока |
||
| 155 | * |
||
| 156 | * @param string $tag тэг, который должен быть защищён |
||
| 157 | * @return void |
||
| 158 | */ |
||
| 159 | public function add_safe_tag($tag) |
||
| 166 | |||
| 167 | |||
| 168 | /** |
||
| 169 | * Добавление защищенного блока |
||
| 170 | * |
||
| 171 | * @param string $open начало блока |
||
| 172 | * @param string $close конец защищенного блока |
||
| 173 | * @param bool $quoted специальные символы в начале и конце блока экранированы |
||
| 174 | * @return void |
||
| 175 | */ |
||
| 176 | public function add_safe_block($id, $open, $close, $quoted = false) |
||
| 195 | |||
| 196 | |||
| 197 | /** |
||
| 198 | * Сохранение содержимого защищенных блоков |
||
| 199 | * |
||
| 200 | * @param string $text |
||
| 201 | * @param bool $safe если true, то содержимое блоков будет сохранено, иначе - раскодировано. |
||
|
|
|||
| 202 | * @return string |
||
| 203 | */ |
||
| 204 | public function safe_blocks($text, $way, $show = true) |
||
| 218 | |||
| 219 | |||
| 220 | /** |
||
| 221 | * Декодирование блоков, которые были скрыты в момент типографирования |
||
| 222 | * |
||
| 223 | * @param string $text |
||
| 224 | * @return string |
||
| 225 | */ |
||
| 226 | public function decode_internal_blocks($text) |
||
| 230 | |||
| 231 | |||
| 232 | private function create_object($tret) |
||
| 259 | |||
| 260 | private function get_short_tret($tretname) |
||
| 268 | |||
| 269 | private function _init() |
||
| 289 | |||
| 290 | |||
| 291 | |||
| 292 | |||
| 293 | |||
| 294 | /** |
||
| 295 | * Инициализация класса, используется чтобы задать список третов или |
||
| 296 | * спсиок защищённых блоков, которые можно использовать. |
||
| 297 | * Такде здесь можно отменить защищённые блоки по умлочнаию |
||
| 298 | * |
||
| 299 | */ |
||
| 300 | public function init() |
||
| 304 | |||
| 305 | /** |
||
| 306 | * Добавить Трэт, |
||
| 307 | * |
||
| 308 | * @param mixed $class - имя класса трета, или сам объект |
||
| 309 | * @param string $altname - альтернативное имя, если хотим например иметь два одинаоковых терта в обработке |
||
| 310 | * @return unknown |
||
| 311 | */ |
||
| 312 | public function add_tret($class, $altname = false) |
||
| 340 | |||
| 341 | /** |
||
| 342 | * Получаем ТРЕТ по идентивикатору, т.е. заванию класса |
||
| 343 | * |
||
| 344 | * @param unknown_type $name |
||
| 345 | */ |
||
| 346 | public function get_tret($name) |
||
| 365 | |||
| 366 | /** |
||
| 367 | * Задаём текст для применения типографа |
||
| 368 | * |
||
| 369 | * @param string $text |
||
| 370 | */ |
||
| 371 | public function set_text($text) |
||
| 375 | |||
| 376 | |||
| 377 | |||
| 378 | /** |
||
| 379 | * Запустить типограф на выполнение |
||
| 380 | * |
||
| 381 | */ |
||
| 382 | public function apply($trets = null) |
||
| 471 | |||
| 472 | /** |
||
| 473 | * Получить содержимое <style></style> при использовании классов |
||
| 474 | * |
||
| 475 | * @param bool $list false - вернуть в виде строки для style или как массив |
||
| 476 | * @param bool $compact не выводить пустые классы |
||
| 477 | * @return string|array |
||
| 478 | */ |
||
| 479 | public function get_style($list = false, $compact = false) |
||
| 503 | |||
| 504 | |||
| 505 | |||
| 506 | |||
| 507 | |||
| 508 | /** |
||
| 509 | * Установить режим разметки, |
||
| 510 | * EMTLib::LAYOUT_STYLE - с помощью стилей |
||
| 511 | * EMTLib::LAYOUT_CLASS - с помощью классов |
||
| 512 | * EMTLib::LAYOUT_STYLE|EMTLib::LAYOUT_CLASS - оба метода |
||
| 513 | * |
||
| 514 | * @param int $layout |
||
| 515 | */ |
||
| 516 | public function set_tag_layout($layout = EMTLib::LAYOUT_STYLE) |
||
| 521 | |||
| 522 | /** |
||
| 523 | * Установить префикс для классов |
||
| 524 | * |
||
| 525 | * @param string|bool $prefix если true то префикс 'emt_', иначе то, что передали |
||
| 526 | */ |
||
| 527 | public function set_class_layout_prefix($prefix ) |
||
| 531 | |||
| 532 | /** |
||
| 533 | * Включить/отключить правила, согласно карте |
||
| 534 | * Формат карты: |
||
| 535 | * 'Название трэта 1' => array ( 'правило1', 'правило2' , ... ) |
||
| 536 | * 'Название трэта 2' => array ( 'правило1', 'правило2' , ... ) |
||
| 537 | * |
||
| 538 | * @param array $map |
||
| 539 | * @param boolean $disable если ложно, то $map соотвествует тем правилам, которые надо включить |
||
| 540 | * иначе это список правил, которые надо выключить |
||
| 541 | * @param boolean $strict строго, т.е. те которые не в списку будут тоже обработаны |
||
| 542 | */ |
||
| 543 | public function set_enable_map($map, $disable = false, $strict = true) |
||
| 576 | |||
| 577 | |||
| 578 | /** |
||
| 579 | * Установлена ли настройка |
||
| 580 | * |
||
| 581 | * @param string $key |
||
| 582 | */ |
||
| 583 | public function is_on($key) |
||
| 589 | |||
| 590 | |||
| 591 | /** |
||
| 592 | * Установить настройку |
||
| 593 | * |
||
| 594 | * @param mixed $selector |
||
| 595 | * @param string $setting |
||
| 596 | * @param mixed $value |
||
| 597 | */ |
||
| 598 | protected function doset($selector, $key, $value) |
||
| 646 | |||
| 647 | |||
| 648 | /** |
||
| 649 | * Установить настройки для тертов и правил |
||
| 650 | * 1. если селектор является массивом, то тогда утсановка правил будет выполнена для каждого |
||
| 651 | * элемента этого массива, как отдельного селектора. |
||
| 652 | * 2. Если $key не является массивом, то эта настрока будет проставлена согласно селектору |
||
| 653 | * 3. Если $key массив - то будет задана группа настроек |
||
| 654 | * - если $value массив , то настройки определяются по ключам из массива $key, а значения из $value |
||
| 655 | * - иначе, $key содержит ключ-значение как массив |
||
| 656 | * |
||
| 657 | * @param mixed $selector |
||
| 658 | * @param mixed $key |
||
| 659 | * @param mixed $value |
||
| 660 | */ |
||
| 661 | public function set($selector, $key , $value = false) |
||
| 685 | |||
| 686 | |||
| 687 | /** |
||
| 688 | * Возвращает список текущих третов, которые установлены |
||
| 689 | * |
||
| 690 | */ |
||
| 691 | public function get_trets_list() |
||
| 695 | |||
| 696 | /** |
||
| 697 | * Установка одной метанастройки |
||
| 698 | * |
||
| 699 | * @param string $name |
||
| 700 | * @param mixed $value |
||
| 701 | */ |
||
| 702 | public function do_setup($name, $value) |
||
| 706 | |||
| 707 | |||
| 708 | /** |
||
| 709 | * Установить настройки |
||
| 710 | * |
||
| 711 | * @param array $setupmap |
||
| 712 | */ |
||
| 713 | public function setup($setupmap) |
||
| 746 | |||
| 747 | |||
| 748 | |||
| 749 | |||
| 750 | } |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italyis not defined by the methodfinale(...).The most likely cause is that the parameter was removed, but the annotation was not.