PHP 트레잇 Phly\Http\MessageTrait

링크 보기: https://github.com/php-fig/http-message/tree/master/src/MessageInterface.php

보호된 프로퍼티들

프로퍼티	타입	설명
$headerNames	array	Map of normalized header name to original name used to register header.
$headers	array	List of all registered headers, as key => array of values.

공개 메소드들

메소드	설명
getBody ( ) : Psr\Http\Message\StreamInterface	Gets the body of the message.
getHeader ( $header ) : string[]	Retrieves a message header value by the given case-insensitive name.
getHeaderLine ( $header ) : string \| null	Retrieves the line for a single header, with the header values as a comma-separated string.
getHeaders ( ) : array	Retrieves all message headers.
getProtocolVersion ( ) : string	Retrieves the HTTP protocol version as a string.
hasHeader ( string $header ) : boolean	Checks if a header exists by the given case-insensitive name.
withAddedHeader ( $header, 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 ( $header, string \| string[] $value ) : self	Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.
withProtocolVersion ( string $version ) : self	Return an instance with the specified HTTP protocol version.
withoutHeader ( $header ) : self	Return an instance without the specified header.

비공개 메소드들

메소드	설명
arrayContainsOnlyStrings ( array $array ) : boolean	Test that an array contains only strings
assertValidHeaderValue ( array $values )	Assert that the provided header values are valid.
filterHeaders ( array $originalHeaders ) : array	Filter a set of headers to ensure they are in the correct internal format.
filterStringValue ( boolean $carry, mixed $item ) : boolean	Test if a value is a string

메소드 상세

getBody() 공개 메소드

Gets the body of the message.

public getBody ( ) : Psr\Http\Message\StreamInterface
리턴	Psr\Http\Message\StreamInterface	Returns the body as a stream.

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 ( $header ) : string[]
리턴	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 a null value.

public getHeaderLine ( $header ) : string \| null
리턴	string \| null	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 a null value.

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); } }

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.

getProtocolVersion() 공개 메소드

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

public getProtocolVersion ( ) : string
리턴	string	HTTP protocol version.

hasHeader() 공개 메소드

Checks if a header exists by the given case-insensitive name.

public hasHeader ( string $header ) : boolean
$header	string	Case-insensitive header 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.

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 ( $header, string \| string[] $value ) : self
$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 ( $header, string \| string[] $value ) : self
$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

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 ( $header ) : self
리턴	self

프로퍼티 상세

$headerNames 보호되어 있는 프로퍼티

Map of normalized header name to original name used to register header.

protected array $headerNames
리턴	array

$headers 보호되어 있는 프로퍼티

List of all registered headers, as key => array of values.

protected array $headers
리턴	array