Chris@13
|
1 <?php
|
Chris@13
|
2
|
Chris@13
|
3 /*
|
Chris@13
|
4 * This file is part of Psy Shell.
|
Chris@13
|
5 *
|
Chris@13
|
6 * (c) 2012-2018 Justin Hileman
|
Chris@13
|
7 *
|
Chris@13
|
8 * For the full copyright and license information, please view the LICENSE
|
Chris@13
|
9 * file that was distributed with this source code.
|
Chris@13
|
10 */
|
Chris@13
|
11
|
Chris@13
|
12 namespace Psy\CodeCleaner;
|
Chris@13
|
13
|
Chris@13
|
14 use PhpParser\Node;
|
Chris@13
|
15 use PhpParser\Node\Stmt\Class_;
|
Chris@13
|
16 use Psy\Exception\FatalErrorException;
|
Chris@13
|
17
|
Chris@13
|
18 /**
|
Chris@13
|
19 * The final class pass handles final classes.
|
Chris@13
|
20 */
|
Chris@13
|
21 class FinalClassPass extends CodeCleanerPass
|
Chris@13
|
22 {
|
Chris@13
|
23 private $finalClasses;
|
Chris@13
|
24
|
Chris@13
|
25 /**
|
Chris@13
|
26 * @param array $nodes
|
Chris@13
|
27 */
|
Chris@13
|
28 public function beforeTraverse(array $nodes)
|
Chris@13
|
29 {
|
Chris@13
|
30 $this->finalClasses = [];
|
Chris@13
|
31 }
|
Chris@13
|
32
|
Chris@13
|
33 /**
|
Chris@13
|
34 * @throws RuntimeException if the node is a class that extends a final class
|
Chris@13
|
35 *
|
Chris@13
|
36 * @param Node $node
|
Chris@13
|
37 */
|
Chris@13
|
38 public function enterNode(Node $node)
|
Chris@13
|
39 {
|
Chris@13
|
40 if ($node instanceof Class_) {
|
Chris@13
|
41 if ($node->extends) {
|
Chris@13
|
42 $extends = (string) $node->extends;
|
Chris@13
|
43 if ($this->isFinalClass($extends)) {
|
Chris@17
|
44 $msg = \sprintf('Class %s may not inherit from final class (%s)', $node->name, $extends);
|
Chris@13
|
45 throw new FatalErrorException($msg, 0, E_ERROR, null, $node->getLine());
|
Chris@13
|
46 }
|
Chris@13
|
47 }
|
Chris@13
|
48
|
Chris@13
|
49 if ($node->isFinal()) {
|
Chris@17
|
50 $this->finalClasses[\strtolower($node->name)] = true;
|
Chris@13
|
51 }
|
Chris@13
|
52 }
|
Chris@13
|
53 }
|
Chris@13
|
54
|
Chris@13
|
55 /**
|
Chris@13
|
56 * @param string $name Class name
|
Chris@13
|
57 *
|
Chris@13
|
58 * @return bool
|
Chris@13
|
59 */
|
Chris@13
|
60 private function isFinalClass($name)
|
Chris@13
|
61 {
|
Chris@17
|
62 if (!\class_exists($name)) {
|
Chris@17
|
63 return isset($this->finalClasses[\strtolower($name)]);
|
Chris@13
|
64 }
|
Chris@13
|
65
|
Chris@13
|
66 $refl = new \ReflectionClass($name);
|
Chris@13
|
67
|
Chris@13
|
68 return $refl->isFinal();
|
Chris@13
|
69 }
|
Chris@13
|
70 }
|