summaryrefslogtreecommitdiff
path: root/src/Http
diff options
context:
space:
mode:
authorIgor Scheller <igor.scheller@igorshp.de>2018-08-20 17:35:07 +0200
committerIgor Scheller <igor.scheller@igorshp.de>2018-08-20 17:43:15 +0200
commitb0e7bc0df2eb4975223582089c7a928903e8cd14 (patch)
treecb822bbf31a0339f08df6131ce5fcdd87fa398db /src/Http
parent5427ee385dc2ff117a1130eb606f78e708949c8f (diff)
Made Engelsystem\Http\Request PSR-7 ServerRequestInterface compatible
Diffstat (limited to 'src/Http')
-rw-r--r--src/Http/Psr7ServiceProvider.php3
-rw-r--r--src/Http/Request.php320
2 files changed, 319 insertions, 4 deletions
diff --git a/src/Http/Psr7ServiceProvider.php b/src/Http/Psr7ServiceProvider.php
index 4a3c6583..72fdef8e 100644
--- a/src/Http/Psr7ServiceProvider.php
+++ b/src/Http/Psr7ServiceProvider.php
@@ -18,8 +18,7 @@ class Psr7ServiceProvider extends ServiceProvider
/** @var Request $request */
$request = $this->app->get('request');
- $psr7request = $psr7Factory->createRequest($request);
- $this->app->instance('psr7.request', $psr7request);
+ $this->app->instance('psr7.request', $request);
$this->app->bind(ServerRequestInterface::class, 'psr7.request');
/** @var Response $response */
diff --git a/src/Http/Request.php b/src/Http/Request.php
index fd3bff42..4729606f 100644
--- a/src/Http/Request.php
+++ b/src/Http/Request.php
@@ -2,12 +2,15 @@
namespace Engelsystem\Http;
-use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\UploadedFileInterface;
use Psr\Http\Message\UriInterface;
+use Symfony\Component\HttpFoundation\File\UploadedFile as SymfonyFile;
use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
+use Zend\Diactoros\UploadedFile;
use Zend\Diactoros\Uri;
-class Request extends SymfonyRequest implements RequestInterface
+class Request extends SymfonyRequest implements ServerRequestInterface
{
use MessageTrait;
@@ -193,4 +196,317 @@ class Request extends SymfonyRequest implements RequestInterface
return new Uri($uri);
}
+
+ /**
+ * 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()
+ {
+ return $this->server->all();
+ }
+
+ /**
+ * 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 $this->cookies->all();
+ }
+
+ /**
+ * 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 static
+ */
+ public function withCookieParams(array $cookies)
+ {
+ $new = clone $this;
+ $new->cookies = clone $this->cookies;
+ $new->cookies->replace($cookies);
+
+ return $new;
+ }
+
+ /**
+ * 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 $this->query->all();
+ }
+
+ /**
+ * 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 static
+ */
+ public function withQueryParams(array $query)
+ {
+ $new = clone $this;
+ $new->query = clone $this->query;
+ $new->query->replace($query);
+
+ return $new;
+ }
+
+ /**
+ * 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()
+ {
+ $files = [];
+ foreach ($this->files as $file) {
+ /** @var SymfonyFile $file */
+
+ $files[] = new UploadedFile(
+ $file->getPath(),
+ $file->getSize(),
+ $file->getError(),
+ $file->getClientOriginalName(),
+ $file->getClientMimeType()
+ );
+ }
+
+ return $files;
+ }
+
+ /**
+ * 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 $uploadedFiles An array tree of UploadedFileInterface instances.
+ * @return static
+ * @throws \InvalidArgumentException if an invalid structure is provided.
+ */
+ public function withUploadedFiles(array $uploadedFiles)
+ {
+ $new = clone $this;
+ $new->files = clone $this->files;
+
+ $files = [];
+ foreach ($uploadedFiles as $file) {
+ /** @var UploadedFileInterface $file */
+ $filename = tempnam(sys_get_temp_dir(), 'upload');
+ $handle = fopen($filename, "w");
+ fwrite($handle, $file->getStream()->getContents());
+ fclose($handle);
+
+ $files[] = new SymfonyFile(
+ $filename,
+ $file->getClientFilename(),
+ $file->getClientMediaType(),
+ $file->getSize(),
+ $file->getError()
+ );
+ }
+ $new->files->add($files);
+
+ return $new;
+ }
+
+ /**
+ * 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 $this->request->all();
+ }
+
+ /**
+ * 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 static
+ * @throws \InvalidArgumentException if an unsupported argument type is
+ * provided.
+ */
+ public function withParsedBody($data)
+ {
+ $new = clone $this;
+ $new->request = clone $this->request;
+
+ $new->request->replace($data);
+
+ return $new;
+ }
+
+ /**
+ * 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()
+ {
+ return $this->attributes->all();
+ }
+
+ /**
+ * 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 $this->attributes->get($name, $default);
+ }
+
+ /**
+ * 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 static
+ */
+ public function withAttribute($name, $value)
+ {
+ $new = clone $this;
+ $new->attributes = clone $this->attributes;
+
+ $new->attributes->set($name, $value);
+
+ return $new;
+ }
+
+ /**
+ * 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 static
+ */
+ public function withoutAttribute($name)
+ {
+ $new = clone $this;
+ $new->attributes = clone $this->attributes;
+
+ $new->attributes->remove($name);
+
+ return $new;
+ }
}