Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
92.86%
26 / 28
75.00%
6 / 8
 CRAP
0.00%
0 / 1
EntityNamespace
92.86%
26 / 28
75.00%
6 / 8
 18.12
0.00%
0 / 1
 getRegularExpression
100.00%
1 / 1
100.00%
1 / 1
 1
 convert
100.00%
1 / 1
100.00%
1 / 1
 2
 toClass
100.00%
1 / 1
100.00%
1 / 1
 1
 getParentNamespace
100.00%
3 / 3
100.00%
1 / 1
 1
 getChildNamespace
100.00%
1 / 1
100.00%
1 / 1
 1
 toTestNamespace
100.00%
4 / 4
100.00%
1 / 1
 1
 getClasses
85.71%
6 / 7
0.00%
0 / 1
 4.05
 getMethods
90.00%
9 / 10
0.00%
0 / 1
 7.05
1<?php
2namespace Apie\Common\ValueObjects;
3
4use Apie\Core\Lists\ReflectionClassList;
5use Apie\Core\Lists\ReflectionMethodList;
6use Apie\Core\ValueObjects\Interfaces\HasRegexValueObjectInterface;
7use Apie\Core\ValueObjects\Interfaces\StringValueObjectInterface;
8use Apie\Core\ValueObjects\IsStringWithRegexValueObject;
9use ReflectionClass;
10use ReflectionMethod;
11use Symfony\Component\Finder\Finder;
12
13/**
14 * Value object that represents a PHP class namespace.
15 *
16 * Example values:
17 * "Apie\Common\"
18 * "Symfony\Component\"
19 */
20final class EntityNamespace implements StringValueObjectInterface, HasRegexValueObjectInterface
21{
22    use IsStringWithRegexValueObject;
23
24    public static function getRegularExpression(): string
25    {
26        return '/^([A-Z][a-zA-Z0-9]*\\\\)+$/';
27    }
28
29    protected function convert(string $input): string
30    {
31        return str_ends_with($input, '\\') ? $input : ($input . '\\');
32    }
33
34    /**
35     * @return ReflectionClass<object>
36     */
37    public function toClass(string $className): ReflectionClass
38    {
39        return new ReflectionClass($this->internal . $className);
40    }
41
42    public function getParentNamespace(): self
43    {
44        $internal = explode('\\', rtrim($this->internal, '\\'));
45        array_pop($internal);
46        return new self(implode('\\', $internal));
47    }
48
49    public function getChildNamespace(string $childNamespace): self
50    {
51        return new self($this->internal . $childNamespace);
52    }
53
54    public function toTestNamespace(): self
55    {
56        $internal = explode('\\', rtrim($this->internal, '\\'));
57        $last = array_pop($internal);
58        array_push($internal, 'Tests', $last);
59        return new self(implode('\\', $internal));
60    }
61
62    /**
63     * Returns all classes found in $path assuming the namespace of this value object.
64     */
65    public function getClasses(string $path): ReflectionClassList
66    {
67        $classes = [];
68        if (!file_exists($path) || !is_dir($path)) {
69            return new ReflectionClassList([]);
70        }
71        foreach (Finder::create()->in($path)->files()->name('*.php')->depth('== 0') as $file) {
72            $classes[] = $this->toClass($file->getBasename('.php'));
73        }
74        sort($classes);
75        return new ReflectionClassList($classes);
76    }
77
78    /**
79     * Returns all non-magic methods found in $path assuming the namespace of this value object.
80     */
81    public function getMethods(string $path): ReflectionMethodList
82    {
83        $methods = [];
84        if (!file_exists($path) || !is_dir($path)) {
85            return new ReflectionMethodList([]);
86        }
87        foreach (Finder::create()->in($path)->files()->name('*.php')->depth('== 0') as $file) {
88            $class = $this->toClass($file->getBasename('.php'));
89            foreach ($class->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
90                if (strpos($method->name, '__') !== 0 || $method->name === '__invoke') {
91                    $methods[] = $method;
92                }
93            }
94        }
95        sort($methods);
96        return new ReflectionMethodList($methods);
97    }
98}