AssociationTableMixinClassReflectionExtension.php

<?php
declare(strict_types=1);

/**
 * @source https://github.com/cakephp/cakephp
 */

namespace CakeDC\PHPStan\Method;

use Cake\ORM\Association;
use Cake\ORM\Table;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Reflection\MethodsClassReflectionExtension;
use PHPStan\Reflection\PropertiesClassReflectionExtension;
use PHPStan\Reflection\PropertyReflection;
use PHPStan\Reflection\ReflectionProvider;

class AssociationTableMixinClassReflectionExtension implements
    PropertiesClassReflectionExtension,
    MethodsClassReflectionExtension
{
    /**
     * @var \PHPStan\Reflection\ReflectionProvider
     */
    protected ReflectionProvider $reflectionProvider;

    /**
     * @param \PHPStan\Reflection\ReflectionProvider $reflectionProvider
     */
    public function __construct(ReflectionProvider $reflectionProvider)
    {
        $this->reflectionProvider = $reflectionProvider;
    }

    /**
     * @return \PHPStan\Reflection\ClassReflection
     */
    protected function getTableReflection(): ClassReflection
    {
        return $this->reflectionProvider->getClass(Table::class);
    }

    /**
     * @param \PHPStan\Reflection\ClassReflection $classReflection Class reflection
     * @param string          $methodName      Method name
     * @return bool
     */
    public function hasMethod(ClassReflection $classReflection, string $methodName): bool
    {
        // magic findBy* method
        if ($classReflection->is(Table::class) && preg_match('/^find(?:\w+)?By/', $methodName) > 0) {
            return true;
        }

        if (!$classReflection->is(Association::class)) {
            return false;
        }

        // magic findBy* method on Association
        if (preg_match('/^find(?:\w+)?By/', $methodName) > 0) {
            return true;
        }

        return $this->getTableReflection()->hasMethod($methodName);
    }

    /**
     * @param \PHPStan\Reflection\ClassReflection $classReflection Class reflection
     * @param string          $methodName      Method name
     * @return \PHPStan\Reflection\MethodReflection
     */
    public function getMethod(ClassReflection $classReflection, string $methodName): MethodReflection
    {
        // magic findBy* method
        if ($classReflection->is(Table::class) && preg_match('/^find(?:\w+)?By/', $methodName) > 0) {
            return new TableFindByPropertyMethodReflection($methodName, $classReflection);
        }

        // magic findBy* method on Association
        $associationReflection = $this->reflectionProvider->getClass(Association::class);
        if (
            $classReflection->isSubclassOfClass($associationReflection)
            && preg_match('/^find(?:\w+)?By/', $methodName) > 0
        ) {
            return new TableFindByPropertyMethodReflection($methodName, $this->getTableReflection());
        }

        return $this->getTableReflection()->getNativeMethod($methodName);
    }

    /**
     * @param \PHPStan\Reflection\ClassReflection $classReflection Class reflection
     * @param string          $propertyName    Method name
     * @return bool
     */
    public function hasProperty(ClassReflection $classReflection, string $propertyName): bool
    {
        if (!$classReflection->is(Association::class)) {
            return false;
        }

        return $this->getTableReflection()->hasInstanceProperty($propertyName);
    }

    /**
     * @param \PHPStan\Reflection\ClassReflection $classReflection Class reflection
     * @param string          $propertyName    Method name
     * @return \PHPStan\Reflection\PropertyReflection
     */
    public function getProperty(ClassReflection $classReflection, string $propertyName): PropertyReflection
    {
        return $this->getTableReflection()->getNativeProperty($propertyName);
    }
}