RequestAwareBlockMethod.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

namespace Magento\CodeMessDetector\Rule\Design;

use PHPMD\AbstractNode;
use PHPMD\AbstractRule;
use PHPMD\Node\ClassNode;
use PHPMD\Node\MethodNode;
use PDepend\Source\AST\ASTMethod;
use PHPMD\Rule\MethodAware;

class RequestAwareBlockMethod extends AbstractRule implements MethodAware
{
    public function apply(AbstractNode $method)
    {
        $definedIn = $method->getParentType();
        try {
            $isBlock = ($definedIn instanceof ClassNode)
                && is_subclass_of(
                    $definedIn->getFullQualifiedName(),
                    \Magento\Framework\View\Element\AbstractBlock::class
                );
        } catch (\Throwable $exception) {
            //Failed to load classes.
            return;
        }

        if ($isBlock) {
            $nodes = $method->findChildrenOfType('PropertyPostfix') + $method->findChildrenOfType('MethodPostfix');
            foreach ($nodes as $node) {
                $name = mb_strtolower($node->getFirstChildOfType('Identifier')->getImage());
                if ($name === '_request' || $name === 'getrequest') {
                    $this->addViolation($method, [$method->getFullQualifiedName()]);
                    break;
                }
            }
        }
    }
}