CloudCastle Curl

BodyFormat : string
in package

Формат тела ответа, поддающийся автоматическому разбору.

Используется Response::parsed() для определения, во что разбирать тело: по заголовку Content-Type и по самому содержимому. Если оба признака заданы и противоречат друг другу, разбор считается неоднозначным.

Table of Contents

Cases

Json  = 'json'
Neon  = 'neon'
Xml  = 'xml'
Yaml  = 'yaml'

Methods

detect()  : self|null
Определить формат тела по заголовку и содержимому вместе.
fromContent()  : self|null
Определить формат по содержимому тела (осторожная эвристика).
fromContentType()  : self|null
Определить формат по значению заголовка `Content-Type`.

Cases

Methods

detect()

Определить формат тела по заголовку и содержимому вместе.

public static detect(string $contentType, string $body) : self|null
Parameters
$contentType : string

значение заголовка Content-Type

$body : string

тело ответа

Tags
throws
ResponseFormatException

если заголовок и содержимое противоречат друг другу

Return values
self|null —

согласованный формат или null, если формат не распознан

fromContent()

Определить формат по содержимому тела (осторожная эвристика).

public static fromContent(string $body) : self|null

Распознаются только надёжные маркеры структуры: JSON ({/[) и XML (<) при подтверждении валидатором. YAML и NEON по содержимому не угадываются — они слишком всеядны и дали бы ложные срабатывания.

Parameters
$body : string

тело ответа

Return values
self|null —

формат или null, если содержимое не распознано

fromContentType()

Определить формат по значению заголовка `Content-Type`.

public static fromContentType(string $contentType) : self|null
Parameters
$contentType : string

значение заголовка (регистр и параметры не важны)

Return values
self|null —

формат или null, если тип не распознан

On this page

Search results