splitbrain /
dokuwiki
Complex classes like auth_plugin_authplain 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 auth_plugin_authplain, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 13 | class auth_plugin_authplain extends DokuWiki_Auth_Plugin { |
||
| 14 | /** @var array user cache */ |
||
| 15 | protected $users = null; |
||
| 16 | |||
| 17 | /** @var array filter pattern */ |
||
| 18 | protected $_pattern = array(); |
||
| 19 | |||
| 20 | /** @var bool safe version of preg_split */ |
||
| 21 | protected $_pregsplit_safe = false; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * Constructor |
||
| 25 | * |
||
| 26 | * Carry out sanity checks to ensure the object is |
||
| 27 | * able to operate. Set capabilities. |
||
| 28 | * |
||
| 29 | * @author Christopher Smith <[email protected]> |
||
| 30 | */ |
||
| 31 | public function __construct() { |
||
| 54 | |||
| 55 | /** |
||
| 56 | * Check user+password |
||
| 57 | * |
||
| 58 | * Checks if the given user exists and the given |
||
| 59 | * plaintext password is correct |
||
| 60 | * |
||
| 61 | * @author Andreas Gohr <[email protected]> |
||
| 62 | * @param string $user |
||
| 63 | * @param string $pass |
||
| 64 | * @return bool |
||
| 65 | */ |
||
| 66 | public function checkPass($user, $pass) { |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Return user info |
||
| 75 | * |
||
| 76 | * Returns info about the given user needs to contain |
||
| 77 | * at least these fields: |
||
| 78 | * |
||
| 79 | * name string full name of the user |
||
| 80 | * mail string email addres of the user |
||
| 81 | * grps array list of groups the user is in |
||
| 82 | * |
||
| 83 | * @author Andreas Gohr <[email protected]> |
||
| 84 | * @param string $user |
||
| 85 | * @param bool $requireGroups (optional) ignored by this plugin, grps info always supplied |
||
| 86 | * @return array|false |
||
| 87 | */ |
||
| 88 | public function getUserData($user, $requireGroups=true) { |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Creates a string suitable for saving as a line |
||
| 95 | * in the file database |
||
| 96 | * (delimiters escaped, etc.) |
||
| 97 | * |
||
| 98 | * @param string $user |
||
| 99 | * @param string $pass |
||
| 100 | * @param string $name |
||
| 101 | * @param string $mail |
||
| 102 | * @param array $grps list of groups the user is in |
||
| 103 | * @return string |
||
| 104 | */ |
||
| 105 | protected function _createUserLine($user, $pass, $name, $mail, $grps) { |
||
| 113 | |||
| 114 | /** |
||
| 115 | * Create a new User |
||
| 116 | * |
||
| 117 | * Returns false if the user already exists, null when an error |
||
| 118 | * occurred and true if everything went well. |
||
| 119 | * |
||
| 120 | * The new user will be added to the default group by this |
||
| 121 | * function if grps are not specified (default behaviour). |
||
| 122 | * |
||
| 123 | * @author Andreas Gohr <[email protected]> |
||
| 124 | * @author Chris Smith <[email protected]> |
||
| 125 | * |
||
| 126 | * @param string $user |
||
| 127 | * @param string $pwd |
||
| 128 | * @param string $name |
||
| 129 | * @param string $mail |
||
| 130 | * @param array $grps |
||
| 131 | * @return bool|null|string |
||
| 132 | */ |
||
| 133 | public function createUser($user, $pwd, $name, $mail, $grps = null) { |
||
| 159 | |||
| 160 | /** |
||
| 161 | * Modify user data |
||
| 162 | * |
||
| 163 | * @author Chris Smith <[email protected]> |
||
| 164 | * @param string $user nick of the user to be changed |
||
| 165 | * @param array $changes array of field/value pairs to be changed (password will be clear text) |
||
| 166 | * @return bool |
||
| 167 | */ |
||
| 168 | public function modifyUser($user, $changes) { |
||
| 209 | |||
| 210 | /** |
||
| 211 | * Remove one or more users from the list of registered users |
||
| 212 | * |
||
| 213 | * @author Christopher Smith <[email protected]> |
||
| 214 | * @param array $users array of users to be deleted |
||
| 215 | * @return int the number of users deleted |
||
| 216 | */ |
||
| 217 | public function deleteUsers($users) { |
||
| 248 | |||
| 249 | /** |
||
| 250 | * Return a count of the number of user which meet $filter criteria |
||
| 251 | * |
||
| 252 | * @author Chris Smith <[email protected]> |
||
| 253 | * |
||
| 254 | * @param array $filter |
||
| 255 | * @return int |
||
| 256 | */ |
||
| 257 | public function getUserCount($filter = array()) { |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Bulk retrieval of user data |
||
| 275 | * |
||
| 276 | * @author Chris Smith <[email protected]> |
||
| 277 | * |
||
| 278 | * @param int $start index of first user to be returned |
||
| 279 | * @param int $limit max number of users to be returned |
||
| 280 | * @param array $filter array of field/pattern pairs |
||
| 281 | * @return array userinfo (refer getUserData for internal userinfo details) |
||
| 282 | */ |
||
| 283 | public function retrieveUsers($start = 0, $limit = 0, $filter = array()) { |
||
| 307 | |||
| 308 | /** |
||
| 309 | * Retrieves groups. |
||
| 310 | * Loads complete user data into memory before searching for groups. |
||
| 311 | * |
||
| 312 | * @param int $start index of first group to be returned |
||
| 313 | * @param int $limit max number of groups to be returned |
||
| 314 | * @return array |
||
| 315 | */ |
||
| 316 | public function retrieveGroups($start = 0, $limit = 0) |
||
| 330 | |||
| 331 | /** |
||
| 332 | * Only valid pageid's (no namespaces) for usernames |
||
| 333 | * |
||
| 334 | * @param string $user |
||
| 335 | * @return string |
||
| 336 | */ |
||
| 337 | public function cleanUser($user) { |
||
| 341 | |||
| 342 | /** |
||
| 343 | * Only valid pageid's (no namespaces) for groupnames |
||
| 344 | * |
||
| 345 | * @param string $group |
||
| 346 | * @return string |
||
| 347 | */ |
||
| 348 | public function cleanGroup($group) { |
||
| 352 | |||
| 353 | /** |
||
| 354 | * Load all user data |
||
| 355 | * |
||
| 356 | * loads the user file into a datastructure |
||
| 357 | * |
||
| 358 | * @author Andreas Gohr <[email protected]> |
||
| 359 | */ |
||
| 360 | protected function _loadUserData() { |
||
| 374 | |||
| 375 | /** |
||
| 376 | * Read user data from given file |
||
| 377 | * |
||
| 378 | * ignores non existing files |
||
| 379 | * |
||
| 380 | * @param string $file the file to load data from |
||
| 381 | * @return array |
||
| 382 | */ |
||
| 383 | protected function _readUserFile($file) { |
||
| 406 | |||
| 407 | protected function _splitUserData($line){ |
||
| 433 | |||
| 434 | /** |
||
| 435 | * return true if $user + $info match $filter criteria, false otherwise |
||
| 436 | * |
||
| 437 | * @author Chris Smith <[email protected]> |
||
| 438 | * |
||
| 439 | * @param string $user User login |
||
| 440 | * @param array $info User's userinfo array |
||
| 441 | * @return bool |
||
| 442 | */ |
||
| 443 | protected function _filter($user, $info) { |
||
| 455 | |||
| 456 | /** |
||
| 457 | * construct a filter pattern |
||
| 458 | * |
||
| 459 | * @param array $filter |
||
| 460 | */ |
||
| 461 | protected function _constructPattern($filter) { |
||
| 467 | } |
||
| 468 |
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_functionexpects aPostobject, and outputs the author of the post. The base classPostreturns a simple string and outputting a simple string will work just fine. However, the child classBlogPostwhich is a sub-type ofPostinstead decided to return anobject, and is therefore violating the SOLID principles. If aBlogPostwere passed tomy_function, PHP would not complain, but ultimately fail when executing thestrtouppercall in its body.