Documentation

Route
in package

Класс для управления маршрутизацией HTTP-запросов с поддержкой именованных маршрутов, middleware, групп маршрутов и обработки статических файлов.

Table of Contents

Properties

$globalMiddlewares  : array<string|int, mixed>
$groupStack  : array<string|int, mixed>
$namedRoutes  : array<string|int, mixed>
$notFoundCallback  : callable|null
$requestLogger  : RequestLogger|null
$routes  : array<string|int, mixed>
$server  : Server|null
$staticPath  : string|null

Methods

autoRegisterMorphComponents()  : void
Автоматически регистрирует маршруты для компонентов Morph
delete()  : void
Регистрирует DELETE-маршрут
get()  : void
Регистрирует GET-маршрут
getNamedRoutes()  : array<string|int, mixed>
Возвращает список всех именованных маршрутов
group()  : void
Группирует маршруты с общим префиксом и middleware
handleRequest()  : Response
Обрабатывает входящий запрос
hasRoute()  : bool
Проверяет, существует ли маршрут с указанным именем
head()  : void
Регистрирует HEAD-маршрут
middleware()  : void
Добавляет глобальный middleware
notFound()  : void
Устанавливает обработчик 404 ошибки
options()  : void
Регистрирует OPTIONS-маршрут
patch()  : void
Регистрирует PATCH-маршрут
post()  : void
Регистрирует POST-маршрут
put()  : void
Регистрирует PUT-маршрут
route()  : string
Генерирует URL по имени маршрута
setServer()  : void
Устанавливает сервер и логгер запросов
startHandling()  : void
Запускает обработку маршрутов
staticFolder()  : void
Устанавливает путь к статическим файлам
addRoute()  : void
Добавляет маршрут в коллекцию
applyGroupNamePrefix()  : string
Применяет префикс группы к имени маршрута
applyGroupPrefix()  : string
Применяет префикс группы к пути маршрута
getGroupMiddlewares()  : array<string|int, mixed>
Возвращает middleware текущей группы
getMimeType()  : string
Определяет MIME-тип файла по его расширению
wrapWithMiddlewares()  : callable
Оборачивает обработчик в цепочку middleware

Properties

$globalMiddlewares

private static array<string|int, mixed> $globalMiddlewares = []

Глобальные middleware

$groupStack

private static array<string|int, mixed> $groupStack = []

Стек групп маршрутов

$namedRoutes

private static array<string|int, mixed> $namedRoutes = []

Массив именованных маршрутов

$notFoundCallback

private static callable|null $notFoundCallback = null

Обработчик 404 ошибки

$requestLogger

private static RequestLogger|null $requestLogger = null

Логгер запросов

$routes

private static array<string|int, mixed> $routes = []

Массив зарегистрированных маршрутов

$server

private static Server|null $server = null

Сервер для обработки запросов

$staticPath

private static string|null $staticPath = null

Путь к статическим файлам

Methods

autoRegisterMorphComponents()

Автоматически регистрирует маршруты для компонентов Morph

public static autoRegisterMorphComponents([string|null $componentsPath = null ]) : void
Parameters
$componentsPath : string|null = null

Путь к компонентам Morph

delete()

Регистрирует DELETE-маршрут

public static delete(string $path, callable $callback[, array<string|int, mixed> $middlewares = [] ][, string|null $name = null ]) : void
Parameters
$path : string

Путь маршрута

$callback : callable

Обработчик маршрута

$middlewares : array<string|int, mixed> = []

Массив middleware

$name : string|null = null

Имя маршрута (для генерации URL)

get()

Регистрирует GET-маршрут

public static get(string $path, callable $callback[, array<string|int, mixed> $middlewares = [] ][, string|null $name = null ]) : void
Parameters
$path : string

Путь маршрута

$callback : callable

Обработчик маршрута

$middlewares : array<string|int, mixed> = []

Массив middleware

$name : string|null = null

Имя маршрута (для генерации URL)

getNamedRoutes()

Возвращает список всех именованных маршрутов

public static getNamedRoutes() : array<string|int, mixed>
Return values
array<string|int, mixed>

group()

Группирует маршруты с общим префиксом и middleware

public static group(string $prefix, callable $callback[, array<string|int, mixed> $middlewares = [] ][, string|null $namePrefix = null ]) : void
Parameters
$prefix : string

Префикс пути для группы

$callback : callable

Функция с определением маршрутов группы

$middlewares : array<string|int, mixed> = []

Массив middleware для группы

$namePrefix : string|null = null

Префикс для имен маршрутов в группе

handleRequest()

Обрабатывает входящий запрос

public static handleRequest(Request $request) : Response
Parameters
$request : Request

Объект запроса

Return values
Response —

Объект ответа

hasRoute()

Проверяет, существует ли маршрут с указанным именем

public static hasRoute(string $name) : bool
Parameters
$name : string

Имя маршрута

Return values
bool

head()

Регистрирует HEAD-маршрут

public static head(string $path, callable $callback[, array<string|int, mixed> $middlewares = [] ][, string|null $name = null ]) : void
Parameters
$path : string

Путь маршрута

$callback : callable

Обработчик маршрута

$middlewares : array<string|int, mixed> = []

Массив middleware

$name : string|null = null

Имя маршрута (для генерации URL)

middleware()

Добавляет глобальный middleware

public static middleware(callable|object $middleware) : void
Parameters
$middleware : callable|object

Middleware (функция или объект с методом handle)

Tags
throws
InvalidArgumentException

Если middleware не callable и не имеет метода handle

notFound()

Устанавливает обработчик 404 ошибки

public static notFound(callable $callback) : void
Parameters
$callback : callable

Функция-обработчик

options()

Регистрирует OPTIONS-маршрут

public static options(string $path, callable $callback[, array<string|int, mixed> $middlewares = [] ][, string|null $name = null ]) : void
Parameters
$path : string

Путь маршрута

$callback : callable

Обработчик маршрута

$middlewares : array<string|int, mixed> = []

Массив middleware

$name : string|null = null

Имя маршрута (для генерации URL)

patch()

Регистрирует PATCH-маршрут

public static patch(string $path, callable $callback[, array<string|int, mixed> $middlewares = [] ][, string|null $name = null ]) : void
Parameters
$path : string

Путь маршрута

$callback : callable

Обработчик маршрута

$middlewares : array<string|int, mixed> = []

Массив middleware

$name : string|null = null

Имя маршрута (для генерации URL)

post()

Регистрирует POST-маршрут

public static post(string $path, callable $callback[, array<string|int, mixed> $middlewares = [] ][, string|null $name = null ]) : void
Parameters
$path : string

Путь маршрута

$callback : callable

Обработчик маршрута

$middlewares : array<string|int, mixed> = []

Массив middleware

$name : string|null = null

Имя маршрута (для генерации URL)

put()

Регистрирует PUT-маршрут

public static put(string $path, callable $callback[, array<string|int, mixed> $middlewares = [] ][, string|null $name = null ]) : void
Parameters
$path : string

Путь маршрута

$callback : callable

Обработчик маршрута

$middlewares : array<string|int, mixed> = []

Массив middleware

$name : string|null = null

Имя маршрута (для генерации URL)

route()

Генерирует URL по имени маршрута

public static route(string $name[, array<string|int, mixed> $parameters = [] ]) : string
Parameters
$name : string

Имя маршрута

$parameters : array<string|int, mixed> = []

Параметры для подстановки в URL

Tags
throws
InvalidArgumentException

Если маршрут не найден или не хватает параметров

Return values
string

setServer()

Устанавливает сервер и логгер запросов

public static setServer(Server $server, RequestLogger $requestLogger) : void
Parameters
$server : Server

Объект сервера

$requestLogger : RequestLogger

Логгер запросов

startHandling()

Запускает обработку маршрутов

public static startHandling(callable $onStartCallback) : void
Parameters
$onStartCallback : callable

Функция, вызываемая при старте сервера

Tags
throws
Exception

Если сервер не установлен

staticFolder()

Устанавливает путь к статическим файлам

public static staticFolder(string $path) : void
Parameters
$path : string

Путь к папке со статическими файлами

addRoute()

Добавляет маршрут в коллекцию

private static addRoute(string $method, string $path, callable $callback[, array<string|int, mixed> $middlewares = [] ][, string|null $name = null ]) : void
Parameters
$method : string

HTTP-метод

$path : string

Путь маршрута

$callback : callable

Обработчик маршрута

$middlewares : array<string|int, mixed> = []

Массив middleware

$name : string|null = null

Имя маршрута

applyGroupNamePrefix()

Применяет префикс группы к имени маршрута

private static applyGroupNamePrefix(string $name) : string
Parameters
$name : string

Исходное имя маршрута

Return values
string —

Полное имя с учетом префиксов групп

applyGroupPrefix()

Применяет префикс группы к пути маршрута

private static applyGroupPrefix(string $path) : string
Parameters
$path : string

Исходный путь

Return values
string —

Полный путь с учетом префиксов групп

getGroupMiddlewares()

Возвращает middleware текущей группы

private static getGroupMiddlewares() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Массив middleware

getMimeType()

Определяет MIME-тип файла по его расширению

private static getMimeType(string $filePath) : string
Parameters
$filePath : string

Путь к файлу

Return values
string —

MIME-тип

wrapWithMiddlewares()

Оборачивает обработчик в цепочку middleware

private static wrapWithMiddlewares(callable $handler, array<string|int, mixed> $middlewares) : callable
Parameters
$handler : callable

Исходный обработчик

$middlewares : array<string|int, mixed>

Массив middleware

Return values
callable —

Обработанный обработчик

Loading…
On this page

Search results