taquillacom / doctrine-annotation-reader
提供更清晰的API来读取Doctrine注解
0.4.0
2024-04-09 12:03 UTC
Requires
- php: >=8.0
- doctrine/annotations: ^1.2
- psr/simple-cache: ^3.0
Requires (Dev)
- phpunit/phpunit: ^9.0
- symfony/cache: ^4.0
This package is auto-updated.
Last update: 2024-09-09 12:57:05 UTC
README
此库包装了一个Doctrine注解读取器,以便提供更清晰的接口来解析类和接口注解。
AbstractAnnotation
这是必须从它扩展以使用此库的基类。
如果注解数据模式与单个值键不同,则重写 init。如果允许存储多个此注解的实例,则重写 allowMultiple 并返回 true。如果想要使用不同于类名的不同名称,则重写 getName。
AnnotationReaderAdapter
此类接受Doctrine Reader接口和Doctrine CacheProvider。它有三个感兴趣的公共方法。每个方法都返回一个AnnotationCollection。
readClass方法接受一个类名和$useParent作为参数。如果$useParent为true,则读取器将检查超类或所有接口(如果提供的类是一个接口)。
readMethod和readProperty操作相同。它们都接受方法或属性的名称、类名、$useParent和$useClass作为参数。$useParent参数与readClass的工作方式相同。如果$useClass为true,则还会从类继承注解。如果$useParent为true,则还会添加父类注解。
如果不允许多个注解,则任何找到的重复项都将被忽略。这允许方法覆盖类级别的注解,例如。
AnnotationCollection
这是由读取器返回的。您可以使用get获取单个注解,使用getAll获取允许多个注解的注解,它返回一个数组。两种方法都接受注解名称作为参数,注解定义了它,默认为类名。