| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | https://github.com/laminas/laminas-diactoros/blob/master/COPYRIGHT.md |
| License: | https://github.com/laminas/laminas-diactoros/blob/master/LICENSE.md New BSD License |
| File Size: | 320 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| initialize($uri = null,string $method = null,$body = 'php:array $headers = []) X-Ref |
| Initialize request state. Used by constructors. param: null|string|UriInterface $uri URI for the request, if any. param: null|string $method HTTP method for the request, if any. param: string|resource|StreamInterface $body Message body, if any. param: array $headers Headers for the message, if any. |
| createUri($uri) X-Ref |
| Create and return a URI instance. If `$uri` is a already a `UriInterface` instance, returns it. If `$uri` is a string, passes it to the `Uri` constructor to return an instance. If `$uri is null, creates and returns an empty `Uri` instance. Otherwise, it raises an exception. param: null|string|UriInterface $uri |
| getRequestTarget() X-Ref |
| Retrieves the message's request target. 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 MUST return the string "/". |
| withRequestTarget($requestTarget) X-Ref |
| Create a new instance with a specific request-target. 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 MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the changed request target. param: string $requestTarget |
| getMethod() X-Ref |
| Retrieves the HTTP method of the request. return: string Returns the request method. |
| withMethod($method) X-Ref |
| Return an instance with the provided HTTP method. While HTTP method names are typically all uppercase characters, HTTP method names are case-sensitive and thus implementations SHOULD NOT modify the given string. 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 changed request method. param: string $method Case-insensitive method. |
| getUri() X-Ref |
| Retrieves the URI instance. This method MUST return a UriInterface instance. return: UriInterface Returns a UriInterface instance |
| withUri(UriInterface $uri, $preserveHost = false) X-Ref |
| Returns an instance with the provided URI. 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 will 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`, the returned request will not update the Host header of the returned message -- even if the message contains no Host header. This means that a call to `getHeader('Host')` on the original request MUST equal the return value of a call to `getHeader('Host')` on the returned request. 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 UriInterface instance. param: UriInterface $uri New request URI to use. param: bool $preserveHost Preserve the original state of the Host header. |
| setMethod($method) X-Ref |
| Set and validate the HTTP method param: string $method |
| getHostFromUri() X-Ref |
| Retrieve the host from the URI instance |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |