src/Rector/Deprecation/DrupalSetMessageRector.php

DrupalSetMessageRector.php

<?php 

// Source: https://github.com/palantirnet/drupal-rector/blob/master/src/Rector/Deprecation/DrupalSetMessageRector.php

namespace DrupalRector\Rector\Deprecation;

use DrupalRector\Utility\TraitsByClassHelperTrait;
use PhpParser\Node;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\RectorDefinition\CodeSample;
use Rector\Core\RectorDefinition\RectorDefinition;

/**
 * Replaces deprecated drupal_set_message() calls.
 *
 * See https://www.drupal.org/node/2774931 for change record.
 *
 * What is covered:
 * - Static replacement
 * - Trait usage when the `MessengerTrait` is already present on the class
 *
 * Improvement opportunities
 * - Handle variables used to specify the type
 *   - Example, `drupal_set_message('my message', $type)`
 * - Add trait for classes
 *   - `use MessengerTrait;`
 */
final class DrupalSetMessageRector extends AbstractRector
{
    use TraitsByClassHelperTrait;

    /**
     * @inheritdoc
     */
    public function getDefinition(): RectorDefinition
    {
        return new RectorDefinition('Fixes deprecated drupal_set_message() calls',[
            new CodeSample(
                <<<'CODE_BEFORE'
drupal_set_message('example status', 'status');
CODE_BEFORE
                ,
                <<<'CODE_AFTER'
\Drupal::messenger()->addStatus('example status');
CODE_AFTER
            )
        ]);
    }

    /**
     * @inheritdoc
     */
    public function getNodeTypes(): array
    {
        return [
            Node\Expr\FuncCall::class,
        ];
    }

    /**
     * @inheritdoc
     */
    public function refactor(Node $node): ?Node
    {
        /** @var Node\Expr\FuncCall $node */
        if ($this->getName($node->name) === 'drupal_set_message') {
            $class_name = $node->getAttribute(AttributeKey::CLASS_NAME);

            if ($class_name && in_array('Drupal\Core\Messenger\MessengerTrait', $this->getTraitsByClass($class_name))) {
                $messenger_service = new Node\Expr\MethodCall(new Node\Expr\Variable('this'), new Node\Identifier('messenger'));
            } else {
                // TODO: Add the messanger trait to a class that doesn't have it.
                // For now, we are using a static call.
                $messenger_service = new Node\Expr\StaticCall(new Node\Name\FullyQualified('Drupal'), 'messenger');
            }

            $method_name = 'addStatus';

            $message = $node->args[0];

            $method_arguments = [
                $message,
            ];

            // Message's type parameter is optional. Use it if present.
            if (array_key_exists(1, $node->args)) {
                if (method_exists($node->args[1]->value, '__toString')) {
                    $method_name = 'add' . ucfirst((string) $node->args[1]->value);
                } elseif ($node->args[1]->value instanceof Node\Scalar\String_) {
                    $method_name = 'add' . ucfirst($node->args[1]->value->value);
                } else {
                    /*
                     * For now, if we hit a more complex situation, we don't process this instance of the depracation.
                     *
                     * TODO: Address more complex situations.
                     *
                     * Unable to identify type, because it coming from a variable that might exist at runtime.
                     * We would need to do a more complex rule like adding a switch statement around the variable to determine what method to call.
                     *
                     * We could add the switch statement or at least add a message to the user to address this.
                     *
                     * The switch statement might be something like,
                     *
                     * switch($type) {
                     *   case 'warning':
                     *     $this->messenger()->addWarning($message);
                     *     break;
                     *   case 'error':
                     *     $this->messenger()->addError($message);
                     *     break;
                     *   default:
                     *     $this->messenger()->addStatus($message);
                     * }
                     * https://git.drupalcode.org/project/devel/blob/8.x-2.0/devel.module#L151
                     * https://git.drupalcode.org/project/devel/blob/8.x-2.0/devel.module#L265
                     */
                    return $node;
                }
            }

            // Add the third argument if present.
            if (array_key_exists(2, $node->args)) {
                $method_arguments[] = $node->args[2];
            }

            $method = new Node\Identifier($method_name);

            $node = new Node\Expr\MethodCall($messenger_service, $method, $method_arguments);

            return $node;
        }

        return null;
    }
}