Add Context::filter() method

Author: tobyzerner

docs/requests.md

@@ -60,5 +60,8 @@ This object contains a number of useful methods:
 * `fieldRequested(string $type, string $field, bool $default = true): bool`  
   Determine whether a field has been requested in a [sparse fieldset](https://jsonapi.org/format/1.1/#fetching-sparse-fieldsets).
 
+* `filter(string $name): ?string`  
+  Get the value of a filter.
+
 * `meta(string $name, $value): Tobyz\JsonApi\Schema\Meta`  
   Add a meta attribute to the response document.

src/Context.php

@@ -29,11 +29,17 @@ public function __construct(JsonApi $api, ServerRequestInterface $request)
         $this->request = $request;
     }
 
+    /**
+     * Get the JsonApi instance.
+     */
     public function getApi(): JsonApi
     {
         return $this->api;
     }
 
+    /**
+     * Get the PSR-7 request instance.
+     */
     public function getRequest(): ServerRequestInterface
     {
         return $this->request;
@@ -44,6 +50,9 @@ public function withRequest(ServerRequestInterface $request): Context
         return new static($this->api, $request);
     }
 
+    /**
+     * Get the request path relative to the API's base path.
+     */
     public function getPath(): string
     {
         return $this->api->stripBasePath(
@@ -56,6 +65,9 @@ public function response(callable $callback): void
         $this->listeners['response'][] = $callback;
     }
 
+    /**
+     * Determine whether a field has been requested in a sparse fieldset.
+     */
     public function fieldRequested(string $type, string $field, bool $default = true): bool
     {
         $queryParams = $this->request->getQueryParams();
@@ -66,4 +78,12 @@ public function fieldRequested(string $type, string $field, bool $default = true
 
         return in_array($field, explode(',', $queryParams['fields'][$type]));
     }
+
+    /**
+     * Get the value of a filter.
+     */
+    public function filter(string $name): ?string
+    {
+        return $this->request->getQueryParams()['filter'][$name] ?? null;
+    }
 }