https://github.com/koriym/koriym.attributes
A reader can read both doctrine/annotations and PHP8 attributes with a doctrine annotation interface.
https://github.com/koriym/koriym.attributes
annotatios attributes php
Last synced: about 1 year ago
JSON representation
A reader can read both doctrine/annotations and PHP8 attributes with a doctrine annotation interface.
- Host: GitHub
- URL: https://github.com/koriym/koriym.attributes
- Owner: koriym
- License: mit
- Created: 2020-12-16T12:01:11.000Z (over 5 years ago)
- Default Branch: 1.x
- Last Pushed: 2025-02-23T15:04:01.000Z (over 1 year ago)
- Last Synced: 2025-03-28T10:11:19.236Z (over 1 year ago)
- Topics: annotatios, attributes, php
- Language: PHP
- Homepage: https://packagist.org/packages/koriym/attributes
- Size: 152 KB
- Stars: 41
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Koriym.Attributes
[](https://codecov.io/gh/koriym/Koriym.Attributes)
[](https://shepherd.dev/github/koriym/Koriym.Attributes)
A `koriym/attributes` dual reader implements doctrine/annotation [Reader](https://github.com/doctrine/annotations/blob/master/lib/Doctrine/Common/Annotations/Reader.php) interface
in order to read both doctrine/annotation and PHP 8 attributes.
Doctrine annotations are different by design than PHP core one.
Not all attributes can be read by this reader (ex. parameters), and not all doctrine/annotations can be read by this reader either. (ex. nested annotations)
However, This reader help you to code forward compatible that supports both PHP 7.x annotations and 8.x attributes in certain senario.
## Installation
composer require koriym/attributes
## Usage
Create the reader instance.
```php
use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Annotations\Reader;
use Koriym\Attributes\DualReader;
use Koriym\Attributes\AttributeReader;
$reader = new DualReader(
new AnnotationReader(),
new AttributeReader()
);
assert($reader instanceof Reader);
```
The reader can read both annotations and attributes.
## Compatible Annotation
Existing doctrine annotations can be changed into annotations that work for both doctrine annotation and PHP8 attributes.
Add `#[Attribute]` attribute.
```diff
use Attribute;
/** @Annotation */
+#[Attribute]
final class Foo
{
}
```
Then add constructor when annotation has properties.
Following example works with both PHP8 attribute and `doctrine/annotations`.
```diff
use Attribute;
+use Doctrine\Common\Annotations\NamedArgumentConstructor;
/**
* @Annotation
* @Target("METHOD")
+* @NamedArgumentConstructor
*/
+#[Attribute(Attribute::TARGET_METHOD)]
final class Foo
{
public string $bar;
public int $baz;
+ public function __construct(string $bar = '', int $baz = 0)
+ {
+ $this->bar = $bar;
+ $this->baz = $baz;
+ }
}
```
See more about annotation compatible attribute at [Constructors with Named Parameters](https://github.com/doctrine/annotations/blob/1.11.x/docs/en/custom.rst#optional-constructors-with-named-parameters)