MontealegreLuis / phuml

src/Parser/Code/PhpCodeParser.php

<?php declare(strict_types=1);
/**
 * This source file is subject to the license that is bundled with this package in the file LICENSE.
 */

namespace PhUml\Parser\Code;

use phpDocumentor\Reflection\DocBlockFactory;

The type phpDocumentor\Reflection\DocBlockFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use PhpParser\Node\Stmt;

The type PhpParser\Node\Stmt was not found. Maybe you did not declare it correctly or list all dependencies?

use PhpParser\NodeTraverser;

The type PhpParser\NodeTraverser was not found. Maybe you did not declare it correctly or list all dependencies?

use PhpParser\NodeVisitor\NameResolver;

The type PhpParser\NodeVisitor\NameResolver was not found. Maybe you did not declare it correctly or list all dependencies?

use PhpParser\NodeVisitor\NodeConnectingVisitor;

The type PhpParser\NodeVisitor\NodeConnectingVisitor was not found. Maybe you did not declare it correctly or list all dependencies?

use PhpParser\Parser;

The type PhpParser\Parser was not found. Maybe you did not declare it correctly or list all dependencies?

use PhpParser\ParserFactory;

The type PhpParser\ParserFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use PhUml\Code\Codebase;
use PhUml\Parser\Code\Builders\AttributeAnalyzer;
use PhUml\Parser\Code\Builders\ClassDefinitionBuilder;
use PhUml\Parser\Code\Builders\EnumDefinitionBuilder;
use PhUml\Parser\Code\Builders\Filters\PrivateVisibilityFilter;
use PhUml\Parser\Code\Builders\Filters\ProtectedVisibilityFilter;
use PhUml\Parser\Code\Builders\InterfaceDefinitionBuilder;
use PhUml\Parser\Code\Builders\Members\NoConstantsBuilder;
use PhUml\Parser\Code\Builders\Members\NoMethodsBuilder;
use PhUml\Parser\Code\Builders\Members\NoPropertiesBuilder;
use PhUml\Parser\Code\Builders\Members\ParametersBuilder;
use PhUml\Parser\Code\Builders\Members\ParsedConstantsBuilder;
use PhUml\Parser\Code\Builders\Members\ParsedMethodsBuilder;
use PhUml\Parser\Code\Builders\Members\ParsedPropertiesBuilder;
use PhUml\Parser\Code\Builders\Members\TypeBuilder;

The type PhUml\Parser\Code\Builders\Members\TypeBuilder was not found. Maybe you did not declare it correctly or list all dependencies?

use PhUml\Parser\Code\Builders\Members\VisibilityBuilder;
use PhUml\Parser\Code\Builders\Members\VisibilityFilters;
use PhUml\Parser\Code\Builders\MembersBuilder;
use PhUml\Parser\Code\Builders\ParameterTagFilterFactory;
use PhUml\Parser\Code\Builders\TagTypeFactory;

The type PhUml\Parser\Code\Builders\TagTypeFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use PhUml\Parser\Code\Builders\TraitDefinitionBuilder;
use PhUml\Parser\Code\Builders\UseStatementsBuilder;
use PhUml\Parser\Code\Visitors\ClassVisitor;
use PhUml\Parser\Code\Visitors\EnumVisitor;
use PhUml\Parser\Code\Visitors\InterfaceVisitor;
use PhUml\Parser\Code\Visitors\TraitVisitor;
use PhUml\Parser\CodeParserConfiguration;
use PhUml\Parser\SourceCode;

/**
 * It traverses the AST of all the files and interfaces found by the `CodeFinder` and builds a
 * `Codebase` object
 *
 * In order to create the collection of definitions it uses the following visitors
 *
 * - The `ClassVisitor` which builds `ClassDefinition`s
 * - The `InterfaceVisitor` which builds `InterfaceDefinition`s
 * - The `TraitVisitor` which builds `TraitDefinition`s
 */
final class PhpCodeParser
{
    public static function fromConfiguration(CodeParserConfiguration $configuration): PhpCodeParser
    {
        if ($configuration->hideAttributes()) {
            $constantsBuilder = new NoConstantsBuilder();
            $propertiesBuilder = new NoPropertiesBuilder();
        }
        if ($configuration->hideMethods()) {
            $methodsBuilder = new NoMethodsBuilder();
        }
        $filters = [];
        if ($configuration->hidePrivate()) {
            $filters[] = new PrivateVisibilityFilter();
        }
        if ($configuration->hideProtected()) {
            $filters[] = new ProtectedVisibilityFilter();
        }
        $visibilityBuilder = new VisibilityBuilder();
        $typeBuilder = new TypeBuilder(new TypeResolver(new TagTypeFactory(DocBlockFactory::createInstance())));
        $parameterFilter = new ParameterTagFilterFactory();
        $methodsBuilder ??= new ParsedMethodsBuilder(

The variable $methodsBuilder does not seem to be defined for all execution paths leading up to this point.

            new ParametersBuilder($typeBuilder, $parameterFilter),
            $typeBuilder,
            $visibilityBuilder,
        );
        $constantsBuilder ??= new ParsedConstantsBuilder($visibilityBuilder);

The variable $constantsBuilder does not seem to be defined for all execution paths leading up to this point.

        $propertiesBuilder ??= new ParsedPropertiesBuilder($visibilityBuilder, $typeBuilder, $parameterFilter);

The variable $propertiesBuilder does not seem to be defined for all execution paths leading up to this point.

        $filters = new VisibilityFilters($filters);
        $membersBuilder = new MembersBuilder($constantsBuilder, $propertiesBuilder, $methodsBuilder, $filters);
        $useStatementsBuilder = new UseStatementsBuilder();
        $classBuilder = new ClassDefinitionBuilder($membersBuilder, $useStatementsBuilder, new AttributeAnalyzer());
        $interfaceBuilder = new InterfaceDefinitionBuilder($membersBuilder, $useStatementsBuilder);
        $traitBuilder = new TraitDefinitionBuilder($membersBuilder, $useStatementsBuilder);
        $enumBuilder = new EnumDefinitionBuilder($membersBuilder, $useStatementsBuilder);

        $codebase = new Codebase();

        $parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
        $traverser = new NodeTraverser();
        $traverser->addVisitor(new NameResolver());
        $traverser->addVisitor(new NodeConnectingVisitor());
        $traverser->addVisitor(new ClassVisitor($classBuilder, $codebase));
        $traverser->addVisitor(new InterfaceVisitor($interfaceBuilder, $codebase));
        $traverser->addVisitor(new TraitVisitor($traitBuilder, $codebase));
        $traverser->addVisitor(new EnumVisitor($enumBuilder, $codebase));
        $traverser = new PhpTraverser($traverser, $codebase);

        return new self($parser, $traverser);
    }

    private function __construct(
        private readonly Parser $parser,
        private readonly PhpTraverser $traverser,
    ) {
    }

    public function parse(SourceCode $sourceCode): Codebase
    {
        foreach ($sourceCode->fileContents() as $code) {
            /** @var Stmt[] $nodes Since the parser is configured to throw in case of errors */
            $nodes = $this->parser->parse($code);
            $this->traverser->traverse($nodes);
        }
        return $this->traverser->codebase();
    }
}