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 Model 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 Model, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 8 | abstract class Model |
||
|
|
|||
| 9 | { |
||
| 10 | public static $is_logue = false; |
||
| 11 | protected static $dbInstance = null; |
||
| 12 | protected $errors = array(); |
||
| 13 | protected $nombre_ligne; // pour l'affichage du nombre de lignes des listes (utilisés dans les Xobjets) |
||
| 14 | protected $log_id; |
||
| 15 | private static $session; |
||
| 16 | public $requete; |
||
| 17 | |||
| 18 | public function getIsLogue() |
||
| 22 | |||
| 23 | public function setIsLogue($bool = false) |
||
| 28 | |||
| 29 | /* ********** |
||
| 30 | * Créateur * |
||
| 31 | ********** */ |
||
| 32 | /** |
||
| 33 | * Crée une instance de classe avec les paramètres transmis |
||
| 34 | * Typiquement $_REQUEST d'un formulaire |
||
| 35 | **/ |
||
| 36 | public function __construct($params = array()) |
||
| 46 | |||
| 47 | public function getAttributes() |
||
| 51 | |||
| 52 | /** |
||
| 53 | * cette fonction est appelée au tout début du constructeur. |
||
| 54 | * elle est principalement utilisée pour la gestion des cases à cocher qui doivent être décochée |
||
| 55 | * si elles ne sont pas envoyée dans le $_POST du formulaire. |
||
| 56 | */ |
||
| 57 | public function initialisationVariablesAvantContructeur() |
||
| 61 | |||
| 62 | /** |
||
| 63 | * Retourne le nom du controller associé à la classe appelante |
||
| 64 | * @return string : Le nom du controleur |
||
| 65 | */ |
||
| 66 | public static function getControllerName() |
||
| 74 | |||
| 75 | /** |
||
| 76 | * transforme un objet en tableau |
||
| 77 | */ |
||
| 78 | public function objectToTable($objet) |
||
| 86 | |||
| 87 | /** |
||
| 88 | * transforme un objet en tableau sans recupérer l'id |
||
| 89 | */ |
||
| 90 | public function objectToTableSansId($objet) |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Crée une instance d'un modèle avec les paramètres transmis |
||
| 103 | * Typiquement le résultat d'une requète |
||
| 104 | * @param array $params : Données de l'objet |
||
| 105 | * @param string $class_name : Type d'objet |
||
| 106 | * @return Object |
||
| 107 | */ |
||
| 108 | protected static function create($params, $class_name) |
||
| 116 | |||
| 117 | /* ************************* |
||
| 118 | * Affichage et convertion * |
||
| 119 | ************************* */ |
||
| 120 | /** |
||
| 121 | * Retourne une classe sous forme de chaîne |
||
| 122 | **/ |
||
| 123 | public function __toString() |
||
| 129 | |||
| 130 | /** |
||
| 131 | * Convertit une collection en tableau |
||
| 132 | * @param {Array} La collection |
||
| 133 | * @param {Integer} L'attribut à mettre dans les index du tableau |
||
| 134 | * @param {Integer} L'attribut ou les attributs (tableau) à mettre dans les valeurs du tableau |
||
| 135 | **/ |
||
| 136 | public static function arrayFromCollection($collection, $element_value, $element_text) |
||
| 152 | |||
| 153 | /** |
||
| 154 | * Convertit un objet en tableau |
||
| 155 | * @param {Array} La collection |
||
| 156 | **/ |
||
| 157 | public function arrayFromObject() |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Crée des objets à partir d'une matrice (typiquement le résultat d'une requète) |
||
| 168 | */ |
||
| 169 | protected static function objectsFromMatrix($matrix, $class_name, $modeIterator = true) |
||
| 185 | |||
| 186 | public static function objectsFromArray($array, $class_name) |
||
| 190 | |||
| 191 | protected static function objectsFromMatrixByAttribute($matrix, $class_name, $attribute = 'id') |
||
| 202 | |||
| 203 | /** |
||
| 204 | * Retourne tous les éléments éventuellement filtrés de la table |
||
| 205 | * @param array $where : [OPT] Un tableau de tous les filtres éventuels |
||
| 206 | * @param array $options : [OPT] Options disponibles : |
||
| 207 | * - order : Tri sur la requête |
||
| 208 | * - findOne : Utilisé pour déterminer qu'on ne recherche qu'un résultat |
||
| 209 | * (TODO pour afficher les objets supprimés, ça ressemble à un doublon, fonctionnement ésotérique...) |
||
| 210 | * - afficher_supprimes : TODO vérifier si c'est vraiment utilisé, apparement non |
||
| 211 | * Seulement MySQL |
||
| 212 | * - limit : Pagination |
||
| 213 | * Seulement MSSQL |
||
| 214 | * - top : Semi-pagination qui ne passe pas par la sous-vue |
||
| 215 | * - paging : C'est un tableau composé de numero_page et nb_element |
||
| 216 | * Utilisé pour simuler une pagination grace à une sous-vue |
||
| 217 | * @return array[object] |
||
| 218 | */ |
||
| 219 | public static function findAll($where = array(), $options = array()) |
||
| 241 | |||
| 242 | /** |
||
| 243 | * Retourne un élément grâce à son ID |
||
| 244 | * @param int $id : Un identifiant |
||
| 245 | * @return null|object |
||
| 246 | */ |
||
| 247 | public static function findOne($id) |
||
| 262 | |||
| 263 | /** |
||
| 264 | * Retourne le premier élément d'un findAll |
||
| 265 | * @param array $where : [OPT] Un tableau de tous les filtres éventuels |
||
| 266 | * @param string $order : [OPT] Le champ sur lequel ordonner |
||
| 267 | * @return false|object |
||
| 268 | */ |
||
| 269 | public static function findFirst($where = array(), $order = '') |
||
| 284 | |||
| 285 | /** |
||
| 286 | * Retourne le nombre d'éléments d'une requête |
||
| 287 | * @param array $where : Un tableau de clauses pour la requête |
||
| 288 | * @return int : Le nombre d'éléments |
||
| 289 | */ |
||
| 290 | public static function count($where = array()) |
||
| 295 | |||
| 296 | |||
| 297 | /** |
||
| 298 | * Supprime l'objet dans la base de données |
||
| 299 | * @return bool : Le résultat du traitement, VRAI si suppression |
||
| 300 | * @todo : Supprimer les objets liés |
||
| 301 | */ |
||
| 302 | public function delete() |
||
| 308 | |||
| 309 | /** |
||
| 310 | * si la table de l'objet contient un champ date_suppression, |
||
| 311 | * et qu'il ne faut afficher que les données non supprimées par défaut |
||
| 312 | * alors réécrire cette fonction dans l'objet avec return true |
||
| 313 | * @return bool |
||
| 314 | */ |
||
| 315 | public static function afficherParDefautNonSupprimes() |
||
| 319 | |||
| 320 | /** |
||
| 321 | * si la table de l'objet contient un champ visible, et qu'il ne faut afficher que les données visibles par défaut |
||
| 322 | * alors réécrire cette fonction dans l'objet avec return true |
||
| 323 | * @return bool |
||
| 324 | */ |
||
| 325 | public static function afficherParDefautDataVisibles() |
||
| 329 | |||
| 330 | |||
| 331 | /* ************************** |
||
| 332 | * Requète et SQL générique * |
||
| 333 | ************************** */ |
||
| 334 | /** |
||
| 335 | * Trouve tous les enregistrements d'une table donnée |
||
| 336 | * @param string $table : Le nom de la table |
||
| 337 | * @param array $where :Un tableau de conditions |
||
| 338 | * @param array $options : L'ordre, le limit, ... |
||
| 339 | * @return array : Tableau contenant les objets |
||
| 340 | */ |
||
| 341 | protected static function findAllFromTable($table, $where = array(), $options = array()) |
||
| 364 | |||
| 365 | /** |
||
| 366 | * Retourne un tableau avec l'ID de la DMD et un attribut |
||
| 367 | * --> utilsié pour alléger les menus déroulant de l'application |
||
| 368 | * @param {Array} un tableau de tous les filtres éventuels |
||
| 369 | * @param {string} le champ sur lequel ordonner |
||
| 370 | **/ |
||
| 371 | View Code Duplication | public static function findAllAttributeFromTable($table, $attribute, $where = array(), $options = array()) |
|
| 392 | |||
| 393 | View Code Duplication | public static function findAllAttributeFromLeftJoinTable( |
|
| 419 | |||
| 420 | /** |
||
| 421 | * Retourne le nombre d'éléments d'une requéte pour une table donnée |
||
| 422 | * @param {string} Le nom de la table |
||
| 423 | * @param {Array} un tableau de condititions |
||
| 424 | **/ |
||
| 425 | protected static function countFromTable($table, $where = array(), $options = array()) |
||
| 437 | |||
| 438 | /** |
||
| 439 | * Retourne la somme des valeurs d'une colonne pour une table et une colonne donnée |
||
| 440 | * @param {string} Le nom de la table |
||
| 441 | * @param {string} le nom de la colonne à sommer |
||
| 442 | * @param {Array} un tableau de condition |
||
| 443 | * @param {Array} un tableau d'options |
||
| 444 | * @return mixed La somme si pas de group by en option, un tableau de couple somme / valeur de la colonne sinon |
||
| 445 | **/ |
||
| 446 | protected static function sumFromTable($table, $colonne, $where = array(), $options = array()) |
||
| 461 | |||
| 462 | /** |
||
| 463 | * Supprime l'objet dans la base de données |
||
| 464 | * Place le champ supprime à 1 à la place si le champ est présent dans la table |
||
| 465 | * @param string $table : Le nom de la table |
||
| 466 | * @return bool : VRAI si la suppression est effectuée |
||
| 467 | */ |
||
| 468 | protected function deleteFromTable($table) |
||
| 512 | |||
| 513 | /** |
||
| 514 | * Retourne l'instance de base de données du controlleur actif |
||
| 515 | * @return \FMUP\Db |
||
| 516 | */ |
||
| 517 | public static function getDb() |
||
| 524 | |||
| 525 | public static function setDb($dbInstance) |
||
| 529 | |||
| 530 | /* ************************ |
||
| 531 | * Sauvegarde des données * |
||
| 532 | ************************ */ |
||
| 533 | /** |
||
| 534 | * Sauvegarde ou met à jour l'objet dans la base de donnée |
||
| 535 | * @param bool $force_enregistrement |
||
| 536 | * si TRUE, alors le système contrepasse le VALIDATE et enregistre quand même l'objet |
||
| 537 | * (ATTENTION à l'utilisation de ce paramètre) |
||
| 538 | * @return bool |
||
| 539 | * VRAI si une action a eu lieu en base (si la requête ne change rien ou le validate bloque, retourne FAUX) |
||
| 540 | * @throws \FMUP\Exception |
||
| 541 | */ |
||
| 542 | public function save($force_enregistrement = false) |
||
| 568 | |||
| 569 | /** |
||
| 570 | * Insertion d'un objet en base |
||
| 571 | * @return bool |
||
| 572 | */ |
||
| 573 | abstract protected function insert(); |
||
| 574 | |||
| 575 | /** |
||
| 576 | * Mise à jour d'un objet en base |
||
| 577 | * @return bool |
||
| 578 | */ |
||
| 579 | abstract protected function update(); |
||
| 580 | |||
| 581 | /** |
||
| 582 | * Le message affiché à l'update |
||
| 583 | */ |
||
| 584 | public static function getMessageUpdateOK() |
||
| 588 | |||
| 589 | /** |
||
| 590 | * Le message affiché à la suppression |
||
| 591 | */ |
||
| 592 | public static function getMessageSuppressionOK() |
||
| 596 | |||
| 597 | /* *************************************** |
||
| 598 | * gestion des créateur et modificateurs * |
||
| 599 | * d'objet en base * |
||
| 600 | *************************************** */ |
||
| 601 | |||
| 602 | /** |
||
| 603 | * Retourne le createur de l'objet |
||
| 604 | * @return Utilisateur |
||
| 605 | */ |
||
| 606 | public function getCreateur() |
||
| 614 | |||
| 615 | /** |
||
| 616 | * Retourne le dernier modificateur de l'objet |
||
| 617 | * @return Utilisateur |
||
| 618 | */ |
||
| 619 | public function getModificateur() |
||
| 627 | |||
| 628 | /** |
||
| 629 | * Modifie le champ date_creation par la date actuelle |
||
| 630 | **/ |
||
| 631 | public function setDateCreation($value = null) |
||
| 642 | |||
| 643 | /** |
||
| 644 | * Modifie le champ createur par la personne connectée |
||
| 645 | **/ |
||
| 646 | public function setIdCreateur($value = 0) |
||
| 658 | |||
| 659 | /** |
||
| 660 | * Modifie le champ date de dernière modification par la date actuelle |
||
| 661 | **/ |
||
| 662 | public function setDateModification($value = null) |
||
| 667 | |||
| 668 | /** |
||
| 669 | * Modifie le champ dernier modificateur par la personne connectée |
||
| 670 | **/ |
||
| 671 | public function setIdModificateur($value = 0) |
||
| 686 | |||
| 687 | /* ****************************** |
||
| 688 | * Affichage d'infos et erreurs * |
||
| 689 | ****************************** */ |
||
| 690 | |||
| 691 | /** |
||
| 692 | * Réinitialise le tableau d'erreurs |
||
| 693 | */ |
||
| 694 | public function initialiseErrors() |
||
| 698 | |||
| 699 | /** |
||
| 700 | * Retourne les erreurs de validation d'un objet |
||
| 701 | * @param string $attribute : [OPT] Pour vérifier les erreurs sur un atribut en particulier |
||
| 702 | * @return array |
||
| 703 | */ |
||
| 704 | public function getErrors($attribute = false) |
||
| 717 | |||
| 718 | /* |
||
| 719 | * Fonction utilisée par les demandes et commandes afin de trouver les différences |
||
| 720 | * par rapport a une version modifiée |
||
| 721 | */ |
||
| 722 | public function compareVersion() |
||
| 726 | |||
| 727 | |||
| 728 | /** |
||
| 729 | * Met à jour le tableau des erreurs d'un objet. |
||
| 730 | * @param {Array} $errors Le tableau d'erreurs à ajouter. |
||
| 731 | * @return true |
||
| 732 | */ |
||
| 733 | public function setErrors($errors) |
||
| 738 | |||
| 739 | /* ********************* |
||
| 740 | * Accesseurs généraux * |
||
| 741 | ********************* */ |
||
| 742 | /** |
||
| 743 | * Retourne la valeur d'un attribut si il existe |
||
| 744 | * @param {String} l'attribut auquel accéder |
||
| 745 | **/ |
||
| 746 | public function getAttribute($attribute) |
||
| 750 | |||
| 751 | /** |
||
| 752 | * Modifie la valeur d'un attribut si il existe |
||
| 753 | * @param {String} l'attribut auquel accéder |
||
| 754 | * @param {string} la valeur à enregistrer |
||
| 755 | **/ |
||
| 756 | public function setAttribute($attribute, $value) |
||
| 761 | |||
| 762 | /** |
||
| 763 | * Met à jour un objet (*sans* l'enregistrer dans la base de données) avec de |
||
| 764 | * nouveaux paramètres |
||
| 765 | * @param {Array} un tableau de nouvelles valeurs |
||
| 766 | **/ |
||
| 767 | public function modify($params) |
||
| 773 | |||
| 774 | /** |
||
| 775 | * Retourne ou modifie la valeur d'un attribut |
||
| 776 | * @param string $function : L'attribut auquel accéder |
||
| 777 | * @param string $argument : [OPT] La valeur à affecter dans le cas d'une affectation |
||
| 778 | * @return mixed|bool|null : L'argument demandée pour une lecture, VRAI si affectation réussie, null sinon |
||
| 779 | */ |
||
| 780 | public function __call($function, $argument = array()) |
||
| 802 | |||
| 803 | /** |
||
| 804 | * Retourne l'id de l'objet |
||
| 805 | **/ |
||
| 806 | /*public function getId() |
||
| 807 | { |
||
| 808 | return $this->id; |
||
| 809 | }*/ |
||
| 810 | |||
| 811 | /** |
||
| 812 | * Retourne le code langue de l'utilisateur |
||
| 813 | **/ |
||
| 814 | public function getCodeLangue() |
||
| 818 | |||
| 819 | /* ********************* |
||
| 820 | * Sécurisation des * |
||
| 821 | * éditions * |
||
| 822 | ***********************/ |
||
| 823 | |||
| 824 | /** |
||
| 825 | * Renvoi le tableau des champs autorisés |
||
| 826 | * pour l'utilisateur en cours |
||
| 827 | * |
||
| 828 | * @return tableau des champs autorisés |
||
| 829 | */ |
||
| 830 | public function listeChampsModifiable() |
||
| 834 | |||
| 835 | /** |
||
| 836 | * Donne le droit à modifier l'objet mais par une méthode différente (non directe par l'attribut) |
||
| 837 | **/ |
||
| 838 | public function setIdNew($valeur = '') |
||
| 842 | |||
| 843 | /** |
||
| 844 | * Renvoi l'autorisation d'un champ pour l'utilisateur en cours |
||
| 845 | * |
||
| 846 | * @param champ à vérifier |
||
| 847 | * @return booléen d'autorisation |
||
| 848 | */ |
||
| 849 | public function isChampModifiable($champ) |
||
| 858 | |||
| 859 | /** |
||
| 860 | * @param Tableau des valeurs de l'objet typiquement $_POST |
||
| 861 | * @return l'objet |
||
| 862 | */ |
||
| 863 | public function setAttributesSecure($attributes) |
||
| 887 | |||
| 888 | public function setValeursDefautPostSave() |
||
| 891 | |||
| 892 | /* ********************* |
||
| 893 | * Logs * |
||
| 894 | ********************* */ |
||
| 895 | |||
| 896 | /** |
||
| 897 | * fonction utilisée pour récupérer la liste des champs (dans l'ordre) de la table pour les requete de log |
||
| 898 | * /!\ la clef primaire ID doit s'appeler 'id_objet_log' !!! |
||
| 899 | * @return string |
||
| 900 | */ |
||
| 901 | public static function listeChampsObjet() |
||
| 905 | |||
| 906 | /** |
||
| 907 | * Spécifie les champs de la table à comparer |
||
| 908 | * Retourne un taleau vide si tous les champs de la table à comparer |
||
| 909 | * @return Array $array |
||
| 910 | */ |
||
| 911 | public function fieldsToCompare() |
||
| 916 | |||
| 917 | /** |
||
| 918 | * Spécifie les champs à ne pas prendre en compte pour la comparaison |
||
| 919 | * Tableau non vide contenant tout le temps, au moins le champ id |
||
| 920 | * @return Array $array |
||
| 921 | */ |
||
| 922 | public function fieldsInException() |
||
| 928 | |||
| 929 | /** |
||
| 930 | * fonction de log |
||
| 931 | * @param $type_action |
||
| 932 | */ |
||
| 933 | public function logerChangement($type_action) |
||
| 985 | |||
| 986 | /** |
||
| 987 | * fonction permettant de comparer 2 tableaux de données d'un objet et sa sauvegarde en log |
||
| 988 | * et d'enregistrer les modifications effectuées |
||
| 989 | */ |
||
| 990 | public function comparerDifferences() |
||
| 1072 | |||
| 1073 | /** |
||
| 1074 | * formate les requetes de log |
||
| 1075 | */ |
||
| 1076 | public function getSqlLog($from = "") |
||
| 1091 | |||
| 1092 | /** |
||
| 1093 | * fonction permettant de récupérer sous forme de tableau les différences |
||
| 1094 | */ |
||
| 1095 | public static function returnArrayByJson($string = "") |
||
| 1099 | |||
| 1100 | /** |
||
| 1101 | * fonction permettant de récupérer les historiques tableau d'un objet |
||
| 1102 | */ |
||
| 1103 | public function getHistoriqueSurObjetDiffArray() |
||
| 1123 | |||
| 1124 | /* ************ |
||
| 1125 | * Validation * |
||
| 1126 | ************ */ |
||
| 1127 | /** |
||
| 1128 | * L'objet est-il enregistrable en base de données |
||
| 1129 | * @return bool |
||
| 1130 | */ |
||
| 1131 | abstract public function validate(); |
||
| 1132 | |||
| 1133 | /** |
||
| 1134 | * L'objet est-il effaçable |
||
| 1135 | * @return bool |
||
| 1136 | */ |
||
| 1137 | abstract public function canBeDeleted(); |
||
| 1138 | |||
| 1139 | /** |
||
| 1140 | * Détermine si notre objet est unique par rapport aux attributs donnés |
||
| 1141 | * @param mixed $attribut : Attribut (ou liste d'attribut, dans ce cas tableau) à comparer |
||
| 1142 | * @param array $where : [OPT] Clauses supplémentaires à prendre en compte pour notre recherche |
||
| 1143 | * @return bool : VRAI si aucun doublon est trouvé |
||
| 1144 | */ |
||
| 1145 | public function isUniqueAttribute($attribut, $where = array()) |
||
| 1160 | |||
| 1161 | /** |
||
| 1162 | * @param \FMUP\Session $session |
||
| 1163 | */ |
||
| 1164 | public static function setSession(\FMUP\Session $session) |
||
| 1168 | |||
| 1169 | /** |
||
| 1170 | * @return \FMUP\Session |
||
| 1171 | */ |
||
| 1172 | public static function getSession() |
||
| 1179 | |||
| 1180 | public static function hasSession() |
||
| 1184 | } |
||
| 1185 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.