DoNotEagerLoadByDefault PHPStan rule

DoNotEagerLoadByDefault.php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use PhpParser\Node;
use PhpParser\Node\Stmt\Property;
use PHPStan\Analyser\Scope;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;

class DoNotEagerLoadByDefault implements Rule
{
    public function getNodeType(): string
    {
        return Property::class;
    }

    /**
     * @param  Property  $node
     */
    public function processNode(Node $node, Scope $scope): array
    {
        if ($node->props === []) {
            return [];
        }

        if ($node->props[0]->name->toString() !== 'with') {
            return [];
        }

        $classReflection = $scope->getClassReflection();

        if ($classReflection === null) {
            return [];
        }

        if (!$classReflection->isSubclassOf(Model::class)) {
            return [];
        }

        return [
            RuleErrorBuilder::message('Eager loading should not be done by default.')
                ->identifier('custom.noEagerLoadingByDefault')
                ->build(),
        ];
    }
}