ReplaceUtilSendMessageRector.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\CI\Rector\ilUtils;

use PhpParser\Node;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use ILIAS\CI\Rector\DIC\DICMemberMap;
use Rector\Core\Exception\ShouldNotHappenException;

final class ReplaceUtilSendMessageRector extends \Rector\Core\Rector\AbstractRector
{
    protected array $old_method_names = [
        'sendInfo',
        'sendSuccess',
        'sendFailure',
        'sendQuestion',
    ];
    protected string $new_method_name = 'setOnScreenMessage';

    public function __construct(
        protected \ILIAS\CI\Rector\DIC\DICMemberResolver $dicMemberResolver,
        protected \Rector\Transform\NodeTypeAnalyzer\TypeProvidingExprFromClassResolver $typeProvidingExprFromClassResolver,
        protected \Rector\Core\NodeManipulator\ClassDependencyManipulator $classDependencyManipulator,
        protected \Rector\PostRector\Collector\PropertyToAddCollector $propertyToAddCollector,
        protected \Rector\Core\NodeManipulator\ClassInsertManipulator $classInsertManipulator
    ) {
    }

    public function getNodeTypes(): array
    {
        return [\PhpParser\Node\Expr\StaticCall::class];
    }

    private function isApplicable(Node $node): bool
    {
        if (!$node->class instanceof \PhpParser\Node\Name) {
            return false;
        }
        $staticCallClassName = $node->class->toString();
        if ($staticCallClassName !== \ilUtil::class) {
            // not calling ilUtil
            return false;
        }
        if (!$node->name instanceof \PhpParser\Node\Identifier) {
            // node has no name
            return false;
        }
        // not interested in method since not in list
        return in_array($node->name->name, $this->old_method_names);
    }

    public function refactor(Node $node): ?\PhpParser\Node\Expr\MethodCall
    {
        if (!$this->isApplicable($node)) {
            return null; // leave the node as it is
        }
        $class_where_call_happens = $this->betterNodeFinder->findParentType(
            $node,
            \PhpParser\Node\Stmt\Class_::class
        );
        if (!$class_where_call_happens instanceof \PhpParser\Node\Stmt\Class_) {
            // not on class, abort
            return null; // leave the node as it is
        }
        $method_where_call_happend = $this->betterNodeFinder->findParentType(
            $node,
            \PhpParser\Node\Stmt\ClassMethod::class
        );
        if (!$method_where_call_happend instanceof \PhpParser\Node\Stmt\ClassMethod) {
            // not in a method, abort
            return null; // leave the node as it is
        }

        if ($method_where_call_happend->isStatic()) {
//            return null;
        }

        // prepend a new argument with the type of the message, aka sendInfo goes to setOnScreenMessage('info', ...
        $message_type = strtolower(str_replace('send', '', $node->name->name));
        $arg = $this->nodeFactory->createArg($message_type);
        $arguments = $node->args;
        array_unshift($arguments, $arg);

        // ensure a dic property for ilGlobalTemplate is in the class. or we get another Expr to fetch ilGlobalTemplate
        try {
            $dicPropertyFetch = $this->dicMemberResolver->ensureDICDependency(
                DICMemberMap::TPL,
                $class_where_call_happens,
                $method_where_call_happend
            );
        } catch (ShouldNotHappenException $e) {
            throw  new ShouldNotHappenException(
                "Could not process " . $this->file->getFilePath() . ': ' . $e->getMessage()
            );
        }

        // return new method call
        $methodCall = new \PhpParser\Node\Expr\MethodCall(
            $dicPropertyFetch,
            $this->new_method_name,
            $arguments
        );
        return $methodCall;
    }

    public function getRuleDefinition(): \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
    {
        return new RuleDefinition('lorem', [
            new CodeSample(
                "\ilUtil::sendQuestion('my_text', true);",
                "\$this->main_tpl->setOnScreenMessage('question', 'my_text', true)"
            )
        ]);
    }
}