HttpMessage

This method returns an array of all the header values of the given case-insensitive header name.

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 will return an empty string.

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.

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.

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

Retrieves the message's request-target either as it will appear (for clients), as it appeared at request (for servers), or as it was specified for the instance (see withRequestTarget()).

In most cases, this will be the origin-form of the composed URI, unless a value was provided to the concrete implementation (see withRequestTarget() below).

If no URI is available, and no request-target has been specifically provided, this method will return the string "/".

Standard methods include: HEAD: Asks for a response identical to that of a GET request, but without the response body. GET: Requests a representation of the specified resource Requests using GET should only retrieve data. POST: Submit an entity to the specified resource, Often causing a change in state or side effects on the server. PUT: Replaces all current representations of the target resource with the request payload. DELETE: Deletes the specified resource. PATCH: Used to apply partial modifications to a resource. CONNECT: Establishes a tunnel to the server identified by the target resource. OPTIONS: Used to describe the communication options for the target resource. TRACE: Performs a message loop-back test along the path to the target resource.

If the request needs a non-origin-form request-target — e.g., for specifying an absolute-form, authority-form, or asterisk-form — this method may be used to create an instance with the specified request-target, verbatim.

This method will update the Host header of the returned request by default if the URI contains a host component. If the URI does not contain a host component, any pre-existing Host header MUST be carried over to the returned request.

You can opt-in to preserving the original state of the Host header by setting $preserveHost to true. When $preserveHost is set to true, this method interacts with the Host header in the following ways:

• If the Host header is missing or empty, and the new URI contains a host component, this method will update the Host header in the returned request.
• If the Host header is missing or empty, and the new URI does not contain a host component, this method will NOT update the Host header in the returned request.
• If a Host header is present and non-empty, this method will NOT update the Host header in the returned request.

This method returns an array of all the header values of the given case-insensitive header name.

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 will return an empty string.

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.

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.

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

The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.

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 returns an array of all the header values of the given case-insensitive header name.

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 will return an empty string.

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.

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.

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

The request "attributes" may be used to allow injection of any parameters derived from the request: e.g., the results of path match operations; the results of decrypting cookies; the results of deserializing non-form-encoded message bodies; etc. Attributes will be application and request specific, and CAN be mutable.

This method returns upload metadata in a normalized tree, with each leaf an instance of Psr\Http\Message\UploadedFileInterface.

Define a custom body parser for a specific media type.

Retrieves the message's request-target either as it will appear (for clients), as it appeared at request (for servers), or as it was specified for the instance (see withRequestTarget()).

In most cases, this will be the origin-form of the composed URI, unless a value was provided to the concrete implementation (see withRequestTarget() below).

If no URI is available, and no request-target has been specifically provided, this method will return the string "/".

Standard methods include: HEAD: Asks for a response identical to that of a GET request, but without the response body. GET: Requests a representation of the specified resource Requests using GET should only retrieve data. POST: Submit an entity to the specified resource, Often causing a change in state or side effects on the server. PUT: Replaces all current representations of the target resource with the request payload. DELETE: Deletes the specified resource. PATCH: Used to apply partial modifications to a resource. CONNECT: Establishes a tunnel to the server identified by the target resource. OPTIONS: Used to describe the communication options for the target resource. TRACE: Performs a message loop-back test along the path to the target resource.

If the request needs a non-origin-form request-target — e.g., for specifying an absolute-form, authority-form, or asterisk-form — this method may be used to create an instance with the specified request-target, verbatim.

This method will update the Host header of the returned request by default if the URI contains a host component. If the URI does not contain a host component, any pre-existing Host header MUST be carried over to the returned request.

You can opt-in to preserving the original state of the Host header by setting $preserveHost to true. When $preserveHost is set to true, this method interacts with the Host header in the following ways:

• If the Host header is missing or empty, and the new URI contains a host component, this method will update the Host header in the returned request.
• If the Host header is missing or empty, and the new URI does not contain a host component, this method will NOT update the Host header in the returned request.
• If a Host header is present and non-empty, this method will NOT update the Host header in the returned request.

This method returns an array of all the header values of the given case-insensitive header name.

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 will return an empty string.

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.

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.

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

Parses the Content-Type header and returns the "media type"

example: Content-Type: multipart/form-data; Charset=UTF-8; boundary=ExampleBoundaryString

getMediaType() will return "multipart/form-data"

Parses and returns the parameters found after the "media type" in the Content-Type header.

example: Content-Type: multipart/form-data; Charset=UTF-8; boundary=ExampleBoundaryString

getMediaTypeParams() will return

[
  'charset' => 'utf-8',
  'boundary' => 'ExampleBoundaryString'
]

This method allows setting multiple derived request attributes as described in getAttributes().

This method is implemented in such a way as to retain the immutability of the message, and returns an instance that has the upserted attributes.

The request "attributes" may be used to allow injection of any parameters derived from the request: e.g., the results of path match operations; the results of decrypting cookies; the results of deserializing non-form-encoded message bodies; etc. Attributes will be application and request specific, and CAN be mutable.

This method returns upload metadata in a normalized tree, with each leaf an instance of Psr\Http\Message\UploadedFileInterface.

Define a custom body parser for a specific media type.

Retrieves the message's request-target either as it will appear (for clients), as it appeared at request (for servers), or as it was specified for the instance (see withRequestTarget()).

In most cases, this will be the origin-form of the composed URI, unless a value was provided to the concrete implementation (see withRequestTarget() below).

If no URI is available, and no request-target has been specifically provided, this method will return the string "/".

Standard methods include: HEAD: Asks for a response identical to that of a GET request, but without the response body. GET: Requests a representation of the specified resource Requests using GET should only retrieve data. POST: Submit an entity to the specified resource, Often causing a change in state or side effects on the server. PUT: Replaces all current representations of the target resource with the request payload. DELETE: Deletes the specified resource. PATCH: Used to apply partial modifications to a resource. CONNECT: Establishes a tunnel to the server identified by the target resource. OPTIONS: Used to describe the communication options for the target resource. TRACE: Performs a message loop-back test along the path to the target resource.

If the request needs a non-origin-form request-target — e.g., for specifying an absolute-form, authority-form, or asterisk-form — this method may be used to create an instance with the specified request-target, verbatim.

This method will update the Host header of the returned request by default if the URI contains a host component. If the URI does not contain a host component, any pre-existing Host header MUST be carried over to the returned request.

You can opt-in to preserving the original state of the Host header by setting $preserveHost to true. When $preserveHost is set to true, this method interacts with the Host header in the following ways:

• If the Host header is missing or empty, and the new URI contains a host component, this method will update the Host header in the returned request.
• If the Host header is missing or empty, and the new URI does not contain a host component, this method will NOT update the Host header in the returned request.
• If a Host header is present and non-empty, this method will NOT update the Host header in the returned request.

This method returns an array of all the header values of the given case-insensitive header name.

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 will return an empty string.

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.

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.

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

• metadata: (array) Any additional metadata to return when the metadata of the stream is accessed.
• size: (int) If a read stream would otherwise have an indeterminate size, but the size is known due to foreknowledge, then you can provide that size, in bytes.

Warning: This could attempt to load a large amount of data into memory.

After the stream has been detached, the stream is in an unusable state.

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

construct(array $fileInfo) construct($streamOrFile, $size = null, $error = UPLOAD_ERR_OK, $clientFilename = null, $clientMediaType = null, $clientFullPath = null)

Do not trust the value returned by this method. A client could send a malicious filename with the intention to corrupt or hack your application.

full_path value is new as of PHP 8.1 and passed by client when uploading a directory

Do not trust the value returned by this method. A client could send a malicious filename with the intention to corrupt or hack your application.

Do not trust the value returned by this method. A client could send a malicious media type with the intention to corrupt or hack your application.

Returns one of PHP's UPLOAD_ERR_XXX constants.

If the file was uploaded successfully, will return UPLOAD_ERR_OK.

If the file was uploaded successfully, will return ''

Implementations SHOULD return the value stored in the "size" key of the file in the $_FILES array if available, as PHP calculates this based on the actual size transmitted.

If the moveTo() method has been called previously, this method will raise an exception.

Use this method as an alternative to move_uploaded_file(). This method is guaranteed to work in both SAPI and non-SAPI environments.

$targetPath may be an absolute path, or a relative path. If it is a relative path, resolution will be the same as used by PHP's rename() function.

The original file or stream will be removed on completion.

If this method is called more than once, any subsequent calls will raise an exception.

When used in an SAPI environment where $_FILES is populated, when writing files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be used to ensure permissions and upload status are verified correctly.

If you wish to move to a stream, use getStream(), as SAPI operations cannot guarantee writing to stream destinations.

If the port component is not set or is the standard port for the current scheme, it will not be included

The leading "#" character is not part of the fragment and MUST NOT be added.

The value returned will be percent-encoded, but will not double-encode any characters. see RFC 3986, Sections 2 and 3.5.

The value returned will be normalized to lowercase, per RFC 3986 Section 3.2.2.

The path can either be empty or absolute (starting with a slash) rootless (not starting with a slash).

Normally, the empty path "" and absolute path "/" are considered equal as defined in RFC 7230 Section 2.7.3. But this method does automatically do this normalization because in contexts with a trimmed base path, e.g. the front controller, this difference becomes significant. It's the task of the user to handle both "" and "/".

The value returned will be percent-encoded, but will not double-encode any characters. see RFC 3986, Sections 2 and 3.3.

As an example, if the value should include a slash ("/") not intended as delimiter between path segments, that value will be passed in encoded form (e.g., "%2F") to the instance.

If the port is the standard port used with the current scheme, null will be returned.

If no port is present, and no scheme is present, null will be returned

If no port is present, but a scheme is present, null will be returned.

The leading "?" character is not part of the query and will not be included.

The value returned will be percent-encoded, but will not double-encode any characters. see RFC 3986, Sections 2 and 3.4.

As an example, if a value in a key/value pair of the query string should include an ampersand ("&") not intended as a delimiter between values, that value MUST be passed in encoded form (e.g., "%26") to the instance.

If a user is present in the URI, this will return that value; additionally, if the password is also present, it will be appended to the user value, with a colon (":") separating the values.

The trailing "@" character is not part of the user information and will not be included

Users can provide both encoded and decoded fragment characters.

An empty fragment value is equivalent to removing the fragment.

An empty host value is equivalent to removing the host.

The path can either be empty absolute (starting with a slash) rootless (not starting with a slash).

If an HTTP path is intended to be host-relative rather than path-relative then it must begin with a slash ("/"). HTTP paths not starting with a slash are assumed to be relative to some base path known to the application or consumer.

Users can provide both encoded and decoded path characters.

A null value provided for the port is equivalent to removing the port information.

Users can provide both encoded and decoded query characters.

An empty query string value is equivalent to removing the query string.

An empty scheme is equivalent to removing the scheme.

Password is optional, but the user information MUST include the user; an empty string for the user is equivalent to removing user information.