Skip to content

Added minimal support for class aliases #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions src/Parser/BetterReflection/AliasSourceLocator.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?php

declare(strict_types=1);

namespace setasign\PhpStubGenerator\Parser\BetterReflection;

use Roave\BetterReflection\Identifier\Identifier;
use Roave\BetterReflection\Identifier\IdentifierType;
use Roave\BetterReflection\Reflection\Reflection;
use Roave\BetterReflection\Reflector\Reflector;
use Roave\BetterReflection\SourceLocator\Type\SourceLocator;

class AliasSourceLocator implements SourceLocator
{
public function __construct(private SourceLocator $redirectSourceLocator, private array &$classAliases)
{
}

/**
* @inheritDoc
*/
public function locateIdentifier(Reflector $reflector, Identifier $identifier): Reflection|null
{
if (!$identifier->isClass() || !\array_key_exists($identifier->getName(), $this->classAliases)) {
return null;
}

return $this->redirectSourceLocator->locateIdentifier(
$reflector,
new Identifier($this->classAliases[$identifier->getName()], $identifier->getType())
);
}

/**
* @inheritDoc
*/
public function locateIdentifiersByType(Reflector $reflector, IdentifierType $identifierType): array
{
return [];
}
}
29 changes: 28 additions & 1 deletion src/Parser/BetterReflection/BetterReflectionParser.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ class BetterReflectionParser implements ParserInterface
*/
private ?array $aliases = null;

private ?array $classAliases = null;

/**
* @param ReaderInterface[] $sources
* @param ReaderInterface[] $resolvingSources These sources are used to resolve reflections but won't generate stubs
Expand Down Expand Up @@ -58,6 +60,9 @@ public function parse(): void
);
}

$classAliases = [];
$secondarySourceLocators[] = new AliasSourceLocator($mainSourceLocator, $classAliases);

// php internals
$secondarySourceLocators[] = new MemoizingSourceLocator(
new PhpInternalSourceLocator($astLocator, new ReflectionSourceStubber())
Expand All @@ -74,10 +79,19 @@ public function parse(): void
$aliases = [];

$classIdent = new IdentifierType(IdentifierType::IDENTIFIER_CLASS);

foreach ($reflector->reflectAllClasses() as $class) {
$className = $class->getName();
$classes[$class->getNamespaceName()][$className] = new ReflectionClass($class);

$docComment = $class->getDocComment() ?? '';
$classAliasPos = \strpos($docComment, '@alias');
if ($classAliasPos !== false) {
$lineEnding = \strpos($docComment, "\n", $classAliasPos);
$alias = \ltrim(\substr($docComment, $classAliasPos + 7, $lineEnding - $classAliasPos - 7), '\\');
$classAliases[$alias] = \ltrim($className, '\\');
}

$classes[$class->getNamespaceName()][$className] = new ReflectionClass($class);
$aliases[self::TYPE_CLASS][$className] = $astLocator->getNamespaceUses($classIdent, $className);
}

Expand All @@ -97,6 +111,7 @@ public function parse(): void
// $this->functions = $functions;
// $this->constants = $constants;
$this->aliases = $aliases;
$this->classAliases = $classAliases;
}

/**
Expand Down Expand Up @@ -153,4 +168,16 @@ public function getAliases(string $classOrFunctionName, string $type): array

return $this->aliases[$type][$classOrFunctionName];
}

/**
* @inheritdoc
*/
public function getClassAliases(): array
{
if ($this->classAliases === null) {
throw new \BadMethodCallException('BetterReflectionParser::parse wasn\'t called yet!');
}

return $this->classAliases;
}
}
5 changes: 5 additions & 0 deletions src/Parser/ParserInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,9 @@ public function getClasses(): array;
* @throws \InvalidArgumentException If the class or function is unknown.
*/
public function getAliases(string $classOrFunctionName, string $type): array;

/**
* @return array<string, string> Returns a list of all class aliases in this structure: ['old-name' => 'new-name']
*/
public function getClassAliases(): array;
}
10 changes: 10 additions & 0 deletions src/PhpStubGenerator.php
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,16 @@ public function generate(): string
}
}

$classAliases = $parser->getClassAliases();
if ($classAliases !== []) {
$result .= 'namespace' . $n
. '{' . $n;
foreach ($classAliases as $oldName => $newName) {
$result .= ' class_alias(\'' . $oldName . '\', \'' . $newName . '\');' . $n;
}
$result .= '}' . $n . $n;
}

// foreach ($parser->getFunctions() as $namespace => $functions) {
// foreach ($functions as $function) {
// $isGlobalNamespace = ($namespace === '');
Expand Down