SubstituteGetIconFactoryAndGetPageRendererFromModuleTemplateRector.php

<?php

declare(strict_types=1);

namespace Ssch\TYPO3Rector\TYPO311\v5;

use PhpParser\Modifiers;
use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Stmt\Class_;
use PHPStan\Type\ObjectType;
use Rector\NodeManipulator\ClassDependencyManipulator;
use Rector\PostRector\ValueObject\PropertyMetadata;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.5/Deprecation-95235-PublicGetterOfServicesInModuleTemplate.html
 * @see \Ssch\TYPO3Rector\Tests\Rector\v11\v5\SubstituteGetIconFactoryAndGetPageRendererFromModuleTemplateRector\SubstituteGetIconFactoryAndGetPageRendererFromModuleTemplateRectorTest
 */
final class SubstituteGetIconFactoryAndGetPageRendererFromModuleTemplateRector extends AbstractRector implements DocumentedRuleInterface
{
    /**
     * @readonly
     */
    private ClassDependencyManipulator $classDependencyManipulator;

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

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        return [Class_::class];
    }

    /**
     * @param Class_ $node
     */
    public function refactor(Node $node): ?Node
    {
        $iconPropertyFetch = $this->nodeFactory->createPropertyFetch('this', 'iconFactory');

        $iconFactoryMethodCalls = $this->findModuleTemplateMethodCallsByName(
            $node,
            'getIconFactory',
            $iconPropertyFetch
        );

        $pageRendererPropertyFetch = $this->nodeFactory->createPropertyFetch('this', 'pageRenderer');
        $pageRendererMethodCalls = $this->findModuleTemplateMethodCallsByName(
            $node,
            'getPageRenderer',
            $pageRendererPropertyFetch
        );

        if (! $iconFactoryMethodCalls && ! $pageRendererMethodCalls) {
            return null;
        }

        if ($iconFactoryMethodCalls) {
            $this->addIconFactoryToConstructor($node);
        }

        if ($pageRendererMethodCalls) {
            $this->addPageRendererToConstructor($node);
        }

        return $node;
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(
            'Use PageRenderer and IconFactory directly instead of getting them from the ModuleTemplate',
            [
                new CodeSample(
                    <<<'CODE_SAMPLE'
class MyController extends ActionController
{
    protected ModuleTemplateFactory $moduleTemplateFactory;

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

    public function myAction(): ResponseInterface
    {
        $moduleTemplate = $this->moduleTemplateFactory->create($this->request);
        $moduleTemplate->getPageRenderer()->loadRequireJsModule('Vendor/Extension/MyJsModule');
        $moduleTemplate->setContent($moduleTemplate->getIconFactory()->getIcon('some-icon', Icon::SIZE_SMALL)->render());
        return $this->htmlResponse($moduleTemplate->renderContent());
    }
}
CODE_SAMPLE
                    ,
                    <<<'CODE_SAMPLE'
class MyController extends ActionController
{
    protected ModuleTemplateFactory $moduleTemplateFactory;
    protected IconFactory $iconFactory;
    protected PageRenderer $pageRenderer;

    public function __construct(
        ModuleTemplateFactory $moduleTemplateFactory,
        IconFactory $iconFactory,
        PageRenderer $pageRenderer
    ) {
        $this->moduleTemplateFactory = $moduleTemplateFactory;
        $this->iconFactory = $iconFactory;
        $this->pageRenderer = $pageRenderer;
    }

    public function myAction(): ResponseInterface
    {
        $moduleTemplate = $this->moduleTemplateFactory->create($this->request);
        $this->pageRenderer->loadRequireJsModule('Vendor/Extension/MyJsModule');
        $moduleTemplate->setContent($this->iconFactory->getIcon('some-icon', Icon::SIZE_SMALL)->render());
        return $this->htmlResponse($moduleTemplate->renderContent());
    }
}
CODE_SAMPLE
                ),
            ]
        );
    }

    private function findModuleTemplateMethodCallsByName(
        Class_ $class,
        string $methodCallName,
        PropertyFetch $propertyFetch
    ): bool {
        $hasChanged = false;

        $this->traverseNodesWithCallable($class->stmts, function (Node $node) use (
            $methodCallName,
            &$hasChanged,
            $propertyFetch
        ) {
            if (! $node instanceof MethodCall) {
                return null;
            }

            if (! $this->nodeTypeResolver->isMethodStaticCallOrClassMethodObjectType(
                $node,
                new ObjectType('TYPO3\CMS\Backend\Template\ModuleTemplate')
            )) {
                return null;
            }

            if (! $this->nodeNameResolver->isName($node->name, $methodCallName)) {
                return null;
            }

            $hasChanged = true;
            return $propertyFetch;
        });

        return $hasChanged;
    }

    private function addIconFactoryToConstructor(Class_ $class): void
    {
        $propertyMetadata = new PropertyMetadata(
            'iconFactory',
            new ObjectType('TYPO3\CMS\Core\Imaging\IconFactory'),
            Modifiers::PRIVATE
        );
        $this->classDependencyManipulator->addConstructorDependency($class, $propertyMetadata);
    }

    private function addPageRendererToConstructor(Class_ $class): void
    {
        $propertyMetadata = new PropertyMetadata(
            'pageRenderer',
            new ObjectType('TYPO3\CMS\Core\Page\PageRenderer'),
            Modifiers::PRIVATE
        );

        $this->classDependencyManipulator->addConstructorDependency($class, $propertyMetadata);
    }
}