Класс ContentTypeNegotiation
Переговоры о предпочтительном формате содержимого из того, что предоставляет приложение, и того, что запрос имеет в своем заголовке Accept.
Краткое описание методов
-
acceptLanguage() public
Проверка, принимает ли запрос заданный код языка.
-
acceptedLanguages() public
Получение нормализованного списка принятых языков
-
parseAccept() public
Парсинг заголовков Accept* с опциями квалификаторов.
-
parseAcceptLanguage() public
Парсинг заголовка Accept-Language
-
parseQualifiers() protected
Парсинг значения заголовка в отображение предпочтение => значение
-
preferredType() public
Получение наиболее предпочтительного формата содержимого из запроса.
Подробное описание методов
acceptLanguage() public
acceptLanguage(Psr\Http\Message\RequestInterface $request, string $lang): bool
Проверка, принимает ли запрос заданный код языка.
Коды языков в запросе будут приведены к нижнему регистру и _ заменены на -.
Параметры
-
Psr\Http\Message\RequestInterface$request Запрос для чтения заголовков.
-
string$lang Код языка для проверки.
Возвращает
boolacceptedLanguages() public
acceptedLanguages(Psr\Http\Message\RequestInterface $request): array<string>
Получение нормализованного списка принятых языков
Коды языков в запросе будут приведены к нижнему регистру и _ заменены на -.
Параметры
-
Psr\Http\Message\RequestInterface$request Запрос для чтения заголовков.
Возвращает
array<string>parseAccept() public
parseAccept(Psr\Http\Message\RequestInterface $request): array<string, array<string>>
Парсинг заголовков Accept* с опциями квалификаторов.
Будут извлечены только квалификаторы, любые другие расширения accept будут отброшены, так как они не используются часто.
Параметры
-
Psr\Http\Message\RequestInterface$request Запрос для получения accept.
Возвращает
array<string, array<string>>parseAcceptLanguage() public
parseAcceptLanguage(Psr\Http\Message\RequestInterface $request): array<string, array<string>>
Парсинг заголовка Accept-Language
Будут извлечены только квалификаторы, другие расширения будут проигнорированы, так как они не используются часто.
Параметры
-
Psr\Http\Message\RequestInterface$request Запрос для получения accept.
Возвращает
array<string, array<string>>parseQualifiers() protected
parseQualifiers(string $header): array<string, array<string>>
Парсинг значения заголовка в отображение предпочтение => значение
Параметры
-
string$header Значение заголовка для парсинга
Возвращает
array<string, array<string>>preferredType() public
preferredType(Psr\Http\Message\RequestInterface $request, array<string> $choices = []): string|null
Получение наиболее предпочтительного формата содержимого из запроса.
Парсинг предпочтений заголовка Accept и возврат наиболее предпочтительного формата. Если несколько типов связаны по предпочтению, будет возвращен первый тип этого значения предпочтения.
Можно ожидать null, когда у запроса нет заголовка Accept.
Параметры
-
Psr\Http\Message\RequestInterface$request Используемый запрос.
-
array<string>$choices optional Поддерживаемые варианты формата содержимого.
Возвращает
string|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Http.ContentTypeNegotiation.html