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 |
||
| 13 | class MakeUser extends Command |
||
| 14 | { |
||
| 15 | /** |
||
| 16 | * The name and signature of the console command. |
||
| 17 | * |
||
| 18 | * @var string |
||
| 19 | */ |
||
| 20 | protected $signature = 'make:user |
||
| 21 | {--email= : Set the email for the new user} |
||
| 22 | {--name= : Set the name for the new user} |
||
| 23 | {--password= : The password to set for the new user} |
||
| 24 | {--send-reset : Send a password reset email for the new user} |
||
| 25 | {--fields= : Additional database fields to set on the user} |
||
| 26 | {--force : Create the user model circumventing guarded fields} |
||
| 27 | {--import-file= : Relative path and filename for a file to import users from. File name MUST contain the extension representing the type of file (Ex: ./path/to/file.csv)} |
||
| 28 | '; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * The console command description. |
||
| 32 | * |
||
| 33 | * @var string |
||
| 34 | */ |
||
| 35 | protected $description = 'Create new application users'; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * Execute the console command. |
||
| 39 | * |
||
| 40 | * Handle creation of the new application user. |
||
| 41 | * |
||
| 42 | * @return void |
||
| 43 | */ |
||
| 44 | 27 | public function handle() |
|
| 119 | |||
| 120 | /** |
||
| 121 | * Determine if the given email address already exists. |
||
| 122 | * |
||
| 123 | * @param string $email |
||
| 124 | * @return void |
||
| 125 | * |
||
| 126 | * @throws \Dyrynda\Artisan\Exceptions\MakeUserException |
||
| 127 | */ |
||
| 128 | 21 | private function validateEmail($email) |
|
| 138 | |||
| 139 | /** |
||
| 140 | * Return any additional database fields passed by the --fields option. |
||
| 141 | * |
||
| 142 | * @return array |
||
| 143 | */ |
||
| 144 | 7 | private function additionalFields() |
|
| 156 | |||
| 157 | /** |
||
| 158 | * Normalise the given (database) field input value. |
||
| 159 | * |
||
| 160 | * @param mixed $value |
||
| 161 | * @return mixed |
||
| 162 | */ |
||
| 163 | 3 | private function normaliseValue($value) |
|
| 179 | |||
| 180 | /** |
||
| 181 | * Create file handler objects. |
||
| 182 | * |
||
| 183 | * @param string $path |
||
| 184 | * @return BulkImportFileHandler |
||
| 185 | * |
||
| 186 | * @throws \Dyrynda\Artisan\Exceptions\ImportFileException |
||
| 187 | */ |
||
| 188 | 18 | private function fileHandlerFactory($path) : BulkImportFileHandler |
|
| 202 | |||
| 203 | /** |
||
| 204 | * Add default password to data. |
||
| 205 | * |
||
| 206 | * @param array $data |
||
| 207 | * @return array |
||
| 208 | */ |
||
| 209 | private function setPasswords($data) |
||
| 218 | } |
||
| 219 |
If you define a variable conditionally, it can happen that it is not defined for all execution paths.
Let’s take a look at an example:
In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.
Available Fixes
Check for existence of the variable explicitly:
Define a default value for the variable:
Add a value for the missing path: