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 namespace Xoopsmodules\randomquote\common; |
||
23 | trait VersionChecks |
||
24 | { |
||
25 | /** |
||
26 | * |
||
27 | * Verifies XOOPS version meets minimum requirements for this module |
||
28 | * @static |
||
29 | * @param \XoopsModule $module |
||
|
|||
30 | * |
||
31 | * @param null|string $requiredVer |
||
32 | * @return bool true if meets requirements, false if not |
||
33 | */ |
||
34 | public static function checkVerXoops(\XoopsModule $module = null, $requiredVer = null) |
||
57 | |||
58 | /** |
||
59 | * |
||
60 | * Verifies PHP version meets minimum requirements for this module |
||
61 | * @static |
||
62 | * @param \XoopsModule $module |
||
63 | * |
||
64 | * @return bool true if meets requirements, false if not |
||
65 | */ |
||
66 | public static function checkVerPhp(\XoopsModule $module) |
||
84 | } |
||
85 |
This check looks for
@param
annotations 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.