Abstract message (base class for Request and Response) More...

Inheritance diagram for Slim\Http\Message:

Collaboration diagram for Slim\Http\Message:

Public Member Functions
	__set ($name, $value)
	Disable magic setter to ensure immutability. More...

	getProtocolVersion ()
	Retrieves the HTTP protocol version as a string. More...

	withProtocolVersion ($version)
	Return an instance with the specified HTTP protocol version. More...

	getHeaders ()
	Retrieves all message header values. More...

	hasHeader ($name)
	Checks if a header exists by the given case-insensitive name. More...

	getHeader ($name)
	Retrieves a message header value by the given case-insensitive name. More...

	getHeaderLine ($name)
	Retrieves a comma-separated string of the values for a single header. More...

	withHeader ($name, $value)
	Return an instance with the provided value replacing the specified header. More...

	withAddedHeader ($name, $value)
	Return an instance with the specified header appended with the given value. More...

	withoutHeader ($name)
	Return an instance without the specified header. More...

	getBody ()
	Gets the body of the message. More...

	withBody (StreamInterface $body)
	Return an instance with the specified message body. More...

Protected Attributes
	$protocolVersion = '1.1'

	$headers

	$body

Static Protected Attributes
static	$validProtocolVersions

Detailed Description

Abstract message (base class for Request and Response)

This class represents a general HTTP message. It provides common properties and methods for the HTTP request and response, as defined in the PSR-7 MessageInterface.

Slim Slim

Definition at line 25 of file Message.php.

Member Function Documentation

◆ __set()

Slim\Http\Message::__set	(	$name,
		$value
	)

Disable magic setter to ensure immutability.

Definition at line 64 of file Message.php.

     {
         // Do nothing
     }

◆ getBody()

Slim\Http\Message::getBody ( )

Gets the body of the message.

Returns: StreamInterface Returns the body as a stream.

Implements Psr\Http\Message\MessageInterface.

Definition at line 279 of file Message.php.

References Slim\Http\Message\$body.

Referenced by Slim\Http\Response\__toString(), Slim\Http\Request\getMethod(), Slim\Http\Request\getParsedBody(), and Slim\Http\Response\write().

     {
         return $this->body;
     }

Here is the caller graph for this function:

◆ getHeader()

Slim\Http\Message::getHeader ( $name )

Retrieves a message header value by the given case-insensitive name.

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.

Parameters

string $name Case-insensitive header field name.

Returns: 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.

Implements Psr\Http\Message\MessageInterface.

Definition at line 174 of file Message.php.

References $name.

Referenced by Slim\Http\Request\getContentType().

     {
         return $this->headers->get($name, []);
     }

Here is the caller graph for this function:

◆ getHeaderLine()

Slim\Http\Message::getHeaderLine ( $name )

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.

If the header does not appear in the message, this method MUST return an empty string.

Parameters

string $name Case-insensitive header field name.

Returns: 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.

Implements Psr\Http\Message\MessageInterface.

Definition at line 198 of file Message.php.

References $name.

Referenced by Slim\Http\Response\__toString(), Slim\Http\Request\getMethod(), Slim\Http\Request\isXhr(), and Slim\Http\Request\withUri().

     {
         return implode(',', $this->headers->get($name, []));
     }

Here is the caller graph for this function:

◆ getHeaders()

Slim\Http\Message::getHeaders ( )

Retrieves all message header values.

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.

Returns: 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.

Implements Psr\Http\Message\MessageInterface.

Definition at line 142 of file Message.php.

Referenced by Slim\Http\Response\__toString().

     {
         return $this->headers->all();
     }

Here is the caller graph for this function:

◆ getProtocolVersion()

Slim\Http\Message::getProtocolVersion ( )

Retrieves the HTTP protocol version as a string.

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

Returns: string HTTP protocol version.

Implements Psr\Http\Message\MessageInterface.

Definition at line 80 of file Message.php.

References Slim\Http\Message\$protocolVersion.

Referenced by Slim\Http\Response\__toString().

     {
         return $this->protocolVersion;
     }

Here is the caller graph for this function:

◆ hasHeader()

Slim\Http\Message::hasHeader ( $name )

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

Parameters

string $name Case-insensitive header field name.

Returns: bool 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.

Implements Psr\Http\Message\MessageInterface.

Definition at line 155 of file Message.php.

References $name.

Referenced by Slim\Http\Request\withUri().

     {
         return $this->headers->has($name);
     }

Here is the caller graph for this function:

◆ withAddedHeader()

Slim\Http\Message::withAddedHeader	(	$name,
		$value
	)

Return an instance with the specified header appended with the given value.

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.

Parameters

string	$name	Case-insensitive header field name to add.
	string\|string[]	$value Header value(s).

Returns: static

Exceptions

Implements Psr\Http\Message\MessageInterface.

Definition at line 242 of file Message.php.

References $name.

     {
         $clone = clone $this;
         $clone->headers->add($name, $value);
 
         return $clone;
     }

◆ withBody()

Slim\Http\Message::withBody ( StreamInterface $body )

Return an instance with the specified message body.

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.

Parameters

StreamInterface $body Body.

Returns: static

Exceptions

Implements Psr\Http\Message\MessageInterface.

Definition at line 297 of file Message.php.

References Slim\Http\Message\$body.

Referenced by Slim\Http\Response\withJson().

     {
         // TODO: Test for invalid body?
         $clone = clone $this;
         $clone->body = $body;
 
         return $clone;
     }

Here is the caller graph for this function:

◆ withHeader()

Slim\Http\Message::withHeader	(	$name,
		$value
	)

Return an instance with the provided value replacing the specified header.

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.

Parameters

string	$name	Case-insensitive header field name.
	string\|string[]	$value Header value(s).

Returns: static

Exceptions

Implements Psr\Http\Message\MessageInterface.

Definition at line 218 of file Message.php.

References $name.

     {
         $clone = clone $this;
         $clone->headers->set($name, $value);
 
         return $clone;
     }

◆ withoutHeader()

Slim\Http\Message::withoutHeader ( $name )

Return an instance without the specified header.

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.

Parameters

string $name Case-insensitive header field name to remove.

Returns: static

Implements Psr\Http\Message\MessageInterface.

Definition at line 262 of file Message.php.

References $name.

     {
         $clone = clone $this;
         $clone->headers->remove($name);
 
         return $clone;
     }

◆ withProtocolVersion()

Slim\Http\Message::withProtocolVersion ( $version )

Return an instance with the specified HTTP protocol version.

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.

Parameters

string $version HTTP protocol version

Returns: static

Exceptions

InvalidArgumentException if the http version is an invalid number

Implements Psr\Http\Message\MessageInterface.

Definition at line 99 of file Message.php.

References $version.

     {
         if (!isset(self::$validProtocolVersions[$version])) {
             throw new InvalidArgumentException(
                 'Invalid HTTP version. Must be one of: '
                 . implode(', ', array_keys(self::$validProtocolVersions))
             );
         }
         $clone = clone $this;
         $clone->protocolVersion = $version;
 
         return $clone;
     }

Field Documentation

◆ $body

Slim\Http\Message::$body

protected

Definition at line 58 of file Message.php.

Referenced by Slim\Http\Request\__clone(), Slim\Http\Response\__construct(), Slim\Http\Request\__construct(), Slim\Http\Request\createFromEnvironment(), Slim\Http\Message\getBody(), Slim\Http\Request\getParsedBody(), and Slim\Http\Message\withBody().

◆ $headers

Slim\Http\Message::$headers

protected

Definition at line 51 of file Message.php.

Referenced by Slim\Http\Response\__clone(), Slim\Http\Request\__clone(), Slim\Http\Response\__construct(), Slim\Http\Request\__construct(), and Slim\Http\Request\createFromEnvironment().

◆ $protocolVersion

Slim\Http\Message::$protocolVersion = '1.1'

protected

Definition at line 32 of file Message.php.

Referenced by Slim\Http\Message\getProtocolVersion().

◆ $validProtocolVersions

Slim\Http\Message::$validProtocolVersions

staticprotected

Initial value:

= [

'1.0' => true

Definition at line 39 of file Message.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/slim/slim/Slim/Http/Message.php

Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ __set()

◆ getBody()

◆ getHeader()

◆ getHeaderLine()

◆ getHeaders()

◆ getProtocolVersion()

◆ hasHeader()

◆ withAddedHeader()

◆ withBody()

◆ withHeader()

◆ withoutHeader()

◆ withProtocolVersion()

Field Documentation

◆ $body

◆ $headers

◆ $protocolVersion

◆ $validProtocolVersions