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\Extcal\Common; |
||
| 18 | trait VersionChecks |
||
| 19 | { |
||
| 20 | /** |
||
| 21 | * |
||
| 22 | * Verifies XOOPS version meets minimum requirements for this module |
||
| 23 | * @static |
||
| 24 | * @param \XoopsModule $module |
||
|
|
|||
| 25 | * |
||
| 26 | * @param null|string $requiredVer |
||
| 27 | * @return bool true if meets requirements, false if not |
||
| 28 | */ |
||
| 29 | public static function checkVerXoops(\XoopsModule $module = null, $requiredVer = null) |
||
| 51 | |||
| 52 | /** |
||
| 53 | * |
||
| 54 | * Verifies PHP version meets minimum requirements for this module |
||
| 55 | * @static |
||
| 56 | * @param \XoopsModule $module |
||
| 57 | * |
||
| 58 | * @return bool true if meets requirements, false if not |
||
| 59 | */ |
||
| 60 | public static function checkVerPhp(\XoopsModule $module) |
||
| 76 | } |
||
| 77 |
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.