Roave\BackwardCompatibility\DetectChanges\BCBreak\FunctionBased\ExcludeInternalFunction

Complexity

Total Complexity

4

Size/Duplication

Total Lines	22
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	__invoke()	0	7	2
A	isInternalDocComment()	0	3	1

<?php

declare(strict_types=1);

namespace Roave\BackwardCompatibility\DetectChanges\BCBreak\FunctionBased;

use Roave\BackwardCompatibility\Changes;
use Roave\BetterReflection\Reflection\ReflectionFunctionAbstract;
use function Safe\preg_match;

/**
 * Functions marked "internal" (docblock) are not affected by BC checks.
 */
final class ExcludeInternalFunction implements FunctionBased
{
    /** @var FunctionBased */
    private $check;

    public function __construct(FunctionBased $check)
    {
        $this->check = $check;
    }

    public function __invoke(ReflectionFunctionAbstract $fromFunction, ReflectionFunctionAbstract $toFunction) : Changes
    {
        if ($this->isInternalDocComment($fromFunction->getDocComment())) {
            return Changes::empty();
        }

        return $this->check->__invoke($fromFunction, $toFunction);
    }

    private function isInternalDocComment(string $comment) : bool
    {
        return preg_match('/\s+@internal\s+/', $comment) === 1;
    }
}