gskema /
phpcs-type-sniff
| Conditions | 17 |
| Paths | 480 |
| Total Lines | 54 |
| Code Lines | 35 |
| Lines | 0 |
| Ratio | 0 % |
| Tests | 36 |
| CRAP Score | 17 |
| Changes | 2 | ||
| Bugs | 0 | Features | 1 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 43 | 1 | public function process(File $file, CodeElementInterface $const): void |
|
| 44 | { |
||
| 45 | 1 | $docBlock = $const->getDocBlock(); |
|
| 46 | |||
| 47 | /** @var VarTag|null $varTag */ |
||
| 48 | 1 | $varTag = $docBlock->getTagsByName('var')[0] ?? null; |
|
| 49 | 1 | $docType = $varTag ? $varTag->getType() : null; |
|
| 50 | 1 | $docTypeLine = $varTag ? $varTag->getLine() : $const->getLine(); |
|
| 51 | 1 | $valueType = $const->getValueType(); |
|
|
Bug
introduced
by
|
|||
| 52 | |||
| 53 | 1 | $warnings = []; |
|
| 54 | 1 | if (TypeHelper::containsType($docType, ArrayType::class)) { |
|
| 55 | 1 | $warnings[$docTypeLine][] = 'Replace array type with typed array type in PHPDoc for :subject:. Use mixed[] for generic arrays. Correct array depth must be specified.'; |
|
| 56 | 1 | } elseif (is_a($valueType, ArrayType::class) |
|
| 57 | 1 | && !TypeHelper::containsType($docType, TypedArrayType::class) |
|
| 58 | ) { |
||
| 59 | 1 | $warnings[$docTypeLine][] = 'Add PHPDoc with typed array type hint for :subject:. Use mixed[] for generic arrays. Correct array depth must be specified.'; |
|
| 60 | 1 | } elseif ($fakeType = TypeHelper::getFakeTypedArrayType($docType)) { |
|
| 61 | 1 | $warnings[$docTypeLine][] = sprintf( |
|
| 62 | 1 | 'Use a more specific type in typed array hint "%s" for :subject:. Correct array depth must be specified.', |
|
| 63 | 1 | $fakeType->toString() |
|
| 64 | ); |
||
| 65 | } |
||
| 66 | |||
| 67 | 1 | if ($redundantTypes = TypeComparator::getRedundantDocTypes($docType)) { |
|
| 68 | 1 | $warnings[$docTypeLine][] = sprintf('Remove redundant :subject: type hints "%s"', TypeHelper::listRawTypes($redundantTypes)); |
|
| 69 | } |
||
| 70 | |||
| 71 | 1 | if ($docType && $valueType) { |
|
| 72 | 1 | [$wrongDocTypes, $missingDocTypes] = TypeComparator::compare($docType, new UndefinedType(), $valueType); |
|
| 73 | |||
| 74 | 1 | if ($wrongDocTypes) { |
|
| 75 | 1 | $warnings[$docTypeLine][] = sprintf( |
|
| 76 | 1 | 'Type %s "%s" %s not compatible with :subject: value type', |
|
| 77 | 1 | isset($wrongDocTypes[1]) ? 'hints' : 'hint', |
|
| 78 | 1 | TypeHelper::listRawTypes($wrongDocTypes), |
|
| 79 | 1 | isset($wrongDocTypes[1]) ? 'are' : 'is' |
|
| 80 | ); |
||
| 81 | } |
||
| 82 | |||
| 83 | 1 | if ($missingDocTypes) { |
|
| 84 | 1 | $warnings[$docTypeLine][] = sprintf( |
|
| 85 | 1 | 'Missing "%s" %s in :subject: type hint', |
|
| 86 | 1 | TypeHelper::listRawTypes($missingDocTypes), |
|
| 87 | 1 | isset($missingDocTypes[1]) ? 'types' : 'type' |
|
| 88 | ); |
||
| 89 | } |
||
| 90 | } |
||
| 91 | |||
| 92 | 1 | $subject = $const->getConstName().' constant'; |
|
| 93 | 1 | foreach ($warnings as $line => $lineWarnings) { |
|
| 94 | 1 | foreach ($lineWarnings as $warningTpl) { |
|
| 95 | 1 | $warning = str_replace(':subject:', $subject, $warningTpl); |
|
| 96 | 1 | $file->addWarningOnLine($warning, $line, 'FqcnConstSniff'); |
|
| 97 | } |
||
| 101 |
Loading history...