marcosh/php-type-checker

<?php

declare(strict_types=1);

namespace Marcosh\PhpTypeChecker\Check;

use phpDocumentor\Reflection\Type;
use phpDocumentor\Reflection\Types\Array_;
use phpDocumentor\Reflection\Types\Mixed;
use phpDocumentor\Reflection\Types\Object_;
use phpDocumentor\Reflection\Types\Self_;
use Roave\BetterReflection\Reflection\ReflectionFunctionAbstract;
use Roave\BetterReflection\Reflection\ReflectionMethod;
use Roave\BetterReflection\Reflection\ReflectionType;

final class FunctionAbstract
{
    /**
     * @var ReflectionFunctionAbstract
     */
    private $function;

    public function __construct(ReflectionFunctionAbstract $function)
    {
        $this->function = $function;
    }

    /**
     * @return Type[]
     */
    private function returnDocBlockTypes(): array
    {
        $docBlockReturnTypes = [];

        try {
            $docBlockReturnTypes = $this->function->getDocBlockReturnTypes();
        } catch (\InvalidArgumentException $e) {
            // we need this here to prevent reflection-bocblock errors on @see invalid Fqsen
        }

        return $docBlockReturnTypes;
    }

    public function missingReturnType(): bool
    {
        return null === $this->function->getReturnType() &&
            empty($this->returnDocBlockTypes());
    }

    public function missingReturnTypeWithDocBlock(): bool
    {
        return null === $this->function->getReturnType() &&
            !empty($this->returnDocBlockTypes()) &&
            !$this->returnDocBlockTypes()[0] instanceof Mixed &&
            !$this->returnDocBlockTypes()[0] instanceof Object_;
    }

    public function returnTypeDoesNotCoincideWithDocBlock(): bool
    {
        $docBlockReturnTypes = $this->returnDocBlockTypes();

        return !empty($docBlockReturnTypes) &&
            $this->function->getReturnType() instanceof ReflectionType &&
            !in_array($this->function->getReturnType()->getTypeObject(), $docBlockReturnTypes, false) &&
            !($this->function->getReturnType()->getTypeObject() instanceof Array_ &&
                $docBlockReturnTypes[0] instanceof Array_
            ) &&
            !($this->function->getReturnType()->getTypeObject() instanceof Self_ &&
                $docBlockReturnTypes[0] instanceof Object_ &&
                $this->function instanceof  ReflectionMethod &&
                $this->function->getDeclaringClass()->getName() === ltrim((string) $docBlockReturnTypes[0]->getFqsen(), '\\')
            ) &&
            !($this->function->getReturnType()->getTypeObject() instanceof Object_ &&
                $docBlockReturnTypes[0] instanceof Self_ &&
                $this->function instanceof ReflectionMethod &&
                $this->function->getDeclaringClass()->getName() === ltrim((string) $this->function->getReturnType()->getTypeObject()->getFqsen(), '\\')
            );
    }
}