NameResolver.php 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. <?php declare(strict_types=1);
  2. namespace PhpParser\NodeVisitor;
  3. use PhpParser\Error;
  4. use PhpParser\ErrorHandler;
  5. use PhpParser\NameContext;
  6. use PhpParser\Node;
  7. use PhpParser\Node\Expr;
  8. use PhpParser\Node\Name;
  9. use PhpParser\Node\Name\FullyQualified;
  10. use PhpParser\Node\Stmt;
  11. use PhpParser\NodeVisitorAbstract;
  12. class NameResolver extends NodeVisitorAbstract
  13. {
  14. /** @var NameContext Naming context */
  15. protected $nameContext;
  16. /** @var bool Whether to preserve original names */
  17. protected $preserveOriginalNames;
  18. /** @var bool Whether to replace resolved nodes in place, or to add resolvedNode attributes */
  19. protected $replaceNodes;
  20. /**
  21. * Constructs a name resolution visitor.
  22. *
  23. * Options:
  24. * * preserveOriginalNames (default false): An "originalName" attribute will be added to
  25. * all name nodes that underwent resolution.
  26. * * replaceNodes (default true): Resolved names are replaced in-place. Otherwise, a
  27. * resolvedName attribute is added. (Names that cannot be statically resolved receive a
  28. * namespacedName attribute, as usual.)
  29. *
  30. * @param ErrorHandler|null $errorHandler Error handler
  31. * @param array $options Options
  32. */
  33. public function __construct(ErrorHandler $errorHandler = null, array $options = []) {
  34. $this->nameContext = new NameContext($errorHandler ?? new ErrorHandler\Throwing);
  35. $this->preserveOriginalNames = $options['preserveOriginalNames'] ?? false;
  36. $this->replaceNodes = $options['replaceNodes'] ?? true;
  37. }
  38. /**
  39. * Get name resolution context.
  40. *
  41. * @return NameContext
  42. */
  43. public function getNameContext() : NameContext {
  44. return $this->nameContext;
  45. }
  46. public function beforeTraverse(array $nodes) {
  47. $this->nameContext->startNamespace();
  48. return null;
  49. }
  50. public function enterNode(Node $node) {
  51. if ($node instanceof Stmt\Namespace_) {
  52. $this->nameContext->startNamespace($node->name);
  53. } elseif ($node instanceof Stmt\Use_) {
  54. foreach ($node->uses as $use) {
  55. $this->addAlias($use, $node->type, null);
  56. }
  57. } elseif ($node instanceof Stmt\GroupUse) {
  58. foreach ($node->uses as $use) {
  59. $this->addAlias($use, $node->type, $node->prefix);
  60. }
  61. } elseif ($node instanceof Stmt\Class_) {
  62. if (null !== $node->extends) {
  63. $node->extends = $this->resolveClassName($node->extends);
  64. }
  65. foreach ($node->implements as &$interface) {
  66. $interface = $this->resolveClassName($interface);
  67. }
  68. if (null !== $node->name) {
  69. $this->addNamespacedName($node);
  70. }
  71. } elseif ($node instanceof Stmt\Interface_) {
  72. foreach ($node->extends as &$interface) {
  73. $interface = $this->resolveClassName($interface);
  74. }
  75. $this->addNamespacedName($node);
  76. } elseif ($node instanceof Stmt\Trait_) {
  77. $this->addNamespacedName($node);
  78. } elseif ($node instanceof Stmt\Function_) {
  79. $this->addNamespacedName($node);
  80. $this->resolveSignature($node);
  81. } elseif ($node instanceof Stmt\ClassMethod
  82. || $node instanceof Expr\Closure
  83. ) {
  84. $this->resolveSignature($node);
  85. } elseif ($node instanceof Stmt\Const_) {
  86. foreach ($node->consts as $const) {
  87. $this->addNamespacedName($const);
  88. }
  89. } elseif ($node instanceof Expr\StaticCall
  90. || $node instanceof Expr\StaticPropertyFetch
  91. || $node instanceof Expr\ClassConstFetch
  92. || $node instanceof Expr\New_
  93. || $node instanceof Expr\Instanceof_
  94. ) {
  95. if ($node->class instanceof Name) {
  96. $node->class = $this->resolveClassName($node->class);
  97. }
  98. } elseif ($node instanceof Stmt\Catch_) {
  99. foreach ($node->types as &$type) {
  100. $type = $this->resolveClassName($type);
  101. }
  102. } elseif ($node instanceof Expr\FuncCall) {
  103. if ($node->name instanceof Name) {
  104. $node->name = $this->resolveName($node->name, Stmt\Use_::TYPE_FUNCTION);
  105. }
  106. } elseif ($node instanceof Expr\ConstFetch) {
  107. $node->name = $this->resolveName($node->name, Stmt\Use_::TYPE_CONSTANT);
  108. } elseif ($node instanceof Stmt\TraitUse) {
  109. foreach ($node->traits as &$trait) {
  110. $trait = $this->resolveClassName($trait);
  111. }
  112. foreach ($node->adaptations as $adaptation) {
  113. if (null !== $adaptation->trait) {
  114. $adaptation->trait = $this->resolveClassName($adaptation->trait);
  115. }
  116. if ($adaptation instanceof Stmt\TraitUseAdaptation\Precedence) {
  117. foreach ($adaptation->insteadof as &$insteadof) {
  118. $insteadof = $this->resolveClassName($insteadof);
  119. }
  120. }
  121. }
  122. }
  123. return null;
  124. }
  125. private function addAlias(Stmt\UseUse $use, $type, Name $prefix = null) {
  126. // Add prefix for group uses
  127. $name = $prefix ? Name::concat($prefix, $use->name) : $use->name;
  128. // Type is determined either by individual element or whole use declaration
  129. $type |= $use->type;
  130. $this->nameContext->addAlias(
  131. $name, (string) $use->getAlias(), $type, $use->getAttributes()
  132. );
  133. }
  134. /** @param Stmt\Function_|Stmt\ClassMethod|Expr\Closure $node */
  135. private function resolveSignature($node) {
  136. foreach ($node->params as $param) {
  137. $param->type = $this->resolveType($param->type);
  138. }
  139. $node->returnType = $this->resolveType($node->returnType);
  140. }
  141. private function resolveType($node) {
  142. if ($node instanceof Node\NullableType) {
  143. $node->type = $this->resolveType($node->type);
  144. return $node;
  145. }
  146. if ($node instanceof Name) {
  147. return $this->resolveClassName($node);
  148. }
  149. return $node;
  150. }
  151. /**
  152. * Resolve name, according to name resolver options.
  153. *
  154. * @param Name $name Function or constant name to resolve
  155. * @param int $type One of Stmt\Use_::TYPE_*
  156. *
  157. * @return Name Resolved name, or original name with attribute
  158. */
  159. protected function resolveName(Name $name, int $type) : Name {
  160. if (!$this->replaceNodes) {
  161. $resolvedName = $this->nameContext->getResolvedName($name, $type);
  162. if (null !== $resolvedName) {
  163. $name->setAttribute('resolvedName', $resolvedName);
  164. } else {
  165. $name->setAttribute('namespacedName', FullyQualified::concat(
  166. $this->nameContext->getNamespace(), $name, $name->getAttributes()));
  167. }
  168. return $name;
  169. }
  170. if ($this->preserveOriginalNames) {
  171. // Save the original name
  172. $originalName = $name;
  173. $name = clone $originalName;
  174. $name->setAttribute('originalName', $originalName);
  175. }
  176. $resolvedName = $this->nameContext->getResolvedName($name, $type);
  177. if (null !== $resolvedName) {
  178. return $resolvedName;
  179. }
  180. // unqualified names inside a namespace cannot be resolved at compile-time
  181. // add the namespaced version of the name as an attribute
  182. $name->setAttribute('namespacedName', FullyQualified::concat(
  183. $this->nameContext->getNamespace(), $name, $name->getAttributes()));
  184. return $name;
  185. }
  186. protected function resolveClassName(Name $name) {
  187. return $this->resolveName($name, Stmt\Use_::TYPE_NORMAL);
  188. }
  189. protected function addNamespacedName(Node $node) {
  190. $node->namespacedName = Name::concat(
  191. $this->nameContext->getNamespace(), (string) $node->name);
  192. }
  193. }