Annotations and attributes reader / Читатель аннотаций и атрибутов | API
Installation / Установка
composer require rudra/annotation
Using / Использование
$annotation = new Annotation();An example of reading annotations / Пример чтения аннотаций
$annotation->getAnnotations(PageController::class);
$annotation->getAnnotations(PageController::class, "indexAction");/**
* @Routing(url = '')
* @Defaults(name = 'user1', lastname = 'sample', age='0', address = {country : 'Russia'; state : 'Tambov'}, phone = '000-00000000')
* @assertResult(false)
* @Validate(name = 'min:150', phone = 'max:9')
* @Middleware('Middleware', params = {int1 : '123'})
* @Annotation(param1, param2 = 'param2', param3={param1;param2:'param2'})
*/
class PageController
{
/**
* @Routing(url = '')
* @Defaults(name = 'user1', lastname = 'sample', age='0', address = {country : 'Russia'; state : 'Tambov'}, phone = '000-00000000')
* @assertResult(false)
* @Validate(name = 'min:150', phone = 'max:9')
* @Middleware('Middleware', params = {int1 : '123'})
* @Annotation(param1, param2 = 'param2', param3={param1;param2:'param2'})
*/
public function indexAction()
{
// Your code
}
}An example of reading attributes / Пример чтения атрибутов
$annotation->getAttributes(PageController::class);
$annotation->getAttributes(PageController::class, "indexAction");#[Routing(url:'')]
#[Defaults(name:'user1', lastname:'sample', age:'0', address:['country' => 'Russia', 'state' => 'Tambov'], phone:'000-00000000')]
#[assertResult(false)]
#[Validate(name:'min:150', phone:'max:9')]
#[Middleware('Middleware', params:['int1' => '123'])]
#[Annotation("param1", param2:'param2', param3:['param1', 'param2' => 'param2'])]
class PageController
{
#[Routing(url:'')]
#[Defaults(name:'user1', lastname:'sample', age:'0', address:['country' => 'Russia', 'state' => 'Tambov'], phone:'000-00000000')]
#[assertResult(false)]
#[Validate(name:'min:150', phone:'max:9')]
#[Middleware('Middleware', params:['int1' => '123'])]
#[Annotation("param1", param2:'param2', param3:['param1', 'param2' => 'param2'])]
public function indexAction()
{
// Your code
}
}Result in both cases / Результат чтения в обоих случаях:
[
'Routing' => [['url' => ""]],
'Defaults' => [
[
'name' => "user1",
'lastname' => "sample",
'age' => "0",
'address' => [
'country' => "Russia",
'state' => "Tambov",
],
'phone' => "000-00000000",
],
],
'assertResult' => [["false"]],
'Validate' => [
[
'name' => "min:150",
'phone' => "max:9",
],
],
'Middleware' => [
[
"'Middleware'",
'params' => [
'int1' => '123',
],
],
],
"Annotation" => [
[
"param1",
"param2" => "param2",
"param3" => [
"param1",
"param2" => "param2",
],
],
],
];License
This project is licensed under the Mozilla Public License 2.0 (MPL-2.0) — a free, open-source license that:
- Requires preservation of copyright and license notices,
- Allows commercial and non-commercial use,
- Requires that any modifications to the original files remain open under MPL-2.0,
- Permits combining with proprietary code in larger works.
Проект распространяется под лицензией Mozilla Public License 2.0 (MPL-2.0). Это означает:
- Вы можете свободно использовать, изменять и распространять код.
- При изменении файлов, содержащих исходный код из этого репозитория, вы обязаны оставить их открытыми под той же лицензией.
- Вы обязаны сохранять уведомления об авторстве и ссылку на оригинал.
- Вы можете встраивать код в проприетарные проекты, если исходные файлы остаются под MPL.