Roave\ApiCompare\Comparator\BackwardsCompatibility\PropertyBased\PropertyScopeChanged

Complexity

Total Complexity

4

Size/Duplication

Total Lines	28
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	scopeAsString()	0	3	2
A	compare()	0	19	2

<?php

declare(strict_types=1);

namespace Roave\ApiCompare\Comparator\BackwardsCompatibility\PropertyBased;

use Roave\ApiCompare\Change;
use Roave\ApiCompare\Changes;
use Roave\BetterReflection\Reflection\ReflectionProperty;
use function sprintf;

/**
 * A property that changes from instance to static or the opposite has to be accessed differently,
 * so any of such changes are to be considered BC breaks
 */
final class PropertyScopeChanged implements PropertyBased
{
    public function compare(ReflectionProperty $fromProperty, ReflectionProperty $toProperty) : Changes
    {
        $fromScope = $this->scopeAsString($fromProperty);
        $toScope   = $this->scopeAsString($toProperty);

        if ($fromScope === $toScope) {
            return Changes::new();
        }

        return Changes::fromArray([
            Change::changed(
                sprintf(
                    'Property $%s of %s changed scope from %s to %s',
                    $fromProperty->getName(),
                    $fromProperty->getDeclaringClass()->getName(),
                    $fromScope,
                    $toScope
                ),
                true
            ),
        ]);
    }

    private function scopeAsString(ReflectionProperty $property) : string
    {
        return $property->isStatic() ? 'static' : 'instance';
    }
}