https://github.com/bemit/orbiter-annotations-util
Helper for Doctrine\Annotations, with cached Reflection ⚡
https://github.com/bemit/orbiter-annotations-util
annotation cache doctrine php reflection
Last synced: 27 days ago
JSON representation
Helper for Doctrine\Annotations, with cached Reflection ⚡
- Host: GitHub
- URL: https://github.com/bemit/orbiter-annotations-util
- Owner: bemit
- License: mit
- Created: 2019-11-21T22:13:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-20T18:26:09.000Z (over 2 years ago)
- Last Synced: 2025-03-21T00:33:04.347Z (about 1 month ago)
- Topics: annotation, cache, doctrine, php, reflection
- Language: PHP
- Homepage:
- Size: 59.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Orbiter\AnnotationUtil
Helper utility for Doctrine\Annotations, uses cached reflection by [scaleupstack/reflection](https://packagist.org/packages/scaleupstack/reflection).
Includes CodeInfo for static code analyzes, for easier, automatic parsing of Annotations and e.g. setup of DI.
- [AnnotationsUtil](#annotationsutil)
- [Example Annotation](#example-annotation)
- [CodeInfo](#code-info---a-file-content-parsing-helper)
- [License](#license)
Install with composer:
composer require orbiter/annotations-util
See [doctrine docs](https://www.doctrine-project.org/projects/annotations.html) for details on what Annotations are and complexer Examples.
## AnnotationsUtil
```php
getClassAnnotations(App\Foo::class): array;// of annotations
$annotation_reader_cached->getClassAnnotation(App\Foo::class, Lib\MyAnnotation::class): Lib\MyAnnotation;
$annotation_reader_cached->getPropertyAnnotations(App\Foo::class, 'bar'): array;// of annotations
$annotation_reader_cached->getPropertyAnnotation(App\Foo::class, 'bar', Lib\MyAnnotation::class): Lib\MyAnnotation;
echo $annotation_reader_cached->getPropertyAnnotation(App\Foo::class, 'bar', Lib\MyAnnotation::class)->myProperty;
$annotation_reader_cached->getMethodAnnotations(App\Foo::class, 'foo'): array;// of annotations
$annotation_reader_cached->getMethodAnnotation(App\Foo::class, 'foo', Lib\MyAnnotation::class): Lib\MyAnnotation;
echo $annotation_reader_cached->getMethodAnnotation(App\Foo::class, 'foo', Lib\MyAnnotation::class)->myProperty;
// Setup code inspection / class discovery:
$code_info = new Orbiter\AnnotationsUtil\CodeInfo();
if(getenv('env') === 'prod') {
// absolute file to cache, if cache exists, it will not be re-freshed.
// Delete the file for a new cache
$code_info->enableFileCache(__DIR__ . '/tmp/codeinfo.cache');
}
// Add a dirs to scan, use `flag` for grouping different folders in the result
$code_info->defineSource(
new CodeInfoSource(
__DIR__ . '/app',
['FLAG_APP'],
['php'],
),
);
// parse defined folders
$code_info->process();
// Get the discovery for annotations:
$discovery = new Orbiter\AnnotationsUtil\AnnotationDiscovery($annotation_reader_cached);
$discovery->discoverByAnnotation(
$code_info->getClassNames('FLAG_APP'),
);
$results = $discovery->getDiscovered(Satellite\KernelRoute\Annotations\Route::class);
foreach($results as $result) {
$result->getAnnotation();
}
```
### Example Annotation
Define your annotation, remember to specify it in the Annotation loaders - normal **autoloading doesn't work** for classes using `@Annotation`!
```php
getMethodAnnotation(App\Foo::class, 'bar', Lib\MyAnnotation::class)->myProperty;
/**
* @var Lib\MyAnnotation $annotation this variable is the Annotation instance and contains also it's data
*/
$annotation = $annotation_reader_cached->getMethodAnnotation(App\Foo::class, 'bar', Lib\MyAnnotation::class);
// this is the recommended way to use the properties
echo $annotation->myProperty;
```
This example is a summarized version, using this utility to read in the end, from [Doctrine\Annotations: Create Annotations](https://www.doctrine-project.org/projects/doctrine-annotations/en/1.6/index.html#introduction).
## Take a Look
Want to build console apps with dependency injection and annotations? Use this app skeleton: [elbakerino/console](https://github.com/elbakerino/console-di-annotations), powered by PHP-DI, uses Doctrine\Annotations with this package.
Build event and middleware based apps with [Satellite](https://github.com/bemit/satellite-app), DI enabled and with annotations for cli commands and routings..
## License
This project is free software distributed under the **MIT License**.
See: [LICENSE](LICENSE).
### Contributors
By committing your code to the code repository you agree to release the code under the MIT License attached to the repository without the expectation of consideration.
***
Author: [Michael Becker](https://i-am-digital.eu)