Interface CodeIgniter\HTTP\MessageInterface

Expected behavior of an HTTP message

CodeIgniter\HTTP\MessageInterface
- CodeIgniter\HTTP\Message implements MessageInterface uses MessageTrait
  - CodeIgniter\HTTP\Response implements ResponseInterface uses ResponseTrait
    - CodeIgniter\HTTP\DownloadResponse
  - CodeIgniter\HTTP\OutgoingRequest implements OutgoingRequestInterface
    - CodeIgniter\HTTP\Request implements RequestInterface uses RequestTrait
      - CodeIgniter\HTTP\IncomingRequest
- CodeIgniter\HTTP\OutgoingRequestInterface extends MessageInterface
  - CodeIgniter\HTTP\OutgoingRequest implements OutgoingRequestInterface
    - CodeIgniter\HTTP\Request implements RequestInterface uses RequestTrait
      - CodeIgniter\HTTP\IncomingRequest
  - CodeIgniter\HTTP\RequestInterface extends OutgoingRequestInterface
    - CodeIgniter\HTTP\Request implements RequestInterface uses RequestTrait
      - CodeIgniter\HTTP\IncomingRequest
- CodeIgniter\HTTP\ResponseInterface extends MessageInterface
  - CodeIgniter\HTTP\Response implements ResponseInterface uses ResponseTrait
    - CodeIgniter\HTTP\DownloadResponse

Methods


					
	public

getProtocolVersion(): string

Retrieves the HTTP protocol version as a string.

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

Returns

HTTP protocol version.

Implemented by

CodeIgniter\HTTP\Message::getProtocolVersion()


					
	public

setBody(mixed $data): $this

Sets the body of the current message.


					
	public

getBody(): string|null

Gets the body of the message.

Implemented by

CodeIgniter\HTTP\Message::getBody()


					
	public

appendBody(mixed $data): $this

Appends data to the body of the current message.


					
	public

populateHeaders(): void

Populates the $headers array with any headers the server knows about.


					
	public

headers(): array<string, Header>

Returns an array containing all Headers.

Returns

An array of the Header objects


					
	public

hasHeader(string $name): bool

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

Parameters

$name

Case-insensitive header field name.

Returns

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.

Implemented by

CodeIgniter\HTTP\Message::hasHeader()


					
	public

header(string $name): array|Header|null

Returns a single Header object. If multiple headers with the same name exist, then will return an array of header…

Returns a single Header object. If multiple headers with the same name exist, then will return an array of header objects.


					
	public

getHeaderLine(string $name): string

Retrieves a comma-separated string of the values for a single header.

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.

Implemented by

CodeIgniter\HTTP\Message::getHeaderLine()


					
	public

setHeader(string $name, array|string|null $value): $this

Sets a header and it's value.


					
	public

removeHeader(string $name): $this

Removes a header from the list of headers we track.


					
	public

appendHeader(string $name, ?string $value): $this

Adds an additional header value to any headers that accept multiple values (i.e. are an array or implement ArrayAccess)


					
	public

prependHeader(string $name, string $value): $this

Adds an additional header value to any headers that accept multiple values (i.e. are an array or implement ArrayAccess)


					
	public

setProtocolVersion(string $version): $this

Sets the HTTP protocol version.

Throws

CodeIgniter\HTTP\Exceptions\HTTPException

For invalid protocols

Namespaces

Classes

Interfaces

Traits

Interface CodeIgniter\HTTP\MessageInterface

Returns

Implemented by

Implemented by

Returns

Parameters

Returns

Implemented by

Implemented by

Throws