| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277 |
- <?php
- declare(strict_types=1);
- /**
- * Copyright (c) 2017-2025 Andreas Möller
- *
- * For the full copyright and license information, please view
- * the LICENSE.md file that was distributed with this source code.
- *
- * @see https://github.com/ergebnis/classy
- */
- namespace Ergebnis\Classy;
- final class Constructs
- {
- /**
- * Returns a list of constructs defined in source code.
- *
- * @throws Exception\ParseError
- *
- * @return list<Construct>
- */
- public static function fromSource(string $source): array
- {
- $constructs = [];
- try {
- $sequence = \token_get_all(
- $source,
- \TOKEN_PARSE,
- );
- } catch (\ParseError $exception) {
- throw Exception\ParseError::fromParseError($exception);
- }
- $count = \count($sequence);
- $namespacePrefix = '';
- $namespaceSegmentOrNamespaceTokens = [
- \T_STRING,
- ];
- /**
- * @see https://wiki.php.net/rfc/namespaced_names_as_token
- */
- if (
- \PHP_VERSION_ID >= 80000
- && \defined('T_NAME_QUALIFIED')
- ) {
- /** @var list<int> $namespaceSegmentOrNamespaceTokens */
- $namespaceSegmentOrNamespaceTokens = [
- \T_STRING,
- \T_NAME_QUALIFIED,
- ];
- }
- $classyTokens = [
- \T_CLASS,
- \T_INTERFACE,
- \T_TRAIT,
- ];
- /**
- * @see https://wiki.php.net/rfc/enumerations
- */
- if (
- \PHP_VERSION_ID >= 80100
- && \defined('T_ENUM')
- ) {
- $classyTokens = [
- \T_CLASS,
- \T_ENUM,
- \T_INTERFACE,
- \T_TRAIT,
- ];
- }
- for ($index = 0; $index < $count; ++$index) {
- $token = $sequence[$index];
- // collect namespace name
- if (\is_array($token) && \T_NAMESPACE === $token[0]) {
- $namespaceSegments = [];
- // collect namespace segments
- for ($index = self::significantAfter($index, $sequence, $count); $index < $count; ++$index) {
- $token = $sequence[$index];
- if (\is_array($token) && !\in_array($token[0], $namespaceSegmentOrNamespaceTokens, true)) {
- continue;
- }
- $content = self::content($token);
- if (\in_array($content, ['{', ';'], true)) {
- break;
- }
- $namespaceSegments[] = $content;
- }
- $namespace = \implode('\\', $namespaceSegments);
- $namespacePrefix = $namespace . '\\';
- }
- // skip non-classy tokens
- if (!\is_array($token) || !\in_array($token[0], $classyTokens, true)) {
- continue;
- }
- // skip anonymous classes
- if (\T_CLASS === $token[0]) {
- $current = self::significantBefore($index, $sequence);
- $token = $sequence[$current];
- // if significant token before T_CLASS is T_NEW, it's an instantiation of an anonymous class
- if (\is_array($token) && \T_NEW === $token[0]) {
- continue;
- }
- }
- $index = self::significantAfter($index, $sequence, $count);
- $token = $sequence[$index];
- $constructs[] = Construct::fromName($namespacePrefix . self::content($token));
- }
- \usort($constructs, static function (Construct $a, Construct $b): int {
- return \strcmp(
- $a->name(),
- $b->name(),
- );
- });
- return $constructs;
- }
- /**
- * Returns a list of constructs defined in a directory.
- *
- * @throws Exception\DirectoryDoesNotExist
- * @throws Exception\MultipleDefinitionsFound
- *
- * @return list<Construct>
- */
- public static function fromDirectory(string $directory): array
- {
- if (!\is_dir($directory)) {
- throw Exception\DirectoryDoesNotExist::fromDirectory($directory);
- }
- $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator(
- $directory,
- \FilesystemIterator::FOLLOW_SYMLINKS,
- ));
- $constructs = [];
- foreach ($iterator as $fileInfo) {
- /** @var \SplFileInfo $fileInfo */
- if (!$fileInfo->isFile()) {
- continue;
- }
- if ($fileInfo->getBasename('.php') === $fileInfo->getBasename()) {
- continue;
- }
- /** @var string $fileName */
- $fileName = $fileInfo->getRealPath();
- /** @var string $source */
- $source = \file_get_contents($fileName);
- try {
- $constructsFromFile = self::fromSource($source);
- } catch (Exception\ParseError $exception) {
- throw Exception\ParseError::fromFileNameAndParseError(
- $fileName,
- $exception,
- );
- }
- if (0 === \count($constructsFromFile)) {
- continue;
- }
- foreach ($constructsFromFile as $construct) {
- $name = $construct->name();
- if (\array_key_exists($name, $constructs)) {
- $construct = $constructs[$name];
- }
- $constructs[$name] = $construct->definedIn($fileName);
- }
- }
- \usort($constructs, static function (Construct $a, Construct $b): int {
- return \strcmp(
- $a->name(),
- $b->name(),
- );
- });
- $constructsWithMultipleDefinitions = \array_filter($constructs, static function (Construct $construct): bool {
- return 1 < \count($construct->fileNames());
- });
- if (0 < \count($constructsWithMultipleDefinitions)) {
- throw Exception\MultipleDefinitionsFound::fromConstructs($constructsWithMultipleDefinitions);
- }
- return \array_values($constructs);
- }
- /**
- * Returns the index of the significant token after the index.
- *
- * @param array<int, array{0: int, 1: string, 2: int}|string> $sequence
- */
- private static function significantAfter(
- int $index,
- array $sequence,
- int $count
- ): int {
- for ($current = $index + 1; $current < $count; ++$current) {
- $token = $sequence[$current];
- if (\is_array($token) && \in_array($token[0], [\T_COMMENT, \T_DOC_COMMENT, \T_WHITESPACE], true)) {
- continue;
- }
- return $current;
- }
- throw Exception\ShouldNotHappen::create();
- }
- /**
- * Returns the index of the significant token after the index.
- *
- * @param array<int, array{0: int, 1: string, 2: int}|string> $sequence
- */
- private static function significantBefore(
- int $index,
- array $sequence
- ): int {
- for ($current = $index - 1; -1 < $current; --$current) {
- $token = $sequence[$current];
- if (\is_array($token) && \in_array($token[0], [\T_COMMENT, \T_DOC_COMMENT, \T_WHITESPACE], true)) {
- continue;
- }
- return $current;
- }
- throw Exception\ShouldNotHappen::create();
- }
- /**
- * Returns the string content of a token.
- *
- * @param array{0: int, 1: string, 2: int}|string $token
- */
- private static function content($token): string
- {
- if (\is_array($token)) {
- return $token[1];
- }
- return $token;
- }
- }
|