PHP Класс SevenShores\Hubspot\Http\Response

Наследование: implements Psr\Http\Message\ResponseInterface, implements ArrayAcces\ArrayAccess
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$data mixed

Защищенные свойства (Protected)

Свойство Тип Описание
$response Psr\Http\Message\ResponseInterface

Открытые методы

Метод Описание
__construct ( Psr\Http\Message\ResponseInterface $response )
__get ( string $name ) : mixed Get the api data from the response as usual.
getBody ( ) : Psr\Http\Message\StreamInterface Gets the body of the message.
getData ( ) : mixed Get the underlying data.
getHeader ( string $name ) : string[] Retrieves a message header value by the given case-insensitive name.
getHeaderLine ( string $name ) : string Retrieves a comma-separated string of the values for a single header.
getHeaders ( ) : array Retrieves all message header values.
getProtocolVersion ( ) : string Retrieves the HTTP protocol version as a string.
getReasonPhrase ( ) : string Gets the response reason phrase associated with the status code.
getStatusCode ( ) : integer Gets the response status code.
hasHeader ( string $name ) : boolean Checks if a header exists by the given case-insensitive name.
offsetExists ( mixed $offset ) : boolean Whether a offset exists
offsetGet ( mixed $offset ) : mixed Offset to retrieve
offsetSet ( mixed $offset, mixed $value ) : void Offset to set
offsetUnset ( mixed $offset ) : void Offset to unset
toArray ( ) : array Return an array of the data.
withAddedHeader ( string $name, string | string[] $value ) : self Return an instance with the specified header appended with the given value.
withBody ( Psr\Http\Message\StreamInterface $body ) : self Return an instance with the specified message body.
withHeader ( string $name, string | string[] $value ) : self Return an instance with the provided value replacing the specified header.
withProtocolVersion ( string $version ) : self Return an instance with the specified HTTP protocol version.
withStatus ( integer $code, string $reasonPhrase = '' ) : self Return an instance with the specified status code and, optionally, reason phrase.
withoutHeader ( string $name ) : self Return an instance without the specified header.

Приватные методы

Метод Описание
getDataFromResponse ( Psr\Http\Message\ResponseInterface $response ) : mixed

Описание методов

__construct() публичный Метод

public __construct ( Psr\Http\Message\ResponseInterface $response )
$response Psr\Http\Message\ResponseInterface

__get() публичный Метод

Get the api data from the response as usual.
public __get ( string $name ) : mixed
$name string
Результат mixed

getBody() публичный Метод

Gets the body of the message.
public getBody ( ) : Psr\Http\Message\StreamInterface
Результат Psr\Http\Message\StreamInterface Returns the body as a stream.

getData() публичный Метод

Get the underlying data.
public getData ( ) : mixed
Результат mixed

getHeader() публичный Метод

This method returns an array of all the header values of the given case-insensitive header name. If the header does not appear in the message, this method MUST return an empty array.
public getHeader ( string $name ) : string[]
$name string Case-insensitive header field name.
Результат string[] An array of string values as provided for the given header. If the header does not appear in the message, this method MUST return an empty array.

getHeaderLine() публичный Метод

This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma. NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating. If the header does not appear in the message, this method MUST return an empty string.
public getHeaderLine ( string $name ) : string
$name string Case-insensitive header field name.
Результат string A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.

getHeaders() публичный Метод

The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header. Represent the headers as a string foreach ($message->getHeaders() as $name => $values) { echo $name . ": " . implode(", ", $values); } Emit headers iteratively: foreach ($message->getHeaders() as $name => $values) { foreach ($values as $value) { header(sprintf('%s: %s', $name, $value), false); } } While header names are not case-sensitive, getHeaders() will preserve the exact case in which headers were originally specified.
public getHeaders ( ) : array
Результат array Returns an associative array of the message's headers. Each key MUST be a header name, and each value MUST be an array of strings for that header.

getProtocolVersion() публичный Метод

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
public getProtocolVersion ( ) : string
Результат string HTTP protocol version.

getReasonPhrase() публичный Метод

Because a reason phrase is not a required element in a response status line, the reason phrase value MAY be null. Implementations MAY choose to return the default RFC 7231 recommended reason phrase (or those listed in the IANA HTTP Status Code Registry) for the response's status code.
См. ссылку: http://tools.ietf.org/html/rfc7231#section-6
См. ссылку: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
public getReasonPhrase ( ) : string
Результат string Reason phrase; must return an empty string if none present.

getStatusCode() публичный Метод

The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.
public getStatusCode ( ) : integer
Результат integer Status code.

hasHeader() публичный Метод

Checks if a header exists by the given case-insensitive name.
public hasHeader ( string $name ) : boolean
$name string Case-insensitive header field name.
Результат boolean Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.

offsetExists() публичный Метод

Whether a offset exists
public offsetExists ( mixed $offset ) : boolean
$offset mixed
Результат boolean

offsetGet() публичный Метод

Offset to retrieve
public offsetGet ( mixed $offset ) : mixed
$offset mixed
Результат mixed

offsetSet() публичный Метод

Offset to set
public offsetSet ( mixed $offset, mixed $value ) : void
$offset mixed
$value mixed
Результат void

offsetUnset() публичный Метод

Offset to unset
public offsetUnset ( mixed $offset ) : void
$offset mixed
Результат void

toArray() публичный Метод

Return an array of the data.
public toArray ( ) : array
Результат array

withAddedHeader() публичный Метод

Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added. This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new header and/or value.
public withAddedHeader ( string $name, string | string[] $value ) : self
$name string Case-insensitive header field name to add.
$value string | string[] Header value(s).
Результат self

withBody() публичный Метод

The body MUST be a StreamInterface object. This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the new body stream.
public withBody ( Psr\Http\Message\StreamInterface $body ) : self
$body Psr\Http\Message\StreamInterface Body.
Результат self

withHeader() публичный Метод

While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders(). This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new and/or updated header and value.
public withHeader ( string $name, string | string[] $value ) : self
$name string Case-insensitive header field name.
$value string | string[] Header value(s).
Результат self

withProtocolVersion() публичный Метод

The version string MUST contain only the HTTP version number (e.g., "1.1", "1.0"). This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new protocol version.
public withProtocolVersion ( string $version ) : self
$version string HTTP protocol version
Результат self

withStatus() публичный Метод

If no reason phrase is specified, implementations MAY choose to default to the RFC 7231 or IANA recommended reason phrase for the response's status code. This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated status and reason phrase.
См. ссылку: http://tools.ietf.org/html/rfc7231#section-6
См. ссылку: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
public withStatus ( integer $code, string $reasonPhrase = '' ) : self
$code integer The 3-digit integer result code to set.
$reasonPhrase string The reason phrase to use with the provided status code; if none is provided, implementations MAY use the defaults as suggested in the HTTP specification.
Результат self

withoutHeader() публичный Метод

Header resolution MUST be done without case-sensitivity. This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the named header.
public withoutHeader ( string $name ) : self
$name string Case-insensitive header field name to remove.
Результат self

Описание свойств

$data публичное свойство

public mixed $data
Результат mixed

$response защищенное свойство

protected ResponseInterface,Psr\Http\Message $response
Результат Psr\Http\Message\ResponseInterface