mambax7 /
references
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:
| 1 | <?php |
||
| 26 | class references_plugins |
||
| 27 | { |
||
| 28 | /** |
||
| 29 | * Dictionnaire des évènements |
||
| 30 | */ |
||
| 31 | const EVENT_ON_REFERENCE_CREATE = 'onReferenceCreate'; |
||
| 32 | const EVENT_ON_CATEGORY_CREATE = 'onCategoryCreate'; |
||
| 33 | |||
| 34 | // Pour limiter les dépendances |
||
| 35 | const MODULE_DIRNAME = REFERENCES_DIRNAME; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * Types d'évènements |
||
| 39 | */ |
||
| 40 | const PLUGIN_ACTION = 0; |
||
| 41 | const PLUGIN_FILTER = 1; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Nom du script Php inclut qui contient l'inscription des plugins |
||
| 45 | */ |
||
| 46 | const PLUGIN_SCRIPT_NAME = 'plugins.php'; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Dans le fichier Php qui contient l'inscription des plugins, méthode à appeler pour récupérer la liste des plugins |
||
| 50 | */ |
||
| 51 | const PLUGIN_DESCRIBE_METHOD = 'registerEvents'; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * Nom de la variable de session qui contient la liste des plugins détachés |
||
| 55 | */ |
||
| 56 | const PLUGIN_UNPLUG_SESSION_NAME = 'references_plugins'; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * Priorités des plugins |
||
| 60 | * @var constant |
||
| 61 | */ |
||
| 62 | const EVENT_PRIORITY_1 = 1; // Priorité la plus haute |
||
| 63 | const EVENT_PRIORITY_2 = 2; |
||
| 64 | const EVENT_PRIORITY_3 = 3; |
||
| 65 | const EVENT_PRIORITY_4 = 4; |
||
| 66 | const EVENT_PRIORITY_5 = 5; // Priorité la plus basse |
||
| 67 | |||
| 68 | /** |
||
| 69 | * Utilisé pour construire le nom de la classe |
||
| 70 | */ |
||
| 71 | private $pluginsTypeLabel = array(self::PLUGIN_ACTION => 'Action', self::PLUGIN_FILTER => 'Filter'); |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Nom des classes qu'il faut étendre en tant que plugin |
||
| 75 | */ |
||
| 76 | private $pluginsClassName = array(self::PLUGIN_ACTION => 'references_action', self::PLUGIN_FILTER => 'references_filter'); |
||
| 77 | |||
| 78 | /** |
||
| 79 | * Nom de chacun des dossiers en fonction du type de plugin |
||
| 80 | */ |
||
| 81 | private $pluginsTypesFolder = array(self::PLUGIN_ACTION => 'actions', self::PLUGIN_FILTER => 'filters'); |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Contient l'unique instance de l'objet |
||
| 85 | * @var object |
||
| 86 | */ |
||
| 87 | private static $instance = false; |
||
| 88 | |||
| 89 | /** |
||
| 90 | * Liste des évènements |
||
| 91 | * @var array |
||
| 92 | */ |
||
| 93 | private static $events = array(); |
||
| 94 | |||
| 95 | /** |
||
| 96 | * Retourne l'instance unique de la classe |
||
| 97 | * |
||
| 98 | * @return object |
||
| 99 | */ |
||
| 100 | public static function getInstance() |
||
| 109 | |||
| 110 | /** |
||
| 111 | * Chargement des 2 types de plugins |
||
| 112 | * |
||
| 113 | */ |
||
| 114 | private function __construct() |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Chargement des plugins (actions et filtres) |
||
| 122 | * @return void |
||
| 123 | */ |
||
| 124 | public function loadPlugins() |
||
| 129 | |||
| 130 | /** |
||
| 131 | * Vérifie que le fichier Php passé en paramètre contient bien une classe de filtre ou d'action et si c'est le cas, le charge dans la liste des plugins |
||
| 132 | * @param string $fullPathName Chemin complet vers le fichier (répertoire + nom) |
||
| 133 | * @param integer $type Type de plugin recherché (action ou filtre) |
||
| 134 | * @param string $pluginFolder Le nom du répertoire dans lequel se trouve le fichier (le "dernier nom") |
||
| 135 | * @return void |
||
| 136 | */ |
||
| 137 | private function loadClass($fullPathName, $type, $pluginFolder) |
||
| 155 | |||
| 156 | /** |
||
| 157 | * Part à la recherche d'un type de plugin dans les répertoires |
||
| 158 | * |
||
| 159 | * @param string $path La racine |
||
| 160 | * @param integer $type Le type de plugin recherché (action ou filtre) |
||
| 161 | * @return void |
||
| 162 | */ |
||
| 163 | private function loadPluginsFiles($path, $type) |
||
| 175 | |||
| 176 | /** |
||
| 177 | * Déclenchement d'une action et appel des plugins liés |
||
| 178 | * |
||
| 179 | * @param string $eventToFire L'action déclenchée |
||
| 180 | * @param object|references_parameters $parameters Les paramètres à passer à chaque plugin |
||
|
|
|||
| 181 | * @return object L'objet lui même pour chaîner |
||
| 182 | */ |
||
| 183 | public function fireAction($eventToFire, references_parameters $parameters = null) |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Déclenchement d'un filtre et appel des plugins liés |
||
| 213 | * |
||
| 214 | * @param string $eventToFire Le filtre appelé |
||
| 215 | * @param object|references_parameters $parameters Les paramètres à passer à chaque plugin |
||
| 216 | * @return object Le contenu de l'objet passé en paramètre |
||
| 217 | */ |
||
| 218 | public function fireFilter($eventToFire, references_parameters $parameters) |
||
| 248 | |||
| 249 | /** |
||
| 250 | * Indique si un plugin s'est détaché d'un évènement particulier |
||
| 251 | * |
||
| 252 | * @param integer $eventType |
||
| 253 | * @param string $eventToFire |
||
| 254 | * @param string $fullPathName |
||
| 255 | * @param string $className |
||
| 256 | * @param string $method |
||
| 257 | * @return boolean |
||
| 258 | */ |
||
| 259 | public function isUnplug($eventType, $eventToFire, $fullPathName, $className, $method) |
||
| 270 | |||
| 271 | /** |
||
| 272 | * Permet à un plugin de se détacher d'un évènement |
||
| 273 | * |
||
| 274 | * @param integer $eventType |
||
| 275 | * @param string $eventToFire |
||
| 276 | * @param string $fullPathName |
||
| 277 | * @param string $className |
||
| 278 | * @param string $method |
||
| 279 | * @return void |
||
| 280 | */ |
||
| 281 | public function unplugFromEvent($eventType, $eventToFire, $fullPathName, $className, $method) |
||
| 290 | } |
||
| 291 |
Loading history...
This check looks for
@paramannotations where the type inferred by our type inference engine differs from the declared type.It makes a suggestion as to what type it considers more descriptive.
Most often this is a case of a parameter that can be null in addition to its declared types.