ray-di / Ray.Aop

src/Compiler.php

<?php

declare(strict_types=1);

namespace Ray\Aop;

use Doctrine\Common\Annotations\AnnotationException;
use PhpParser\BuilderFactory;
use Ray\Aop\Exception\NotWritableException;

use function array_keys;
use function assert;
use function class_exists;
use function file_exists;
use function is_writable;
use function method_exists;

final class Compiler implements CompilerInterface
{
    /** @var string */
    public $classDir;

    /** @var CodeGenInterface */
    private $codeGen;

    /** @var AopClassName */
    private $aopClassName;

    /**
     * @throws AnnotationException
     */
    public function __construct(string $classDir)
    {
        if (! is_writable($classDir)) {
            throw new NotWritableException($classDir);
        }

        $this->classDir = $classDir;
        $this->aopClassName = new AopClassName($classDir);
        $parser = (new ParserFactory())->newInstance();
        $factory = new BuilderFactory();
        $aopClassName = new AopClassName($classDir);
        $this->codeGen = new CodeGen(
            $factory,
            new VisitorFactory($parser),
            new AopClass($parser, $factory, $aopClassName)
        );
    }

    /**
     * @return list<string>

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

     */
    public function __sleep()
    {
        return ['classDir'];

The expression return array('classDir') returns the type array<integer,string> which is incompatible with the documented return type Ray\Aop\list.

    }

    /**
     * @throws AnnotationException
     */
    public function __wakeup()
    {
        $this->__construct($this->classDir);
    }

    /**
     * {@inheritdoc}
     */
    public function newInstance(string $class, array $args, BindInterface $bind)
    {
        $compiledClass = $this->compile($class, $bind);
        assert(class_exists($compiledClass));
        $instance = (new ReflectionClass($compiledClass))->newInstanceArgs($args);
        if (isset($instance->bindings)) {
            $instance->bindings = $bind->getBindings();
        }

        return $instance;

The expression return $instance also could return the type object which is incompatible with the return type mandated by Ray\Aop\CompilerInterface::newInstance() of object.

    }

    /**
     * {@inheritdoc}
     */
    public function compile(string $class, BindInterface $bind): string
    {
        if ($this->hasNoBinding($class, $bind)) {
            return $class;
        }

        $aopClassName = ($this->aopClassName)($class, $bind->toString(''));
        if (class_exists($aopClassName, false)) {
            return $aopClassName;
        }

        $this->requireFile($aopClassName, new ReflectionClass($class), $bind);

        return $aopClassName;
    }

    /**
     * @param class-string $class

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     */
    private function hasNoBinding(string $class, BindInterface $bind): bool
    {
        $hasMethod = $this->hasBoundMethod($class, $bind);

        return ! $bind->getBindings() && ! $hasMethod;
    }

    /**
     * @param class-string $class

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     */
    private function hasBoundMethod(string $class, BindInterface $bind): bool
    {
        $bindingMethods = array_keys($bind->getBindings());
        $hasMethod = false;
        foreach ($bindingMethods as $bindingMethod) {
            if (method_exists($class, $bindingMethod)) {
                $hasMethod = true;
            }
        }

        return $hasMethod;
    }

    /**
     * @param \ReflectionClass<object> $sourceClass
     */
    private function requireFile(string $aopClassName, \ReflectionClass $sourceClass, BindInterface $bind): void
    {
        $code = $this->codeGen->generate($sourceClass, $bind);
        $file = $code->save($this->classDir, $aopClassName);
        assert(file_exists($file));
        require_once $file;
        class_exists($aopClassName); // ensue class is created
    }
}