Spec-Zone.ru › Symfony 3.4

AnnotationClassLoader

class AnnotationClassLoader implements LoaderInterface

AnnotationClassLoader загружает информацию о маршрутизации из класса PHP и его методов.

Вам необходимо определить реализацию метода getRouteDefaults(). В большинстве случаев этот метод должен определять вызываемый для маршрута PHP-вызов (контроллер в MVC).

Аннотация @Route может быть установлена в классе (для глобальных параметров) и в каждом методе.

Основное значение аннотации @Route — путь к маршруту. Аннотация также распознает несколько параметров: требования, опции, значения по умолчанию, схемы, методы, хост и имя. Параметр имени является обязательным. Вот пример того, как вы должны использовать его:

/**
 * @Route("/Blog")
 * /
class Blog
{
    /**
     * @Route("/", name="blog_index")
     * /
    public function index()
    {
    }

    /**
     * @Route("/{id}", name="blog_post", requirements = {"id" = "\d+"})
     * /
    public function show()
    {
    }
}

Методы

__construct(Reader $reader)
setRouteAnnotationClass(string $class)

Устанавливает класс аннотации для чтения свойств маршрута.

load(string $class, string|null $type = null)

Загружает аннотации из класса.

bool supports(mixed $resource, string|null $type = null)

Возвращает, поддерживает ли этот класс данный ресурс.

setResolver(LoaderResolverInterface $resolver)

Устанавливает разрешитель загрузчика.

LoaderResolverInterface getResolver()

Возвращает разрешитель загрузчика.

Подробности

__construct(Reader $reader)

Параметры

Reader $reader

setRouteAnnotationClass(string $class)

Устанавливает класс аннотации для чтения свойств маршрута.

Параметры

string $class Полное имя класса

load(string $class, string|null $type = null)

Загружает аннотации из класса.

Параметры

string $class Имя класса
string|null $type Тип ресурса или null, если неизвестен

Исключения

InvalidArgumentException При невозможности парсинга маршрута

bool supports(mixed $resource, string|null $type = null)

Возвращает, поддерживает ли этот класс данный ресурс.

Параметры

mixed $resource Ресурс
string|null $type Тип ресурса или null, если неизвестен

Возвращаемое значение

bool True, если данный класс поддерживает данный ресурс, иначе false

setResolver(LoaderResolverInterface $resolver)

Устанавливает разрешитель загрузчика.

Параметры

LoaderResolverInterface $resolver

LoaderResolverInterface getResolver()

Возвращает разрешитель загрузчика.

Возвращаемое значение

LoaderResolverInterface Экземпляр LoaderResolverInterface

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Routing/Loader/AnnotationClassLoader.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API