gskema /
phpcs-type-sniff
| Total Complexity | 52 |
| Total Lines | 244 |
| Duplicated Lines | 0 % |
| Coverage | 97.56% |
| Changes | 12 | ||
| Bugs | 0 | Features | 0 |
Complex classes like FqcnMethodSniff often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use FqcnMethodSniff, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 26 | class FqcnMethodSniff implements CodeElementSniffInterface |
||
| 27 | { |
||
| 28 | protected const CODE = 'FqcnMethodSniff'; |
||
| 29 | |||
| 30 | /** @var string[] */ |
||
| 31 | protected $invalidTags = []; |
||
| 32 | |||
| 33 | /** @var bool */ |
||
| 34 | protected $reportMissingTags = true; |
||
| 35 | |||
| 36 | /** @var bool */ |
||
| 37 | protected $reportNullableBasicGetterDocType = true; |
||
| 38 | |||
| 39 | /** @var bool */ |
||
| 40 | protected $reportNullableBasicGetterFnType = true; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * @inheritDoc |
||
| 44 | */ |
||
| 45 | 6 | public function configure(array $config): void |
|
| 46 | { |
||
| 47 | // TagInterface uses lowercase tags names, no @ symbol in front |
||
| 48 | 6 | $invalidTags = []; |
|
| 49 | 6 | foreach ($config['invalidTags'] ?? [] as $rawTag) { |
|
| 50 | 1 | $invalidTags[] = strtolower(ltrim($rawTag, '@')); |
|
| 51 | } |
||
| 52 | 6 | $invalidTags = array_unique($invalidTags); |
|
| 53 | |||
| 54 | 6 | $this->invalidTags = $invalidTags; |
|
| 55 | 6 | $this->reportMissingTags = $config['reportMissingTags'] ?? true; |
|
| 56 | 6 | $this->reportNullableBasicGetterDocType = $config['reportNullableBasicGetterDocType'] ?? true; |
|
| 57 | 6 | $this->reportNullableBasicGetterFnType = $config['reportNullableBasicGetterFnType'] ?? true; |
|
| 58 | 6 | } |
|
| 59 | |||
| 60 | /** |
||
| 61 | * @inheritDoc |
||
| 62 | */ |
||
| 63 | 6 | public function register(): array |
|
| 64 | { |
||
| 65 | return [ |
||
| 66 | 6 | ClassMethodElement::class, |
|
| 67 | // TraitMethodElement::class, // can be used to implement interface, not possible to know if it is extended |
||
| 68 | InterfaceMethodElement::class, |
||
| 69 | ]; |
||
| 70 | } |
||
| 71 | |||
| 72 | /** |
||
| 73 | * @inheritDoc |
||
| 74 | * @param AbstractFqcnMethodElement $method |
||
| 75 | */ |
||
| 76 | 5 | public function process(File $file, CodeElementInterface $method, CodeElementInterface $parentElement): void |
|
| 77 | { |
||
| 78 | 5 | $warningCountBefore = $file->getWarningCount(); |
|
| 79 | |||
| 80 | 5 | static::reportInvalidTags($file, $method, $this->invalidTags); |
|
| 81 | 5 | $this->processMethod($file, $method, $parentElement); |
|
| 82 | |||
| 83 | 5 | $hasNewWarnings = $file->getWarningCount() > $warningCountBefore; |
|
| 84 | 5 | if (!$hasNewWarnings && $this->hasUselessDocBlock($method)) { |
|
| 85 | 3 | $file->addWarningOnLine('Useless PHPDoc', $method->getLine(), static::CODE); |
|
| 86 | } |
||
| 87 | 5 | } |
|
| 88 | |||
| 89 | 5 | protected function processMethod(File $file, AbstractFqcnMethodElement $method, CodeElementInterface $parent): void |
|
| 90 | { |
||
| 91 | 5 | $fnSig = $method->getSignature(); |
|
| 92 | 5 | $docBlock = $method->getDocBlock(); |
|
| 93 | 5 | $isMagicMethod = '__' === substr($fnSig->getName(), 0, 2); |
|
| 94 | 5 | $isConstructMethod = '__construct' === $fnSig->getName(); |
|
| 95 | 5 | $hasInheritDocTag = $docBlock->hasTag('inheritdoc'); |
|
| 96 | |||
| 97 | // @inheritDoc |
||
| 98 | // __construct can be detected as extended and magic, but we want to inspect it anyway |
||
| 99 | 5 | if (!$isConstructMethod) { |
|
| 100 | 5 | if ($hasInheritDocTag || $isMagicMethod) { |
|
| 101 | 1 | return; |
|
| 102 | 5 | } elseif ($method->getMetadata()->isExtended()) { |
|
| 103 | 1 | $file->addWarningOnLine('Missing @inheritDoc tag. Remove duplicated parent PHPDoc content.', $method->getLine(), static::CODE); |
|
| 104 | 1 | return; |
|
| 105 | } |
||
| 106 | } |
||
| 107 | |||
| 108 | // @param |
||
| 109 | 5 | foreach ($fnSig->getParams() as $fnParam) { |
|
| 110 | 5 | $paramTag = $docBlock->getParamTag($fnParam->getName()); |
|
| 111 | 5 | $subject = ParamTypeSubject::fromParam($fnParam, $paramTag, $docBlock); |
|
| 112 | 5 | $this->processSigType($file, $subject); |
|
| 113 | } |
||
| 114 | |||
| 115 | // @return |
||
| 116 | 5 | if (!$isConstructMethod) { |
|
| 117 | 5 | $returnTag = $docBlock->getReturnTag(); |
|
| 118 | 5 | $subject = ReturnTypeSubject::fromSignature($fnSig, $returnTag, $docBlock); |
|
| 119 | 5 | $this->processSigType($file, $subject); |
|
| 120 | |||
| 121 | 5 | if ($method instanceof ClassMethodElement && $parent instanceof ClassElement) { |
|
| 122 | 5 | ($this->reportNullableBasicGetterDocType || $this->reportNullableBasicGetterFnType) // skip if both disabled |
|
| 123 | 5 | && static::reportNullableBasicGetter($file, $subject, $method, $parent); |
|
|
Bug
Best Practice
introduced
by
|
|||
| 124 | } |
||
| 125 | } else { |
||
| 126 | 2 | foreach ($docBlock->getDescriptionLines() as $lineNum => $descLine) { |
|
| 127 | 1 | if (preg_match('#^\w+\s+constructor\.?$#', $descLine)) { |
|
| 128 | 1 | $file->addWarningOnLine('Useless description.', $lineNum, static::CODE); |
|
| 129 | } |
||
| 130 | } |
||
| 131 | } |
||
| 132 | 5 | } |
|
| 133 | |||
| 134 | 5 | protected function processSigType(File $file, AbstractTypeSubject $subject): void |
|
| 153 | 5 | } |
|
| 154 | |||
| 155 | 10 | protected function hasUselessDocBlock(AbstractFqcnMethodElement $method): bool |
|
| 203 | } |
||
| 204 | |||
| 205 | /** |
||
| 206 | * @param File $file |
||
| 207 | * @param AbstractFqcnMethodElement $method |
||
| 208 | * @param static[] $invalidTags |
||
| 209 | */ |
||
| 210 | 5 | protected static function reportInvalidTags(File $file, AbstractFqcnMethodElement $method, array $invalidTags): void |
|
| 216 | } |
||
| 217 | } |
||
| 218 | } |
||
| 219 | 5 | } |
|
| 220 | |||
| 221 | 5 | protected function reportNullableBasicGetter( |
|
| 270 | 1 | } |
|
| 271 | } |
||
| 272 |
Loading history...