PHPSA\Analyzer\Pass\Statement\ReturnVoid

Complexity

Total Complexity

3

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	pass()	0	15	2
A	getRegister()	0	6	1

<?php

namespace PHPSA\Analyzer\Pass\Statement;

use PhpParser\Node\Stmt\Return_;
use PHPSA\Analyzer\Helper\DefaultMetadataPassTrait;
use PHPSA\Analyzer\Pass;
use PHPSA\Context;

class ReturnVoid implements Pass\AnalyzerPassInterface
{
    use DefaultMetadataPassTrait;

    const DESCRIPTION = 'Checks for return void statements.';

    /**
     * @param $stmt
     * @param Context $context
     * @return bool
     */
    public function pass(Return_ $stmt, Context $context)
    {
        // this is not the value null but "no value"
        if ($stmt->expr === null) {
            $context->notice(
                'return.void',
                'You are trying to return void',
                $stmt
            );

            return true;
        }

        return false;
    }

    /**
     * @return array
     */
    public function getRegister()
    {
        return [
            Return_::class,
        ];
    }
}