PHPSA\Analyzer\Pass\FunctionCall\DebugCode

Complexity

Total Complexity

6

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes	8
Bugs	0	Features	3

1 Method

Rating	Name	Duplication	Size	Complexity
B	pass()	0	31	6

<?php
/**
 * @author Patsura Dmitry https://github.com/ovr <talk@dmtry.me>
 */

namespace PHPSA\Analyzer\Pass\FunctionCall;

use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Name;
use PHPSA\Compiler\Expression;
use PHPSA\Context;

class DebugCode implements PassFunctionCallInterface
{
    protected $map = array(
        'var_dump' => 'var_dump',
        'var_export' => 'var_export',
        'debug_zval_dump' => 'debug_zval_dump'
    );

    public function pass(FuncCall $funcCall, Context $context)
    {
        $compiler = $context->getExpressionCompiler();
        $funcNameCompiledExpression = $compiler->compile($funcCall->name);

The variable name $funcNameCompiledExpression exceeds the maximum configured length of 20.

        if ($funcNameCompiledExpression->isString() && $funcNameCompiledExpression->isCorrectValue()) {
            $name = $funcNameCompiledExpression->getValue();
        } else {
            $context->debug(
                'Unexpected function name type ' . $funcNameCompiledExpression->getType(),
                $funcCall->name
            );

            return false;
        }

        if (isset($this->map[$name])) {
            if ($funcCall->getDocComment()) {
                $phpdoc = new \phpDocumentor\Reflection\DocBlock($funcCall->getDocComment()->getText());
                if ($phpdoc->hasTag('expected')) {
                    return true;
                }
            }

            $context->notice(
                'debug.code',
                sprintf('Function %s() is a debug code, please don`t use it in production.', $name),
                $funcCall
            );
        }
    }
}