Как добратся до аннотации чтобы ее считать?

Отличный вопрос, касающийся одной из мощных возможностей современного PHP — работы с Reflection API и метаданными. Добраться до аннотаций (или, более корректно, атрибутов, начиная с PHP 8) можно несколькими способами, в зависимости от версии PHP и типа метаданных.

Краткий ответ: Reflection API

Чтобы "добраться" и считать аннотации (атрибуты), вы используете Reflection API (классы, начинающиеся с Reflection). Он позволяет интроспектировать (исследовать) структуры кода во время выполнения. Вот основные классы для доступа к разным элементам:

• ReflectionClass — для классов.
• ReflectionMethod — для методов.
• ReflectionProperty — для свойств.
• ReflectionFunction — для функций.
• ReflectionParameter — для параметров.

Подробный разбор по версиям PHP

Для PHP 8.0 и выше (Атрибуты / Attributes)

Начиная с PHP 8.0, вместо комментариев-анноций введены атрибуты — полноценные конструкции языка. Это рекомендуемый и самый мощный способ.

1. Определение атрибутов

Сначала создайте класс атрибута, пометив его #[Attribute].

<?php

#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)]
class Route {
    public function __construct(
        public string $path,
        public string $method = 'GET'
    ) {}
}

#[Attribute(Attribute::TARGET_PROPERTY)]
class Column {
    public function __construct(
        public string $name,
        public string $type = 'string'
    ) {}
}

2. Использование (разметка) атрибутов

Примените атрибуты, используя синтаксис #[ ].

<?php

#[Route(path: '/api/users', method: 'GET')]
class UserController {
    #[Column(name: 'user_id', type: 'integer')]
    private int $id;

    #[Route(path: '/api/users/{id}', method: 'GET')]
    public function getUser(int $id): Response {
        // ...
    }
}

3. Чтение атрибутов с помощью Reflection

Используйте методы getAttributes() и getAttribute() у соответствующих Reflection-объектов.

<?php

// Рефлексия класса
$reflectionClass = new ReflectionClass(UserController::class);
$classAttributes = $reflectionClass->getAttributes(Route::class);

if (!empty($classAttributes)) {
    // Создаём экземпляр атрибута с переданными аргументами
    $routeAttrInstance = $classAttributes[0]->newInstance();
    echo "Путь класса: " . $routeAttrInstance->path; // Выведет: /api/users
    echo "Метод класса: " . $routeAttrInstance->method; // Выведет: GET
}

// Рефлексия метода
$reflectionMethod = new ReflectionMethod(UserController::class, 'getUser');
$methodAttributes = $reflectionMethod->getAttributes();

foreach ($methodAttributes as $attribute) {
    $instance = $attribute->newInstance();
    if ($instance instanceof Route) {
        echo "Путь метода: " . $instance->path; // Выведет: /api/users/{id}
    }
}

// Рефлексия свойства
$reflectionProperty = new ReflectionProperty(UserController::class, 'id');
$propAttr = $reflectionProperty->getAttribute(Column::class);
if ($propAttr) {
    $column = $propAttr->newInstance();
    echo "Имя поля в БД: " . $column->name; // Выведет: user_id
}

Ключевые методы:

• getAttributes(?string $name = null) — возвращает массив объектов ReflectionAttribute. Можно фильтровать по имени класса атрибута.
• newInstance() — создаёт и возвращает экземпляр класса атрибута, передавая в его конструктор аргументы, указанные при объявлении.

Для PHP 7.x и ниже (Докблок-аннотации)

В PHP 7 и ранее "аннотации" существовали только как комментарии в формате DocBlock (/** ... */). Для их чтения требуется парсинг.

1. Определение аннотаций (в комментариях)

<?php
/**
 * @Route("/api/users")
 */
class UserController {
    /**
     * @Column(name="user_id", type="integer")
     */
    private $id;

    /**
     * @Route("/api/users/{id}")
     * @Method("GET")
     */
    public function getUser($id) { }
}

2. Чтение с помощью библиотек или ручного парсинга

Вы можете использовать популярную библиотеку doctrine/annotations, которая предоставляет удобный API.

composer require doctrine/annotations

<?php
use Doctrine\Common\Annotations\AnnotationReader;

// Создаём ридер
$reader = new AnnotationReader();

// Чтение аннотаций класса
$reflectionClass = new ReflectionClass(UserController::class);
$classAnnotations = $reader->getClassAnnotations($reflectionClass);

foreach ($classAnnotations as $annotation) {
    if ($annotation instanceof Route) {
        echo $annotation->value; // Выведет: /api/users
    }
}

// Чтение аннотаций свойства
$reflectionProperty = new ReflectionProperty(UserController::class, 'id');
$propAnnotations = $reader->getPropertyAnnotations($reflectionProperty);

3. Ручной парсинг (без библиотек)

Можно извлечь DocBlock и распарсить его регулярными выражениями (не рекомендуется для продакшена из-за хрупкости).

<?php
$reflectionMethod = new ReflectionMethod(UserController::class, 'getUser');
$docComment = $reflectionMethod->getDocComment();

// Упрощённый парсинг для примера
if (preg_match('/@Route\(["\'](.+?)["\']\)/', $docComment, $matches)) {
    echo "Найден путь: " . $matches[1]; // Выведет: /api/users/{id}
}

Сравнение и рекомендации

Практический совет и выводы

1. Всегда используйте атрибуты для новых проектов на PHP 8+. Они быстрее, безопаснее и удобнее.
2. Для чтения используйте встроенный Reflection API. Метод getAttributes() — ваша основная точка входа.
3. Если вам нужна сложная логика инициализации атрибутов, вы можете переопределить метод newInstance() в классе атрибута.
4. Атрибуты могут иметь целевые объекты (класс, метод, свойство и т.д.), что контролируется аргументом флагов в #[Attribute()]. Это помогает избежать ошибок применения.
5. Кэширование рефлексии — в высоконагруженных приложениях создание Reflection-объектов на каждый запрос может быть затратным. Рассмотрите кэширование результатов (например, с помощью Symfony Cache или в статическом свойстве).

Таким образом, "добраться" до аннотаций — это значит использовать Reflection API для получения объекта рефлексии нужного элемента кода, а затем вызвать у него метод для извлечения метаданных: getAttributes() для атрибутов PHP 8+ или парсинг getDocComment()/использование сторонних библиотек для докблок-аннотаций в PHP 7.