Класс Phalcon\Mvc\Router\Annotations

расширяет класс Phalcon\Mvc\Router

Реализует Phalcon\Di\InjectionAwareInterface, Phalcon\Mvc\RouterInterface, Phalcon\Events\EventsAwareInterface

Source on GitHub

Маршрутизатор, считывающий аннотации маршрутов из классов/ресурсов

<?php

use Phalcon\Mvc\Router\Annotations;

$di->setShared(
    "router",
    function() {
        // Использование маршрутизатора аннотаций
        $router = new Annotations(false);

        // Это будет делать то же самое, что и выше, но только если обработанный URI начинается с /robots
        $router->addResource("Robots", "/robots");

        return $router;
    }
);

Константы

integer URI_SOURCE_GET_URL

integer URI_SOURCE_SERVER_REQUEST_URI

integer POSITION_FIRST

integer POSITION_LAST

Методы

public addResource (mixed $handler, [mixed $prefix])

Добавляет ресурс в обработчик аннотаций ресурс — это класс, содержащий аннотации маршрутизации

public addModuleResource (mixed $module, mixed $handler, [mixed $prefix])

Добавляет ресурс к обработчику аннотаций. Ресурс - это класс, содержащий аннотации маршрутизации. Класс расположен в модуле

public handle ([mixed $uri])

Произвести параметры маршрутизации из информации перезаписи

public processControllerAnnotation (mixed $handler, Phalcon\Annotations\Annotation $annotation)

Проверяет аннотации в контроллере docblock

public processActionAnnotation (mixed $module, mixed $namespaceName, mixed $controller, mixed $action, Phalcon\Annotations\Annotation $annotation)

Проверяет аннотации в общедоступных методах контроллера

public setControllerSuffix (mixed $controllerSuffix)

Изменяет суффикс класса контроллера

public setActionSuffix (mixed $actionSuffix)

Изменяет суффикс метода действия

public getResources ()

Возврат зарегистрированных ресурсов

public __construct ([mixed $defaultRoutes]) наследуется от Phalcon\Mvc\Router

Phalcon\Mvc\Router конструктор

public setDI (Phalcon\DiInterface $dependencyInjector) наследуется от Phalcon\Mvc\Router

Устанавливает инжектор зависимостей

public getDI () наследуется от Phalcon\Mvc\Router

Возвращает инжектор внутренних зависимостей

public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) наследуется от Phalcon\Mvc\Router

Устанавливает диспетчер событий

public getEventsManager () наследуется от Phalcon\Mvc\Router

Возвращает внутренний менеджер событий

public getRewriteUri () наследуется от Phalcon\Mvc\Router

Получите информацию о переписывании. Эта информация считывается из $_GET["_url"]. Это возвращает '/', если переписать информацию не удается.

public setUriSource (mixed $uriSource) наследуется от Phalcon\Mvc\Router

Устанавливает источник URI. Одна из констант URISOURCE*

<?php

$router->setUriSource(
    Router::URI_SOURCE_SERVER_REQUEST_URI
);

public removeExtraSlashes (mixed $remove) наследуется от Phalcon\Mvc\Router

Укажите, должен ли маршрутизатор удалять лишние косые черты в обработанных маршрутах

public setDefaultNamespace (mixed $namespaceName) наследуется от Phalcon\Mvc\Router

Устанавливает имя пространства имен по умолчанию

public setDefaultModule (mixed $moduleName) наследуется от Phalcon\Mvc\Router

Устанавливает имя модуля по умолчанию

public setDefaultController (mixed $controllerName) наследуется от Phalcon\Mvc\Router

Устанавливает имя контроллера по умолчанию

public setDefaultAction (mixed $actionName) наследуется от Phalcon\Mvc\Router

Устанавливает имя действия по умолчанию

public setDefaults (array $defaults) наследуется от Phalcon\Mvc\Router

Устанавливает массив путей по умолчанию. Если в маршруте отсутствует путь, маршрутизатор будет использовать определенные здесь. Этот метод не должен использоваться для установки маршрута 404

<?php

$router->setDefaults(
    [
        "module" => "common",
        "action" => "index",
    ]
);

public getDefaults () наследуется от Phalcon\Mvc\Router

Возвращает массив параметров по умолчанию

public handle ([mixed $uri]) наследуется от Phalcon\Mvc\Router

Обрабатывает информацию о маршрутизации, полученную от механизма перезаписи

<?php

// Прочитать информацию с помощью механизма перезаписи
$router->handle();

// Передача URL вручную
$router->handle("/posts/edit/1");

public add (mixed $pattern, [mixed $paths], [mixed $httpMethods], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору без ограничения HTTP

<?php

use Phalcon\Mvc\Router;

$router->add("/about", "About::index");
$router->add("/about", "About::index", ["GET", "POST"]);
$router->add("/about", "About::index", ["GET", "POST"], Router::POSITION_FIRST);

public addGet (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP-методу GET

public addPost (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP-методу POST

public addPut (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP-методу PUT

public addPatch (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP-методу PATCH

public addDelete (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP-методу DELETE

public addOptions (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP - метод OPTIONS

public addHead (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP-методу HEAD

public addPurge (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP-методу PURGE (поддержка Squid и Varnish)

public addTrace (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP-методу TRACE

public addConnect (mixed $pattern, [mixed $paths], [mixed $position]) наследуется от Phalcon\Mvc\Router

Добавляет маршрут к маршрутизатору, который соответствует только HTTP-методу CONNECT

public mount (Phalcon\Mvc\Router\GroupInterface $group) наследуется от Phalcon\Mvc\Router

Настраивает группу маршрутов в маршрутизаторе

public notFound (mixed $paths) наследуется от Phalcon\Mvc\Router

Задать группу путей, которые будут возвращены, когда ни один из определенных маршрутов не будет согласован

public clear () наследуется от Phalcon\Mvc\Router

Удаляет все заранее определенные маршруты

public getNamespaceName () наследуется от Phalcon\Mvc\Router

Возвращает обработанное имя пространства имен

public getModuleName () наследуется от Phalcon\Mvc\Router

Возвращает имя обработанного модуля

public getControllerName () наследуется от Phalcon\Mvc\Router

Возвращает имя обработанного контроллера

public getActionName () наследуется от Phalcon\Mvc\Router

Возвращает имя обработанного действия

public getParams () наследуется от Phalcon\Mvc\Router

Возвращает обработанные параметры

public getMatchedRoute () наследуется от Phalcon\Mvc\Router

Возвращает маршрут, который соответствует обработанному URI

public getMatches () наследуется от Phalcon\Mvc\Router

Возвращает вспомогательные выражения в соответствующем регулярном выражении

public wasMatched () наследуется от Phalcon\Mvc\Router

Проверяет, соответствует ли маршрутизатор любому из определенных маршрутов

public getRoutes () наследуется от Phalcon\Mvc\Router

Возвращает все маршруты, определенные в маршрутизаторе

public getRouteById (mixed $id) наследуется от Phalcon\Mvc\Router

Возвращает объект маршрута по его идентификатору

public getRouteByName (mixed $name) наследуется от Phalcon\Mvc\Router

Возвращает объект маршрута по имени

public isExactControllerName () наследуется от Phalcon\Mvc\Router

Возвращает, не следует ли изменять имя контроллера