|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Roave\ApiCompare\Comparator\BackwardsCompatibility\ClassBased; |
|
6
|
|
|
|
|
7
|
|
|
use Assert\Assert; |
|
8
|
|
|
use Roave\ApiCompare\Change; |
|
9
|
|
|
use Roave\ApiCompare\Changes; |
|
10
|
|
|
use Roave\BetterReflection\Reflection\ReflectionClass; |
|
11
|
|
|
use Roave\BetterReflection\Reflection\ReflectionMethod; |
|
12
|
|
|
|
|
13
|
|
|
final class MethodVisibilityReduced implements ClassBased |
|
14
|
|
|
{ |
|
15
|
|
|
private const VISIBILITY_PRIVATE = 'private'; |
|
16
|
|
|
|
|
17
|
|
|
private const VISIBILITY_PROTECTED = 'protected'; |
|
18
|
|
|
|
|
19
|
|
|
private const VISIBILITY_PUBLIC = 'public'; |
|
20
|
|
|
|
|
21
|
|
|
public function compare(ReflectionClass $fromClass, ReflectionClass $toClass) : Changes |
|
22
|
|
|
{ |
|
23
|
|
|
Assert::that($fromClass->getName())->same($toClass->getName()); |
|
24
|
|
|
|
|
25
|
|
|
$visibilitiesFrom = $this->methodVisibilities($fromClass); |
|
26
|
|
|
$visibilitiesTo = $this->methodVisibilities($toClass); |
|
27
|
|
|
|
|
28
|
|
|
$affectedVisibilities = array_filter( |
|
29
|
|
|
array_combine( |
|
30
|
|
|
array_keys(array_intersect_key($visibilitiesFrom, $visibilitiesTo)), |
|
31
|
|
|
array_map( |
|
32
|
|
|
function (string $visibilityFrom, string $visibilityTo) : array { |
|
33
|
|
|
return [$visibilityFrom, $visibilityTo]; |
|
34
|
|
|
}, |
|
35
|
|
|
array_intersect_key($visibilitiesFrom, $visibilitiesTo), |
|
36
|
|
|
array_intersect_key($visibilitiesTo, $visibilitiesFrom) |
|
37
|
|
|
) |
|
38
|
|
|
), |
|
39
|
|
|
function (array $visibilities) : bool { |
|
40
|
|
|
// Note: works because public, protected and private are (luckily) sortable |
|
41
|
|
|
return $visibilities[0] > $visibilities[1]; |
|
42
|
|
|
} |
|
43
|
|
|
); |
|
44
|
|
|
|
|
45
|
|
|
return Changes::fromArray(array_values(array_map(function (string $methodName, array $visibilities) use ( |
|
46
|
|
|
$fromClass |
|
47
|
|
|
) : Change { |
|
48
|
|
|
return Change::changed( |
|
49
|
|
|
sprintf( |
|
50
|
|
|
'Method %s#%s() changed visibility from %s to %s', |
|
51
|
|
|
$fromClass->getName(), |
|
52
|
|
|
$fromClass->getMethod($methodName)->getName(), |
|
53
|
|
|
$visibilities[0], |
|
54
|
|
|
$visibilities[1] |
|
55
|
|
|
), |
|
56
|
|
|
true |
|
57
|
|
|
); |
|
58
|
|
|
}, array_keys($affectedVisibilities), $affectedVisibilities))); |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
/** @return string[] */ |
|
62
|
|
|
private function methodVisibilities(ReflectionClass $class) : array |
|
63
|
|
|
{ |
|
64
|
|
|
$methods = $class->getMethods(); |
|
65
|
|
|
|
|
66
|
|
|
return array_combine( |
|
67
|
|
|
array_map(function (ReflectionMethod $method) : string { |
|
68
|
|
|
return $method->getName(); |
|
69
|
|
|
}, $methods), |
|
70
|
|
|
array_map(function (ReflectionMethod $method) : string { |
|
71
|
|
|
if ($method->isPublic()) { |
|
72
|
|
|
return self::VISIBILITY_PUBLIC; |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
if ($method->isProtected()) { |
|
76
|
|
|
return self::VISIBILITY_PROTECTED; |
|
77
|
|
|
} |
|
78
|
|
|
|
|
79
|
|
|
return self::VISIBILITY_PRIVATE; |
|
80
|
|
|
}, $methods) |
|
81
|
|
|
); |
|
82
|
|
|
} |
|
83
|
|
|
} |
Roave /
BackwardCompatibilityCheck
