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 |
||
| 12 | class DeCaptchaBase extends DeCaptchaAbstract implements DeCaptchaInterface |
||
| 13 | { |
||
| 14 | const PARAM_FIELD_METHOD = 0; |
||
| 15 | const PARAM_FIELD_KEY = 1; |
||
| 16 | const PARAM_FIELD_FILE = 2; |
||
| 17 | const PARAM_FIELD_PHRASE = 3; |
||
| 18 | const PARAM_FIELD_REGSENSE = 4; |
||
| 19 | const PARAM_FIELD_NUMERIC = 5; |
||
| 20 | const PARAM_FIELD_MIN_LEN = 6; |
||
| 21 | const PARAM_FIELD_MAX_LEN = 7; |
||
| 22 | const PARAM_FIELD_LANGUAGE = 8; |
||
| 23 | const PARAM_FIELD_SOFT_ID = 9; |
||
| 24 | const PARAM_FIELD_CAPTCHA_ID = 10; |
||
| 25 | const PARAM_FIELD_ACTION = 11; |
||
| 26 | const PARAM_FIELD_QUESTION = 12; |
||
| 27 | const PARAM_FIELD_CALC = 13; |
||
| 28 | const PARAM_FIELD_HEADER_ACAO = 14; |
||
| 29 | const PARAM_FIELD_TEXTINSTRUCTIONS = 15; |
||
| 30 | const PARAM_FIELD_PINGBACK = 16; |
||
| 31 | |||
| 32 | const ACTION_RECOGNIZE = 0; |
||
| 33 | const ACTION_UNIVERSAL = 1; |
||
| 34 | const ACTION_UNIVERSAL_WITH_CAPTCHA = 2; |
||
| 35 | |||
| 36 | protected $paramsNames = [ |
||
| 37 | self::PARAM_FIELD_METHOD => 'method', |
||
| 38 | self::PARAM_FIELD_KEY => 'key', |
||
| 39 | self::PARAM_FIELD_FILE => 'file', |
||
| 40 | self::PARAM_FIELD_PHRASE => 'phrase', |
||
| 41 | self::PARAM_FIELD_REGSENSE => 'regsense', |
||
| 42 | self::PARAM_FIELD_NUMERIC => 'numeric', |
||
| 43 | self::PARAM_FIELD_MIN_LEN => 'min_len', |
||
| 44 | self::PARAM_FIELD_MAX_LEN => 'max_len', |
||
| 45 | self::PARAM_FIELD_LANGUAGE => 'language', |
||
| 46 | self::PARAM_FIELD_SOFT_ID => 'soft_id', |
||
| 47 | self::PARAM_FIELD_CAPTCHA_ID => 'id', |
||
| 48 | self::PARAM_FIELD_ACTION => 'action', |
||
| 49 | self::PARAM_FIELD_QUESTION => 'question', |
||
| 50 | self::PARAM_FIELD_HEADER_ACAO => 'header_acao', |
||
| 51 | self::PARAM_FIELD_TEXTINSTRUCTIONS => 'textinstructions', |
||
| 52 | self::PARAM_FIELD_PINGBACK => 'pingback', |
||
| 53 | ]; |
||
| 54 | |||
| 55 | protected $paramsSettings = [ |
||
| 56 | self::ACTION_RECOGNIZE => [ |
||
| 57 | self::PARAM_FIELD_METHOD => [ |
||
| 58 | self::PARAM_SLUG_DEFAULT => 'post', |
||
| 59 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_STRING, |
||
| 60 | ], |
||
| 61 | self::PARAM_FIELD_KEY => [ |
||
| 62 | self::PARAM_SLUG_REQUIRE => true, |
||
| 63 | self::PARAM_SLUG_SPEC => self::PARAM_SPEC_KEY, |
||
| 64 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_STRING, |
||
| 65 | ], |
||
| 66 | self::PARAM_FIELD_FILE => [ |
||
| 67 | self::PARAM_SLUG_REQUIRE => true, |
||
| 68 | self::PARAM_SLUG_SPEC => self::PARAM_SPEC_FILE, |
||
| 69 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_STRING, |
||
| 70 | ], |
||
| 71 | self::PARAM_FIELD_PHRASE => [ |
||
| 72 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 73 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 74 | ], |
||
| 75 | self::PARAM_FIELD_REGSENSE => [ |
||
| 76 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 77 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 78 | ], |
||
| 79 | self::PARAM_FIELD_NUMERIC => [ |
||
| 80 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 81 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 82 | ], |
||
| 83 | self::PARAM_FIELD_MIN_LEN => [ |
||
| 84 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 85 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 86 | ], |
||
| 87 | self::PARAM_FIELD_MAX_LEN => [ |
||
| 88 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 89 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 90 | ], |
||
| 91 | self::PARAM_FIELD_LANGUAGE => [ |
||
| 92 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 93 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 94 | ], |
||
| 95 | self::PARAM_FIELD_QUESTION => [ |
||
| 96 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 97 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 98 | ], |
||
| 99 | self::PARAM_FIELD_CALC => [ |
||
| 100 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 101 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 102 | ], |
||
| 103 | self::PARAM_FIELD_HEADER_ACAO => [ |
||
| 104 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 105 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 106 | ], |
||
| 107 | self::PARAM_FIELD_TEXTINSTRUCTIONS => [ |
||
| 108 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_STRING, |
||
| 109 | ], |
||
| 110 | self::PARAM_FIELD_PINGBACK => [ |
||
| 111 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_STRING, |
||
| 112 | ], |
||
| 113 | self::PARAM_FIELD_SOFT_ID => [ |
||
| 114 | self::PARAM_SLUG_VARIABLE => false, |
||
| 115 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 116 | ], |
||
| 117 | ], |
||
| 118 | self::ACTION_UNIVERSAL => [ |
||
| 119 | self::PARAM_FIELD_KEY => [ |
||
| 120 | self::PARAM_SLUG_REQUIRE => true, |
||
| 121 | self::PARAM_SLUG_SPEC => self::PARAM_SPEC_KEY, |
||
| 122 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_STRING, |
||
| 123 | ], |
||
| 124 | self::PARAM_FIELD_ACTION => [ |
||
| 125 | self::PARAM_SLUG_REQUIRE => true, |
||
| 126 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_STRING, |
||
| 127 | ], |
||
| 128 | self::PARAM_FIELD_HEADER_ACAO => [ |
||
| 129 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 130 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 131 | ], |
||
| 132 | ], |
||
| 133 | self::ACTION_UNIVERSAL_WITH_CAPTCHA => [ |
||
| 134 | self::PARAM_FIELD_KEY => [ |
||
| 135 | self::PARAM_SLUG_REQUIRE => true, |
||
| 136 | self::PARAM_SLUG_SPEC => self::PARAM_SPEC_KEY, |
||
| 137 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_STRING, |
||
| 138 | ], |
||
| 139 | self::PARAM_FIELD_CAPTCHA_ID => [ |
||
| 140 | self::PARAM_SLUG_REQUIRE => true, |
||
| 141 | self::PARAM_SLUG_SPEC => self::PARAM_SPEC_CAPTCHA, |
||
| 142 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 143 | ], |
||
| 144 | self::PARAM_FIELD_ACTION => [ |
||
| 145 | self::PARAM_SLUG_REQUIRE => true, |
||
| 146 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_STRING, |
||
| 147 | ], |
||
| 148 | self::PARAM_FIELD_HEADER_ACAO => [ |
||
| 149 | self::PARAM_SLUG_DEFAULT => 0, |
||
| 150 | self::PARAM_SLUG_TYPE => self::PARAM_FIELD_TYPE_INTEGER, |
||
| 151 | ], |
||
| 152 | ], |
||
| 153 | ]; |
||
| 154 | |||
| 155 | public function recognize($filePath, $limit = 3) |
||
| 197 | |||
| 198 | public function getCode() |
||
| 201 | |||
| 202 | public function getError() |
||
| 205 | |||
| 206 | /** |
||
| 207 | * Запуск распознавания капчи. |
||
| 208 | * |
||
| 209 | * @deprecated |
||
| 210 | * |
||
| 211 | * @param string $filePath Путь до файла или ссылка на него |
||
| 212 | * |
||
| 213 | * @return bool |
||
| 214 | */ |
||
| 215 | public function run($filePath) |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Не верно распознана. |
||
| 222 | */ |
||
| 223 | public function notTrue() |
||
| 227 | |||
| 228 | const DECODE_FORMAT = 0; |
||
| 229 | const DECODE_ACTION = 1; |
||
| 230 | const DECODE_SEPARATOR = 2; |
||
| 231 | const DECODE_PARAMS = 3; |
||
| 232 | const DECODE_PARAM_SETTING_MARKER = 4; |
||
| 233 | |||
| 234 | const DECODE_ACTION_RECOGNIZE = 0; |
||
| 235 | const DECODE_ACTION_GET = 1; |
||
| 236 | |||
| 237 | const DECODE_PARAM_RESPONSE = 0; |
||
| 238 | const DECODE_PARAM_CAPTCHA = 1; |
||
| 239 | const DECODE_PARAM_CODE = 2; |
||
| 240 | |||
| 241 | protected $decodeSettings = [ |
||
| 242 | self::DECODE_FORMAT => self::RESPONSE_TYPE_STRING, |
||
| 243 | self::DECODE_ACTION => [ |
||
| 244 | self::DECODE_ACTION_RECOGNIZE => [ |
||
| 245 | self::DECODE_SEPARATOR => '|', |
||
| 246 | self::DECODE_PARAMS => [ |
||
| 247 | self::DECODE_PARAM_RESPONSE => [ |
||
| 248 | self::DECODE_PARAM_SETTING_MARKER => 0, |
||
| 249 | ], |
||
| 250 | self::DECODE_PARAM_CAPTCHA => [ |
||
| 251 | self::DECODE_PARAM_SETTING_MARKER => 1, |
||
| 252 | ], |
||
| 253 | ], |
||
| 254 | ], |
||
| 255 | self::DECODE_ACTION_GET => [ |
||
| 256 | self::DECODE_SEPARATOR => '|', |
||
| 257 | self::DECODE_PARAMS => [ |
||
| 258 | self::DECODE_PARAM_RESPONSE => [ |
||
| 259 | self::DECODE_PARAM_SETTING_MARKER => 0, |
||
| 260 | ], |
||
| 261 | self::DECODE_PARAM_CODE => [ |
||
| 262 | self::DECODE_PARAM_SETTING_MARKER => 1, |
||
| 263 | ], |
||
| 264 | ], |
||
| 265 | ], |
||
| 266 | ], |
||
| 267 | ]; |
||
| 268 | |||
| 269 | protected function decodeResponse($action, $data) |
||
| 293 | } |
||
| 294 |
This error can happen if you refactor code and forget to move the variable initialization.
Let’s take a look at a simple example:
The above code is perfectly fine. Now imagine that we re-order the statements:
In that case,
$xwould be read before it is initialized. This was a very basic example, however the principle is the same for the found issue.