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

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

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

Исходный код на GitHub

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

use Phalcon\Mvc\Router\Annotations;

$di->setShared(
    "router",
    function() {
        // Use the annotations router
        $router = new Annotations(false);

        // This will do the same as above but only if the handled uri starts with /robots
        $router->addResource("Robots", "/robots");

        return $router;
    }
);

Константы

целое число URI_SOURCE_GET_URL

целое число URI_SOURCE_SERVER_REQUEST_URI

целое число POSITION_FIRST

целое число POSITION_LAST

Методы

public addResource (смешанный тип $handler, [смешанный тип $prefix])

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

public addModuleResource (смешанный тип $module, смешанный тип $handler, [смешанный тип $prefix])

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

public handle ([смешанный тип $uri])

Создаёт параметры маршрутизации из информации о перенаправлении

public processControllerAnnotation (смешанный тип $handler, Phalcon\Annotations\Annotation $annotation)

Проверяет наличие аннотаций в блоке документации контроллера

public processActionAnnotation (смешанный тип $module, смешанный тип $namespaceName, смешанный тип $controller, смешанный тип $action, Phalcon\Annotations\Annotation $annotation)

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

public setControllerSuffix (смешанный тип $controllerSuffix)

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

public setActionSuffix (смешанный тип $actionSuffix)

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

public getResources ()

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

public __construct ([смешанный тип $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 (смешанный тип $uriSource) унаследован от Phalcon\Mvc\Router

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

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

public removeExtraSlashes (смешанный тип $remove) унаследован от Phalcon\Mvc\Router

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

public setDefaultNamespace (смешанный тип $namespaceName) унаследован от Phalcon\Mvc\Router

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

public setDefaultModule (смешанный тип $moduleName) унаследован от Phalcon\Mvc\Router

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

public setDefaultController (смешанный тип $controllerName) унаследован от Phalcon\Mvc\Router

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

public setDefaultAction (смешанный тип $actionName) унаследован от Phalcon\Mvc\Router

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

public setDefaults (массив $defaults) унаследован от Phalcon\Mvc\Router

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

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

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

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

public add (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $httpMethods], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

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 (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

public addPost (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

public addPut (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

public addPatch (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

public addDelete (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

public addOptions (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

public addHead (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

public addPurge (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

public addTrace (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $position]) унаследован от Phalcon\Mvc\Router

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

public addConnect (смешанный тип $pattern, [смешанный тип $paths], [смешанный тип $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

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