mambax7 /
references
Complex classes like references_listFilter 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 references_listFilter, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 36 | class references_listFilter |
||
| 37 | { |
||
| 38 | const FILTER_DATA_TEXT = 1; |
||
| 39 | const FILTER_DATA_NUMERIC = 2; |
||
| 40 | |||
| 41 | const FILTER_FIELD_TEXT = 1; |
||
| 42 | const FILTER_FIELD_SELECT = 2; |
||
| 43 | const FILTER_FIELD_SELECT_YES_NO = 3; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * Préfixe des variables de sélection |
||
| 47 | */ |
||
| 48 | const PREFIX = 'filter_'; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Nom du module (utilisé pour la session) |
||
| 52 | */ |
||
| 53 | const MODULE_NAME = 'references'; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * Contient toutes les variables participant au filtre (avec leur type et description) |
||
| 57 | * |
||
| 58 | * @var array |
||
| 59 | */ |
||
| 60 | private $vars = array(); |
||
| 61 | |||
| 62 | /** |
||
| 63 | * Handler des données |
||
| 64 | * |
||
| 65 | * @var reference |
||
| 66 | */ |
||
| 67 | private $handler = null; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * Nom de la zone d'opération (par exemple op=products) |
||
| 71 | * |
||
| 72 | * @var string |
||
| 73 | */ |
||
| 74 | private $op = ''; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * action de l'opération en cour (par exemple op=products) |
||
| 78 | * |
||
| 79 | * @var string |
||
| 80 | */ |
||
| 81 | private $operationName = ''; |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Nombre maximum d'éléments pas page |
||
| 85 | * |
||
| 86 | * @var intger |
||
| 87 | */ |
||
| 88 | private $limit = 10; |
||
| 89 | |||
| 90 | /** |
||
| 91 | * Nom de la variable start |
||
| 92 | * |
||
| 93 | * @var string |
||
| 94 | */ |
||
| 95 | private $startName = ''; |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Critère {@link Criteria} servant à choisir les données |
||
| 99 | * |
||
| 100 | * @var object |
||
| 101 | */ |
||
| 102 | private $criteria = null; |
||
| 103 | |||
| 104 | /** |
||
| 105 | * Indique s'il y a un nouveau critère |
||
| 106 | * |
||
| 107 | * @var boolean |
||
| 108 | */ |
||
| 109 | private $newFilter = false; |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Indique si la méthode filter() a été appelée |
||
| 113 | * |
||
| 114 | * @var boolean |
||
| 115 | */ |
||
| 116 | private $isInitialized = false; |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Zone de tri pour retourner les données (dans getObjects) |
||
| 120 | * |
||
| 121 | * @var string |
||
| 122 | */ |
||
| 123 | private $sortField = ''; |
||
| 124 | |||
| 125 | /** |
||
| 126 | * Sens de tri |
||
| 127 | * |
||
| 128 | * @var string |
||
| 129 | */ |
||
| 130 | private $sortOrder = ''; |
||
| 131 | |||
| 132 | /** |
||
| 133 | * Liste de critères par défaut |
||
| 134 | * |
||
| 135 | * @var array |
||
| 136 | */ |
||
| 137 | private $defaultCriterias = array(); |
||
| 138 | |||
| 139 | /** |
||
| 140 | * L'url complète du script qui appelle |
||
| 141 | * |
||
| 142 | * @var string |
||
| 143 | */ |
||
| 144 | private $baseUrl = ''; |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Indique si on conserve en session la position de départ |
||
| 148 | * |
||
| 149 | * @var boolean |
||
| 150 | */ |
||
| 151 | private $keepStart = true; |
||
| 152 | |||
| 153 | /** |
||
| 154 | * Indique si l'autocomplétion est activée |
||
| 155 | * |
||
| 156 | * @var boolean |
||
| 157 | */ |
||
| 158 | private $hasAutoComplete = false; |
||
| 159 | |||
| 160 | /** |
||
| 161 | * Url du dossier js dans le module |
||
| 162 | * |
||
| 163 | * @var string |
||
| 164 | */ |
||
| 165 | private $jsFolderUrl = ''; |
||
| 166 | |||
| 167 | /** |
||
| 168 | * Paramètres additionnels à ajouter aux paramètres du pager |
||
| 169 | * @var array |
||
| 170 | */ |
||
| 171 | private $additionnalPagerParameters = array(); |
||
| 172 | |||
| 173 | /** |
||
| 174 | * Paramètres additionnels à ajouter au bouton permettant de supprimer le filtre en cours |
||
| 175 | * @var array |
||
| 176 | */ |
||
| 177 | private $additionnalClearButtonParameters = array(); |
||
| 178 | |||
| 179 | /** |
||
| 180 | * Tableau des champs triables [clé] = nom du champ dans la base, valeur = libellé |
||
| 181 | * @var array |
||
| 182 | */ |
||
| 183 | private $sortFields = array(); |
||
| 184 | |||
| 185 | /** |
||
| 186 | * Initialise les paramètres avec des valeurs par défaut |
||
| 187 | */ |
||
| 188 | private function setDefaultValues() |
||
| 205 | |||
| 206 | /** |
||
| 207 | * Initialisation des données, handler et opération courante dans l'appelant |
||
| 208 | * |
||
| 209 | * @param mixed $handler Soit une référence au handler de données soit un tableau qui contient toutes les options (auxquel cas les autres paramètres sont inutiles) |
||
| 210 | * @param string $operationName |
||
| 211 | * @param string $operation Opération courante dans l'appelant |
||
| 212 | * @param string $startName Nom du paramètre start |
||
| 213 | * @param integer $limit Nombre maximum d'éléments par page |
||
| 214 | * @param string $baseUrl L'url complète du script appelant |
||
| 215 | * @param string $sortField Zone de tri |
||
| 216 | * @param string $sortOrder Sens de tri |
||
| 217 | * @param boolean $keepStart Indique si on conserve la position de départ |
||
| 218 | * @param string $jsFolderUrl |
||
| 219 | * @package string $jsFolderUrl Url du répertoire qui contient les scripts Javascript |
||
| 220 | */ |
||
| 221 | public function __construct($handler, $operationName = 'op', $operation = '', $startName = 'start', $limit = 10, $baseUrl = '', $sortField = '', $sortOrder = 'asc', $keepStart = true, $jsFolderUrl = '') |
||
| 241 | |||
| 242 | /** |
||
| 243 | * Donne à la classe le nom des champs sur lesquels on peut faire le tri |
||
| 244 | * |
||
| 245 | * @param array $fields [clé] = nom du champ dans la base, valeur = libellé |
||
| 246 | * @return object |
||
| 247 | */ |
||
| 248 | public function setSortFields($fields) |
||
| 252 | |||
| 253 | /** |
||
| 254 | * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri) |
||
| 255 | * |
||
| 256 | * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri |
||
| 257 | */ |
||
| 258 | private function getSortPlaceHolderNames() |
||
| 262 | |||
| 263 | /** |
||
| 264 | * Retourne 2 sélecteurs html pour choisir la zone de tri et le sens du tri |
||
| 265 | * |
||
| 266 | * @return string |
||
| 267 | */ |
||
| 268 | public function getSortPlaceHolderHtmlCode() |
||
| 276 | |||
| 277 | /** |
||
| 278 | * Permet de valoriser une option directement tout en chainant |
||
| 279 | * |
||
| 280 | * @param string $optionName |
||
| 281 | * @param mixed $optionValue |
||
| 282 | * @return object |
||
| 283 | */ |
||
| 284 | public function setOption($optionName, $optionValue) |
||
| 290 | |||
| 291 | /** |
||
| 292 | * Ajoute un nouveau critère par défaut à la liste des critères par défaut |
||
| 293 | * |
||
| 294 | * @param Criteria $criteria |
||
| 295 | */ |
||
| 296 | public function addDefaultCriteria(Criteria $criteria) |
||
| 300 | |||
| 301 | /** |
||
| 302 | * Retourne une valeur d'un tableau ou null si l'index n'existe pas |
||
| 303 | * |
||
| 304 | * @param array $array Le tableau à traiter |
||
| 305 | * @param string $index L'index recherché |
||
| 306 | * @param mixed $defaultValue La valeur par défaut |
||
| 307 | * @return mixed |
||
| 308 | */ |
||
| 309 | private function getArrayValue($array, $index, $defaultValue = false) |
||
| 317 | |||
| 318 | /** |
||
| 319 | * Permet de faire l'autocomplétion d'un champ |
||
| 320 | * |
||
| 321 | * @param string $query |
||
| 322 | * @param $limit |
||
| 323 | * @param string $fieldName |
||
| 324 | * @return string |
||
| 325 | */ |
||
| 326 | public function autoComplete($query, $limit, $fieldName) |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Retourne le code Javascript à utiliser pour initialiser l'auto complétion (et donc à coller dans le code html) |
||
| 354 | * |
||
| 355 | * @param boolean $jqueryAlreadyLoaded Indique si jQuery est déjà chargé par l'appelant, auquel cas rien ne sert de le recharger |
||
| 356 | * @return string |
||
| 357 | */ |
||
| 358 | public function getJavascriptInitCode($jqueryAlreadyLoaded = false) |
||
| 393 | |||
| 394 | /** |
||
| 395 | * Initialisation des données du filtre |
||
| 396 | * Permet d'indiquer quelles sont les zones sur lesquelles on effectue des filtres ainsi que leur type |
||
| 397 | * |
||
| 398 | * @param string $fieldName Le nom du champs dans la table |
||
| 399 | * @param array $parameters Les paramètres de la zone sous la forme d'un tableau : |
||
| 400 | * [dataType] Entier représentant le type de donnée (numérique ou chaine) |
||
| 401 | * [fieldType] Le type de zone de saisie (zone de texte, liste déroulante, liste déroulante Oui/Non) |
||
| 402 | * [values] La ou les valeurs de la zone de saisie (utilisé dans le cas d'un select) |
||
| 403 | * [size] Largeur d'affichage pour les textbox |
||
| 404 | * [maxLength] Largeur maximale pour les textbox |
||
| 405 | * [withNull] Dans le cas des listes déroulantes, indique s'il faut une valeur nulle |
||
| 406 | * [minusOne] Indique s'il faut retrancher 1 à la valeur saisie récupérée (cas classique des listes Oui/Non avec une valeur nulle) |
||
| 407 | * [style] Dans le cas des liste déroulante, le style à appliquer à la liste |
||
| 408 | * [data] A ne pas renseigner, contient la valeur saisie par l'utilisateur |
||
| 409 | * [operator] Opérateur de comparaison pour le Criteria |
||
| 410 | * [autoComplete] Indique si on active l'auto complétion sur le champs |
||
| 411 | * @return object L'objet courant pour pouvoir chainer |
||
| 412 | */ |
||
| 413 | public function initFilter($fieldName, $parameters) |
||
| 425 | |||
| 426 | /** |
||
| 427 | * Retourne le nom du tableau à utiliser pour la session |
||
| 428 | * @note : Le nom de la session est composé de : nom du module_nom du handler, par exemple references_references_articles |
||
| 429 | * |
||
| 430 | * @return string |
||
| 431 | */ |
||
| 432 | private function getSessionName() |
||
| 436 | |||
| 437 | /** |
||
| 438 | * Retourne le nom de la clé à utiliser pour la conservation du start en session |
||
| 439 | * |
||
| 440 | * @return string |
||
| 441 | */ |
||
| 442 | private function getStartSessionName() |
||
| 446 | |||
| 447 | /** |
||
| 448 | * Réinitialisation des données avant traitement |
||
| 449 | * |
||
| 450 | * @return void |
||
| 451 | */ |
||
| 452 | private function reinitializeFieldsValue() |
||
| 463 | |||
| 464 | /** |
||
| 465 | * Ajoute les critères par défaut au critère général |
||
| 466 | * |
||
| 467 | * @return void |
||
| 468 | */ |
||
| 469 | private function addDefaultCriterias() |
||
| 479 | |||
| 480 | /** |
||
| 481 | * Indique s'il y a des champs de tri |
||
| 482 | * |
||
| 483 | * @return boolean |
||
| 484 | */ |
||
| 485 | private function areThereSortFields() |
||
| 494 | |||
| 495 | /** |
||
| 496 | * Indique si le nom du champ passé en paramètre fait partie de la liste des champs "triables" |
||
| 497 | * |
||
| 498 | * @param string $fieldName |
||
| 499 | * @return boolean |
||
| 500 | */ |
||
| 501 | private function isInSortFieldsList($fieldName) |
||
| 505 | |||
| 506 | /** |
||
| 507 | * Indique si le sens de tri passé en paramètre fait partie de la liste autorisée |
||
| 508 | * |
||
| 509 | * @param string $order |
||
| 510 | * @return boolean |
||
| 511 | */ |
||
| 512 | private function isInSortOrderList($order) |
||
| 516 | |||
| 517 | /** |
||
| 518 | * Récupère, depuis la requête d'entrée, la zone de tri à utiliser et le sens du tri et place l'information en cookie |
||
| 519 | * pour que lorsque l'utilisateur se reconnecte, il retrouve ses informations de tri |
||
| 520 | * |
||
| 521 | * @return void |
||
| 522 | */ |
||
| 523 | private function setSortFieldsFromRequest() |
||
| 553 | |||
| 554 | /** |
||
| 555 | * Réinitialisation des données avant traitement |
||
| 556 | * |
||
| 557 | * @return void |
||
| 558 | */ |
||
| 559 | private function setupFilter() |
||
| 568 | |||
| 569 | /** |
||
| 570 | * RAZ des données du filtre si cela a été demandé dans la requête |
||
| 571 | * |
||
| 572 | * @return void |
||
| 573 | */ |
||
| 574 | private function isSetCleanFilter() |
||
| 581 | |||
| 582 | /** |
||
| 583 | * Retourne le critère de filtrage courant |
||
| 584 | * |
||
| 585 | * @return object |
||
| 586 | */ |
||
| 587 | public function getCriteria() |
||
| 591 | |||
| 592 | /** |
||
| 593 | * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies |
||
| 594 | * |
||
| 595 | * @return object L'objet courant pour pouvoir chainer |
||
| 596 | */ |
||
| 597 | public function filter() |
||
| 664 | |||
| 665 | /** |
||
| 666 | * Retourne le nombre d'enregistrement en fonction des critères courants |
||
| 667 | * |
||
| 668 | * @return integer |
||
| 669 | */ |
||
| 670 | public function getCount() |
||
| 678 | |||
| 679 | /** |
||
| 680 | * Conserve la valeur de start en session |
||
| 681 | * |
||
| 682 | * @param integer $start |
||
| 683 | * @return void |
||
| 684 | */ |
||
| 685 | private function setStartInSession($start) |
||
| 692 | |||
| 693 | /** |
||
| 694 | * Retourne la valeur de ?start=x |
||
| 695 | * |
||
| 696 | * @return integer |
||
| 697 | */ |
||
| 698 | private function getStartValue() |
||
| 714 | |||
| 715 | /** |
||
| 716 | * Permet d'ajouter un paramètre supplémentaire au pager |
||
| 717 | * |
||
| 718 | * @param string $key |
||
| 719 | * @param string $value |
||
| 720 | * @return object |
||
| 721 | */ |
||
| 722 | public function addAdditionnalParameterToPager($key, $value = '') |
||
| 728 | |||
| 729 | /** |
||
| 730 | * Permet d'ajouter un paramètre supplémentaire au bouton permettant de supprimer le filtre |
||
| 731 | * |
||
| 732 | * @param string $key |
||
| 733 | * @param string $value |
||
| 734 | * @return object |
||
| 735 | */ |
||
| 736 | public function addAdditionnalParameterToClearButton($key, $value = '') |
||
| 742 | |||
| 743 | /** |
||
| 744 | * Permet d'ajouter des paramètres supplémentaires au pager |
||
| 745 | * |
||
| 746 | * @param $array |
||
| 747 | * @return object |
||
| 748 | * @internal param string $key |
||
| 749 | * @internal param string $value |
||
| 750 | */ |
||
| 751 | public function addAditionnalArrayParametersToPager($array) |
||
| 761 | |||
| 762 | /** |
||
| 763 | * Retourne le pager à utiliser |
||
| 764 | * |
||
| 765 | * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav} |
||
| 766 | */ |
||
| 767 | public function getPager() |
||
| 797 | |||
| 798 | /** |
||
| 799 | * Retourne une liste d'objets en fonction des critères définis |
||
| 800 | * |
||
| 801 | * @return array |
||
| 802 | */ |
||
| 803 | public function getObjects() |
||
| 823 | |||
| 824 | /** |
||
| 825 | * Retourne la zone html à utiliser pour créer la zone de filtre (avec sa valeur saisie si c'est le cas) |
||
| 826 | * |
||
| 827 | * @param string $fieldName La zone de saisie dont on veut récupérer le code html |
||
| 828 | * @return string |
||
| 829 | */ |
||
| 830 | public function getFilterField($fieldName) |
||
| 865 | |||
| 866 | /** |
||
| 867 | * Assigne toutes les zones de filtre à un template |
||
| 868 | * |
||
| 869 | * @param object $xoopsTpl |
||
| 870 | * @param boolean $asArray Est-ce qu'il faut placer le résultat dans un tableau ou assigner par nom de zone de filtre |
||
| 871 | * @param string $arrayName Le nom du tableau à utiliser |
||
| 872 | * @return void |
||
| 873 | */ |
||
| 874 | public function assignFilterFieldsToTemplate(&$xoopsTpl, $asArray = true, $arrayName = 'filterFields') |
||
| 885 | |||
| 886 | /** |
||
| 887 | * Retourne le bouton utilisé pour supprimer le filtre en cours |
||
| 888 | * |
||
| 889 | * @return string |
||
| 890 | */ |
||
| 891 | public function getClearFilterbutton() |
||
| 905 | |||
| 906 | /** |
||
| 907 | * Retourne le bouton permettant de lancer le filtrage |
||
| 908 | * |
||
| 909 | * @param string $description Texte à faire apparaître sur le bouton |
||
| 910 | * @param array $additionnals Champs supplémentaires à faire apparaître avec le bouton |
||
| 911 | * @return string |
||
| 912 | */ |
||
| 913 | public function getGoButton($description = _GO, $additionnals = null) |
||
| 928 | |||
| 929 | /** |
||
| 930 | * Retourne le nom de la zone utilisée pour trier les données |
||
| 931 | * |
||
| 932 | * @return string |
||
| 933 | */ |
||
| 934 | public function getSortField() |
||
| 938 | |||
| 939 | /** |
||
| 940 | * Retourne le sens de tri utilisé pour trier les données |
||
| 941 | * |
||
| 942 | * @return string |
||
| 943 | */ |
||
| 944 | public function getSortOrder() |
||
| 948 | |||
| 949 | /** |
||
| 950 | * Retourne la valeur d'un champ |
||
| 951 | * |
||
| 952 | * @param string $fieldName |
||
| 953 | * @return mixed La valeur du champ ou null si on ne trouve pas la zone |
||
| 954 | */ |
||
| 955 | public function getFieldValue($fieldName) |
||
| 964 | } |
||
| 965 |
Loading history...
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..