You are here

Home » API reference » Zircon Profile 8.0 » ServerRequestInterface.php

interface ServerRequestInterface in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 vendor/psr/http-message/src/ServerRequestInterface.php \Psr\Http\Message\ServerRequestInterface

Representation of an incoming, server-side HTTP request.

Per the HTTP specification, this interface includes properties for each of the following:

  • Protocol version
  • HTTP method
  • URI
  • Headers
  • Message body

Additionally, it encapsulates all data as it has arrived to the application from the CGI and/or PHP environment, including:

  • The values represented in $_SERVER.
  • Any cookies provided (generally via $_COOKIE)
  • Query string arguments (generally via $_GET, or as parsed via parse_str())
  • Upload files, if any (as represented by $_FILES)
  • Deserialized body parameters (generally from $_POST)

$_SERVER values MUST be treated as immutable, as they represent application state at the time of request; as such, no methods are provided to allow modification of those values. The other values provide such methods, as they can be restored from $_SERVER or the request body, and may need treatment during the application (e.g., body parameters may be deserialized based on content type).

Additionally, this interface recognizes the utility of introspecting a request to derive and match additional parameters (e.g., via URI path matching, decrypting cookie values, deserializing non-form-encoded body content, matching authorization headers to users, etc). These parameters are stored in an "attributes" property.

Requests are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.

Hierarchy

Expanded class hierarchy of ServerRequestInterface

All classes that implement ServerRequestInterface

9 files declare their use of ServerRequestInterface
ControllerResolver.php in core/lib/Drupal/Core/Controller/ControllerResolver.php
Contains \Drupal\Core\Controller\ControllerResolver.
ControllerResolverTest.php in core/tests/Drupal/Tests/Core/Controller/ControllerResolverTest.php
Contains \Drupal\Tests\Core\Controller\ControllerResolverTest.
HttpFoundationFactory.php in vendor/symfony/psr-http-message-bridge/Factory/HttpFoundationFactory.php
HttpFoundationFactoryInterface.php in vendor/symfony/psr-http-message-bridge/HttpFoundationFactoryInterface.php
HttpMessageFactoryInterface.php in vendor/symfony/psr-http-message-bridge/HttpMessageFactoryInterface.php

... See full list

File

vendor/psr/http-message/src/ServerRequestInterface.php, line 43

Namespace

Psr\Http\Message
View source 
interface ServerRequestInterface extends RequestInterface {

  /**
   * Retrieve server parameters.
   *
   * Retrieves data related to the incoming request environment,
   * typically derived from PHP's $_SERVER superglobal. The data IS NOT
   * REQUIRED to originate from $_SERVER.
   *
   * @return array
   */
  public function getServerParams();

  /**
   * Retrieve cookies.
   *
   * Retrieves cookies sent by the client to the server.
   *
   * The data MUST be compatible with the structure of the $_COOKIE
   * superglobal.
   *
   * @return array
   */
  public function getCookieParams();

  /**
   * Return an instance with the specified cookies.
   *
   * The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST
   * be compatible with the structure of $_COOKIE. Typically, this data will
   * be injected at instantiation.
   *
   * This method MUST NOT update the related Cookie header of the request
   * instance, nor related values in the server params.
   *
   * 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
   * updated cookie values.
   *
   * @param array $cookies Array of key/value pairs representing cookies.
   * @return self
   */
  public function withCookieParams(array $cookies);

  /**
   * Retrieve query string arguments.
   *
   * Retrieves the deserialized query string arguments, if any.
   *
   * Note: the query params might not be in sync with the URI or server
   * params. If you need to ensure you are only getting the original
   * values, you may need to parse the query string from `getUri()->getQuery()`
   * or from the `QUERY_STRING` server param.
   *
   * @return array
   */
  public function getQueryParams();

  /**
   * Return an instance with the specified query string arguments.
   *
   * These values SHOULD remain immutable over the course of the incoming
   * request. They MAY be injected during instantiation, such as from PHP's
   * $_GET superglobal, or MAY be derived from some other value such as the
   * URI. In cases where the arguments are parsed from the URI, the data
   * MUST be compatible with what PHP's parse_str() would return for
   * purposes of how duplicate query parameters are handled, and how nested
   * sets are handled.
   *
   * Setting query string arguments MUST NOT change the URI stored by the
   * request, nor the values in the server params.
   *
   * 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
   * updated query string arguments.
   *
   * @param array $query Array of query string arguments, typically from
   *     $_GET.
   * @return self
   */
  public function withQueryParams(array $query);

  /**
   * Retrieve normalized file upload data.
   *
   * This method returns upload metadata in a normalized tree, with each leaf
   * an instance of Psr\Http\Message\UploadedFileInterface.
   *
   * These values MAY be prepared from $_FILES or the message body during
   * instantiation, or MAY be injected via withUploadedFiles().
   *
   * @return array An array tree of UploadedFileInterface instances; an empty
   *     array MUST be returned if no data is present.
   */
  public function getUploadedFiles();

  /**
   * Create a new instance with the specified uploaded files.
   *
   * 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
   * updated body parameters.
   *
   * @param array An array tree of UploadedFileInterface instances.
   * @return self
   * @throws \InvalidArgumentException if an invalid structure is provided.
   */
  public function withUploadedFiles(array $uploadedFiles);

  /**
   * Retrieve any parameters provided in the request body.
   *
   * If the request Content-Type is either application/x-www-form-urlencoded
   * or multipart/form-data, and the request method is POST, this method MUST
   * return the contents of $_POST.
   *
   * Otherwise, this method may return any results of deserializing
   * the request body content; as parsing returns structured content, the
   * potential types MUST be arrays or objects only. A null value indicates
   * the absence of body content.
   *
   * @return null|array|object The deserialized body parameters, if any.
   *     These will typically be an array or object.
   */
  public function getParsedBody();

  /**
   * Return an instance with the specified body parameters.
   *
   * These MAY be injected during instantiation.
   *
   * If the request Content-Type is either application/x-www-form-urlencoded
   * or multipart/form-data, and the request method is POST, use this method
   * ONLY to inject the contents of $_POST.
   *
   * The data IS NOT REQUIRED to come from $_POST, but MUST be the results of
   * deserializing the request body content. Deserialization/parsing returns
   * structured data, and, as such, this method ONLY accepts arrays or objects,
   * or a null value if nothing was available to parse.
   *
   * As an example, if content negotiation determines that the request data
   * is a JSON payload, this method could be used to create a request
   * instance with the deserialized parameters.
   *
   * 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
   * updated body parameters.
   *
   * @param null|array|object $data The deserialized body data. This will
   *     typically be in an array or object.
   * @return self
   * @throws \InvalidArgumentException if an unsupported argument type is
   *     provided.
   */
  public function withParsedBody($data);

  /**
   * Retrieve attributes derived from the request.
   *
   * 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.
   *
   * @return array Attributes derived from the request.
   */
  public function getAttributes();

  /**
   * Retrieve a single derived request attribute.
   *
   * Retrieves a single derived request attribute as described in
   * getAttributes(). If the attribute has not been previously set, returns
   * the default value as provided.
   *
   * This method obviates the need for a hasAttribute() method, as it allows
   * specifying a default value to return if the attribute is not found.
   *
   * @see getAttributes()
   * @param string $name The attribute name.
   * @param mixed $default Default value to return if the attribute does not exist.
   * @return mixed
   */
  public function getAttribute($name, $default = null);

  /**
   * Return an instance with the specified derived request attribute.
   *
   * This method allows setting a single derived request attribute as
   * described in getAttributes().
   *
   * 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
   * updated attribute.
   *
   * @see getAttributes()
   * @param string $name The attribute name.
   * @param mixed $value The value of the attribute.
   * @return self
   */
  public function withAttribute($name, $value);

  /**
   * Return an instance that removes the specified derived request attribute.
   *
   * This method allows removing a single derived request attribute as
   * described in getAttributes().
   *
   * 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 attribute.
   *
   * @see getAttributes()
   * @param string $name The attribute name.
   * @return self
   */
  public function withoutAttribute($name);

}

Members

Namesort descending Modifiers Type Description Overrides
MessageInterface::getBody public function Gets the body of the message. 1
MessageInterface::getHeader public function Retrieves a message header value by the given case-insensitive name. 1
MessageInterface::getHeaderLine public function Retrieves a comma-separated string of the values for a single header. 1
MessageInterface::getHeaders public function Retrieves all message header values. 1
MessageInterface::getProtocolVersion public function Retrieves the HTTP protocol version as a string. 1
MessageInterface::hasHeader public function Checks if a header exists by the given case-insensitive name. 1
MessageInterface::withAddedHeader public function Return an instance with the specified header appended with the given value. 1
MessageInterface::withBody public function Return an instance with the specified message body. 1
MessageInterface::withHeader public function Return an instance with the provided value replacing the specified header. 2
MessageInterface::withoutHeader public function Return an instance without the specified header. 1
MessageInterface::withProtocolVersion public function Return an instance with the specified HTTP protocol version. 1
RequestInterface::getMethod public function Retrieves the HTTP method of the request. 3
RequestInterface::getRequestTarget public function Retrieves the message's request target. 2
RequestInterface::getUri public function Retrieves the URI instance. 2
RequestInterface::withMethod public function Return an instance with the provided HTTP method. 3
RequestInterface::withRequestTarget public function Return an instance with the specific request-target. 2
RequestInterface::withUri public function Returns an instance with the provided URI. 2
ServerRequestInterface::getAttribute public function Retrieve a single derived request attribute. 2
ServerRequestInterface::getAttributes public function Retrieve attributes derived from the request. 2
ServerRequestInterface::getCookieParams public function Retrieve cookies. 2
ServerRequestInterface::getParsedBody public function Retrieve any parameters provided in the request body. 2
ServerRequestInterface::getQueryParams public function Retrieve query string arguments. 2
ServerRequestInterface::getServerParams public function Retrieve server parameters. 2
ServerRequestInterface::getUploadedFiles public function Retrieve normalized file upload data. 2
ServerRequestInterface::withAttribute public function Return an instance with the specified derived request attribute. 2
ServerRequestInterface::withCookieParams public function Return an instance with the specified cookies. 2
ServerRequestInterface::withoutAttribute public function Return an instance that removes the specified derived request attribute. 2
ServerRequestInterface::withParsedBody public function Return an instance with the specified body parameters. 2
ServerRequestInterface::withQueryParams public function Return an instance with the specified query string arguments. 2
ServerRequestInterface::withUploadedFiles public function Create a new instance with the specified uploaded files. 2