ovr /
phpsa
Complex classes like NameResolveVisitor 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 NameResolveVisitor, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 20 | class NameResolveVisitor extends NodeVisitorAbstract |
||
|
|
|||
| 21 | { |
||
| 22 | /** @var null|Name Current namespace */ |
||
| 23 | protected $namespace; |
||
| 24 | |||
| 25 | /** @var array Map of format [aliasType => [aliasName => originalName]] */ |
||
| 26 | protected $aliases; |
||
| 27 | |||
| 28 | /** @var ErrorHandler Error handler */ |
||
| 29 | protected $errorHandler; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Constructs a name resolution visitor. |
||
| 33 | * |
||
| 34 | * @param ErrorHandler|null $errorHandler Error handler |
||
| 35 | */ |
||
| 36 | 1 | public function __construct(ErrorHandler $errorHandler = null) |
|
| 40 | |||
| 41 | /** |
||
| 42 | * {@inheritdoc} |
||
| 43 | */ |
||
| 44 | 1 | public function beforeTraverse(array $nodes) |
|
| 48 | |||
| 49 | /** |
||
| 50 | * {@inheritdoc} |
||
| 51 | */ |
||
| 52 | 1 | public function enterNode(Node $node) |
|
| 53 | { |
||
| 54 | 1 | if ($node instanceof Stmt\Namespace_) { |
|
| 55 | 1 | $this->resetState($node->name); |
|
| 56 | 1 | } elseif ($node instanceof Stmt\Use_) { |
|
| 57 | foreach ($node->uses as $use) { |
||
| 58 | $this->addAlias($use, $node->type, null); |
||
| 59 | } |
||
| 60 | 1 | } elseif ($node instanceof Stmt\GroupUse) { |
|
| 61 | foreach ($node->uses as $use) { |
||
| 62 | $this->addAlias($use, $node->type, $node->prefix); |
||
| 63 | } |
||
| 64 | 1 | } elseif ($node instanceof Stmt\Class_) { |
|
| 65 | 1 | if (null !== $node->extends) { |
|
| 66 | $node->extends = $this->resolveClassName($node->extends); |
||
| 67 | } |
||
| 68 | |||
| 69 | 1 | foreach ($node->implements as &$interface) { |
|
| 70 | $interface = $this->resolveClassName($interface); |
||
| 71 | } |
||
| 72 | |||
| 73 | 1 | if (null !== $node->name) { |
|
| 74 | 1 | $this->addNamespacedName($node); |
|
| 75 | } |
||
| 76 | 1 | } elseif ($node instanceof Stmt\Interface_) { |
|
| 77 | foreach ($node->extends as &$interface) { |
||
| 78 | $interface = $this->resolveClassName($interface); |
||
| 79 | } |
||
| 80 | |||
| 81 | $this->addNamespacedName($node); |
||
| 82 | 1 | } elseif ($node instanceof Stmt\Trait_) { |
|
| 83 | $this->addNamespacedName($node); |
||
| 84 | 1 | } elseif ($node instanceof Stmt\Function_) { |
|
| 85 | $this->addNamespacedName($node); |
||
| 86 | $this->resolveSignature($node); |
||
| 87 | 1 | } elseif ($node instanceof Stmt\ClassMethod |
|
| 88 | 1 | || $node instanceof Expr\Closure |
|
| 89 | ) { |
||
| 90 | $this->resolveSignature($node); |
||
| 91 | 1 | } elseif ($node instanceof Stmt\Const_) { |
|
| 92 | foreach ($node->consts as $const) { |
||
| 93 | $this->addNamespacedName($const); |
||
| 94 | } |
||
| 95 | 1 | } elseif ($node instanceof Expr\StaticCall |
|
| 96 | 1 | || $node instanceof Expr\StaticPropertyFetch |
|
| 97 | 1 | || $node instanceof Expr\ClassConstFetch |
|
| 98 | 1 | || $node instanceof Expr\New_ |
|
| 99 | 1 | || $node instanceof Expr\Instanceof_ |
|
| 100 | ) { |
||
| 101 | if ($node->class instanceof Name) { |
||
| 102 | $node->class = $this->resolveClassName($node->class); |
||
| 103 | } |
||
| 104 | 1 | } elseif ($node instanceof Stmt\Catch_) { |
|
| 105 | foreach ($node->types as &$type) { |
||
| 106 | $type = $this->resolveClassName($type); |
||
| 107 | } |
||
| 108 | 1 | } elseif ($node instanceof Expr\FuncCall) { |
|
| 109 | if ($node->name instanceof Name) { |
||
| 110 | $node->name = $this->resolveOtherName($node->name, Stmt\Use_::TYPE_FUNCTION); |
||
| 111 | } |
||
| 112 | 1 | } elseif ($node instanceof Expr\ConstFetch) { |
|
| 113 | $node->name = $this->resolveOtherName($node->name, Stmt\Use_::TYPE_CONSTANT); |
||
| 114 | 1 | } elseif ($node instanceof Stmt\TraitUse) { |
|
| 115 | foreach ($node->traits as &$trait) { |
||
| 116 | $trait = $this->resolveClassName($trait); |
||
| 117 | } |
||
| 118 | |||
| 119 | foreach ($node->adaptations as $adaptation) { |
||
| 120 | if (null !== $adaptation->trait) { |
||
| 121 | $adaptation->trait = $this->resolveClassName($adaptation->trait); |
||
| 122 | } |
||
| 123 | |||
| 124 | if ($adaptation instanceof Stmt\TraitUseAdaptation\Precedence) { |
||
| 125 | foreach ($adaptation->insteadof as &$insteadof) { |
||
| 126 | $insteadof = $this->resolveClassName($insteadof); |
||
| 127 | } |
||
| 128 | } |
||
| 129 | } |
||
| 130 | 1 | } elseif ($node instanceof Node\NullableType) { |
|
| 131 | if ($node->type instanceof Name) { |
||
| 132 | $node->type = $this->resolveClassName($node->type); |
||
| 133 | } |
||
| 134 | } |
||
| 135 | 1 | } |
|
| 136 | |||
| 137 | 1 | protected function resetState(Name $namespace = null) |
|
| 146 | |||
| 147 | protected function addAlias(Stmt\UseUse $use, $type, Name $prefix = null) |
||
| 182 | |||
| 183 | /** @param Stmt\Function_|Stmt\ClassMethod|Expr\Closure $node */ |
||
| 184 | private function resolveSignature($node) |
||
| 196 | |||
| 197 | protected function resolveClassName(Name $name) |
||
| 226 | |||
| 227 | protected function resolveOtherName(Name $name, $type) |
||
| 270 | |||
| 271 | 1 | protected function addNamespacedName(Node $node) |
|
| 276 | } |
||
| 277 |
Loading history...
The class complexity is the sum of the complexity of all methods. A very high value is usually an indication that your class does not follow the single reponsibility principle and does more than one job.
Some resources for further reading:
You can also find more detailed suggestions for refactoring in the “Code” section of your repository.