HttpResponse.ru.md

HttpResponse

• класс HttpResponse (httpclient\HttpResponse)
• исходники httpclient/HttpResponse.php

Описание

Class HttpResponse

---

Свойства

• ->body : mixed
• ->responseCode : mixed
• ->statusMessage : mixed
• ->headers : mixed
• ->cookies : mixed
• ->time : Time

---

Методы

• ->__construct() - HttpResponse constructor.
• ->body()
• ->statusCode()
• ->statusMessage()
• ->headers()
• ->header() - Returns header value.
• ->contentType() - Returns Content-Type header value.
• ->contentLength() - Content-Length header value, returns -1 if it does not exist.
• ->cookie()
• ->cookies() - Return array of Set-Cookie header.
• ->isSuccess() - Check http code >= 200 and <= 399
• ->isFail() - Check http code >= 400
• ->isError() - Check http code >= 400
• ->isBadRequest() - Check http code is 400.
• ->isAuthRequired() - Check http code is 401.
• ->isPaymentRequired() - Check http code is 402.
• ->isNotFound() - Check http code is 404
• ->isAccessDenied() - Check http code is 403
• ->isInvalidMethod() - Check http code is 405
• ->isServerError() - Check http code >= 500
• ->isServiceUnavailable() - Check http code is 503.
• ->time() - Time of creation response.

---

Методы

__construct()

__construct(): void

HttpResponse constructor.

---

body()

body(mixed $data): mixed|string|array|Stream

---

statusCode()

statusCode([ int $responseCode): int

---

statusMessage()

statusMessage([ string $statusMessage): string

---

headers()

headers([ array $headerFields): array

---

header()

header(string $name): mixed

Returns header value.

---

contentType()

contentType([ string $contentType): string

Returns Content-Type header value.

---

contentLength()

contentLength([ int $size): int

Content-Length header value, returns -1 if it does not exist.

---

cookie()

cookie(string $name): string|array

---

cookies()

cookies(array $data): array

Return array of Set-Cookie header.

---

isSuccess()

isSuccess(): bool

Check http code >= 200 and <= 399

---

isFail()

isFail(): bool

Check http code >= 400

---

isError()

isError(): bool

Check http code >= 400

---

isBadRequest()

isBadRequest(): bool

Check http code is 400.

---

isAuthRequired()

isAuthRequired(): bool

Check http code is 401.

---

isPaymentRequired()

isPaymentRequired(): bool

Check http code is 402.

---

isNotFound()

isNotFound(): bool

Check http code is 404

---

isAccessDenied()

isAccessDenied(): bool

Check http code is 403

---

isInvalidMethod()

isInvalidMethod(): bool

Check http code is 405

---

isServerError()

isServerError(): bool

Check http code >= 500

---

isServiceUnavailable()

isServiceUnavailable(): bool

Check http code is 503.

---

time()

time(): php\time\Time

Time of creation response.