├── src
    ├── Project.php
    ├── Element.php
    ├── ProjectFactory.php
    ├── File.php
    ├── Location.php
    └── Fqsen.php
├── composer.json
├── README.md
├── LICENSE
└── .yamllint.yaml


/src/Project.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * phpDocumentor
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  *
11 |  * @link      http://phpdoc.org
12 |  */
13 | 
14 | namespace phpDocumentor\Reflection;
15 | 
16 | /**
17 |  * Interface for project. Since the definition of a project can be different per factory this interface will be small.
18 |  */
19 | interface Project
20 | {
21 |     /**
22 |      * Returns the name of the project.
23 |      */
24 |     public function getName(): string;
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Element.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * phpDocumentor
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  *
11 |  * @link      http://phpdoc.org
12 |  */
13 | 
14 | namespace phpDocumentor\Reflection;
15 | 
16 | /**
17 |  * Interface for Api Elements
18 |  */
19 | interface Element
20 | {
21 |     /**
22 |      * Returns the Fqsen of the element.
23 |      */
24 |     public function getFqsen(): Fqsen;
25 | 
26 |     /**
27 |      * Returns the name of the element.
28 |      */
29 |     public function getName(): string;
30 | }
31 | 


--------------------------------------------------------------------------------
/src/ProjectFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * phpDocumentor
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  *
11 |  * @link      http://phpdoc.org
12 |  */
13 | 
14 | namespace phpDocumentor\Reflection;
15 | 
16 | /**
17 |  * Interface for project factories. A project factory shall convert a set of files
18 |  * into an object implementing the Project interface.
19 |  */
20 | interface ProjectFactory
21 | {
22 |     /**
23 |      * Creates a project from the set of files.
24 |      *
25 |      * @param File[] $files
26 |      */
27 |     public function create(string $name, array $files): Project;
28 | }
29 | 


--------------------------------------------------------------------------------
/src/File.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of phpDocumentor.
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  *
11 |  * @link      http://phpdoc.org
12 |  */
13 | 
14 | namespace phpDocumentor\Reflection;
15 | 
16 | /**
17 |  * Interface for files processed by the ProjectFactory
18 |  */
19 | interface File
20 | {
21 |     /**
22 |      * Returns the content of the file as a string.
23 |      */
24 |     public function getContents(): string;
25 | 
26 |     /**
27 |      * Returns md5 hash of the file.
28 |      */
29 |     public function md5(): string;
30 | 
31 |     /**
32 |      * Returns an relative path to the file.
33 |      */
34 |     public function path(): string;
35 | }
36 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "phpdocumentor/reflection-common",
 3 |     "keywords": ["phpdoc", "phpDocumentor", "reflection", "static analysis", "FQSEN"],
 4 |     "homepage": "https://www.phpdoc.org",
 5 |     "description": "Common reflection classes used by phpdocumentor to reflect the code structure",
 6 |     "license": "MIT",
 7 |     "minimum-stability": "stable",
 8 |     "authors": [
 9 |         {
10 |             "name": "Jaap van Otterdijk",
11 |             "email": "opensource@ijaap.nl"
12 |         }
13 |     ],
14 |     "require": {
15 |         "php": "^7.4 || ^8.0"
16 |     },
17 |     "autoload" : {
18 |       "psr-4" : {
19 |         "phpDocumentor\\Reflection\\": "src/"
20 |       }
21 |     },
22 |     "extra": {
23 |         "branch-alias": {
24 |             "dev-2.x": "2.x-dev"
25 |         }
26 |     },
27 |     "require-dev": {
28 |         "phpunit/phpunit": "^9.5",
29 |         "phpstan/phpstan": "^1.8",
30 |         "vimeo/psalm": "^4.25"
31 |     },
32 |     "config": {
33 |         "platform": {
34 |             "php": "7.4.1"
35 |         }
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 2 | ![Qa workflow](https://github.com/phpDocumentor/ReflectionCommon/workflows/Qa%20workflow/badge.svg)
 3 | [![Coveralls Coverage](https://img.shields.io/coveralls/github/phpDocumentor/ReflectionCommon.svg)](https://coveralls.io/github/phpDocumentor/ReflectionCommon?branch=master)
 4 | [![Scrutinizer Code Coverage](https://img.shields.io/scrutinizer/coverage/g/phpDocumentor/ReflectionCommon.svg)](https://scrutinizer-ci.com/g/phpDocumentor/ReflectionCommon/?branch=master)
 5 | [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/phpDocumentor/ReflectionCommon.svg)](https://scrutinizer-ci.com/g/phpDocumentor/ReflectionCommon/?branch=master)
 6 | [![Stable Version](https://img.shields.io/packagist/v/phpDocumentor/Reflection-Common.svg)](https://packagist.org/packages/phpDocumentor/Reflection-Common)
 7 | [![Unstable Version](https://img.shields.io/packagist/vpre/phpDocumentor/Reflection-Common.svg)](https://packagist.org/packages/phpDocumentor/Reflection-Common)
 8 | 
 9 | 
10 | ReflectionCommon
11 | ================
12 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 phpDocumentor
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/src/Location.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of phpDocumentor.
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  *
11 |  * @link      http://phpdoc.org
12 |  */
13 | 
14 | namespace phpDocumentor\Reflection;
15 | 
16 | /**
17 |  * The location where an element occurs within a file.
18 |  *
19 |  * @psalm-immutable
20 |  */
21 | final class Location
22 | {
23 |     /** @var int */
24 |     private $lineNumber = 0;
25 | 
26 |     /** @var int */
27 |     private $columnNumber = 0;
28 | 
29 |     /**
30 |      * Initializes the location for an element using its line number in the file and optionally the column number.
31 |      */
32 |     public function __construct(int $lineNumber, int $columnNumber = 0)
33 |     {
34 |         $this->lineNumber = $lineNumber;
35 |         $this->columnNumber = $columnNumber;
36 |     }
37 | 
38 |     /**
39 |      * Returns the line number that is covered by this location.
40 |      */
41 |     public function getLineNumber(): int
42 |     {
43 |         return $this->lineNumber;
44 |     }
45 | 
46 |     /**
47 |      * Returns the column number (character position on a line) for this location object.
48 |      */
49 |     public function getColumnNumber(): int
50 |     {
51 |         return $this->columnNumber;
52 |     }
53 | }
54 | 


--------------------------------------------------------------------------------
/.yamllint.yaml:
--------------------------------------------------------------------------------
 1 | extends: "default"
 2 | 
 3 | ignore: |
 4 |   .build/
 5 |   .notes/
 6 |   vendor/
 7 | rules:
 8 |   braces:
 9 |     max-spaces-inside-empty: 0
10 |     max-spaces-inside: 1
11 |     min-spaces-inside-empty: 0
12 |     min-spaces-inside: 1
13 |   brackets:
14 |     max-spaces-inside-empty: 0
15 |     max-spaces-inside: 0
16 |     min-spaces-inside-empty: 0
17 |     min-spaces-inside: 0
18 |   colons:
19 |     max-spaces-after: 1
20 |     max-spaces-before: 0
21 |   commas:
22 |     max-spaces-after: 1
23 |     max-spaces-before: 0
24 |     min-spaces-after: 1
25 |   comments:
26 |     ignore-shebangs: true
27 |     min-spaces-from-content: 1
28 |     require-starting-space: true
29 |   comments-indentation: "enable"
30 |   document-end:
31 |     present: false
32 |   document-start:
33 |     present: false
34 |   indentation:
35 |     check-multi-line-strings: false
36 |     indent-sequences: true
37 |     spaces: 2
38 |   empty-lines:
39 |     max-end: 0
40 |     max-start: 0
41 |     max: 1
42 |   empty-values:
43 |     forbid-in-block-mappings: true
44 |     forbid-in-flow-mappings: true
45 |   hyphens:
46 |     max-spaces-after: 2
47 |   key-duplicates: "enable"
48 |   key-ordering: "disable"
49 |   line-length: "disable"
50 |   new-line-at-end-of-file: "enable"
51 |   new-lines:
52 |     type: "unix"
53 |   octal-values:
54 |     forbid-implicit-octal: true
55 |   quoted-strings:
56 |     quote-type: "double"
57 |   trailing-spaces: "enable"
58 |   truthy:
59 |     allowed-values:
60 |       - "false"
61 |       - "true"
62 | 
63 | yaml-files:
64 |   - "*.yaml"
65 |   - "*.yml"
66 | 


--------------------------------------------------------------------------------
/src/Fqsen.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * phpDocumentor
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  *
11 |  * @link      http://phpdoc.org
12 |  */
13 | 
14 | namespace phpDocumentor\Reflection;
15 | 
16 | use InvalidArgumentException;
17 | 
18 | use function end;
19 | use function explode;
20 | use function preg_match;
21 | use function sprintf;
22 | use function trim;
23 | 
24 | /**
25 |  * Value Object for Fqsen.
26 |  *
27 |  * @link https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc-meta.md
28 |  *
29 |  * @psalm-immutable
30 |  */
31 | final class Fqsen
32 | {
33 |     /** @var string full quallified class name */
34 |     private $fqsen;
35 | 
36 |     /** @var string name of the element without path. */
37 |     private $name;
38 | 
39 |     /**
40 |      * Initializes the object.
41 |      *
42 |      * @throws InvalidArgumentException when $fqsen is not matching the format.
43 |      */
44 |     public function __construct(string $fqsen)
45 |     {
46 |         $matches = [];
47 | 
48 |         $result = preg_match(
49 |             //phpcs:ignore Generic.Files.LineLength.TooLong
50 |             '/^\\\\([a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff\\\\]*)?(?:[:]{2}\\$?([a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff]*))?(?:\\(\\))?$/',
51 |             $fqsen,
52 |             $matches
53 |         );
54 | 
55 |         if ($result === 0) {
56 |             throw new InvalidArgumentException(
57 |                 sprintf('"%s" is not a valid Fqsen.', $fqsen)
58 |             );
59 |         }
60 | 
61 |         $this->fqsen = $fqsen;
62 | 
63 |         if (isset($matches[2])) {
64 |             $this->name = $matches[2];
65 |         } elseif ($fqsen === '\\') {
66 |             $this->name = '';
67 |         } else {
68 |             $matches = explode('\\', $fqsen);
69 |             $name = end($matches);
70 |             $this->name = trim($name, '()');
71 |         }
72 |     }
73 | 
74 |     /**
75 |      * converts this class to string.
76 |      */
77 |     public function __toString(): string
78 |     {
79 |         return $this->fqsen;
80 |     }
81 | 
82 |     /**
83 |      * Returns the name of the element without path.
84 |      */
85 |     public function getName(): string
86 |     {
87 |         return $this->name;
88 |     }
89 | }
90 | 


--------------------------------------------------------------------------------