Merge branch '2.3'

Author: dunglas

admin/getting-started.md

@@ -83,6 +83,10 @@ const myApiDocumentationParser = entrypoint => parseHydraDocumentation(entrypoin
     const books = api.resources.find(({ name }) => 'books' === name);
     const description = books.fields.find(f => 'description' === f.name);
 
+    description.field = props => (
+      <RichTextField {...props} source="description" />
+    );
+
     description.input = props => (
       <RichTextInput {...props} source="description" />
     );

admin/handling-relations-to-collections.md

@@ -120,6 +120,50 @@ export default class extends Component {
 }
 ```
 
+
+## Customizing an Icon
+
+Now that our `authors` property is displaying the name instead of an 'id', let's change the icon shown in the list menu.
+
+Just add an import statement from `@material-ui` for adding the icon, in this case, a user icon:
+
+`import UserIcon from '@material-ui/icons/People';`
+
+and add it to the `authors.icon` property
+
+The code for just customizing the icon will be:
+
+```javascript
+import React, { Component } from 'react';
+import { AdminBuilder, hydraClient } from '@api-platform/admin';
+import parseHydraDocumentation from '@api-platform/api-doc-parser/lib/hydra/parseHydraDocumentation';
+import UserIcon from '@material-ui/icons/People';
+
+const entrypoint = 'https://demo.api-platform.com';
+
+export default class extends Component {
+  state = { api: null }
+
+  componentDidMount() {
+    parseHydraDocumentation(entrypoint).then(({api}) => {
+        const authors = books.fields.find(({ name }) => 'authors' === name)
+
+        // Set the icon
+        authors.icon = UserIcon
+       
+        this.setState({ api });
+      }
+    )
+  }
+
+  render() {
+    if (null === this.state.api) return <div>Loading...</div>;
+
+    return <AdminBuilder api={ this.state.api } dataProvider={ hydraClient(this.state.api) }/>
+  }
+}
+```
+
 ## Using an Autocomplete Input for Relations
 
 We'll make one last improvement to our admin: transforming the relation selector we just created to use autocompletion.

core/data-providers.md

@@ -101,10 +101,10 @@ final class BlogPostItemDataProvider implements ItemDataProviderInterface, Restr
         return BlogPost::class === $resourceClass;
     }
 
-    public function getItem(string $resourceClass, $identifiers, string $operationName = null, array $context = []): ?BlogPost
+    public function getItem(string $resourceClass, $id, string $operationName = null, array $context = []): ?BlogPost
     {
         // Retrieve the blog post item from somewhere then return it or null if not found
-        return new BlogPost($identifiers['id']);
+        return new BlogPost($id);
     }
 }
 ```

core/events.md

@@ -112,5 +112,5 @@ attribute of an operation](operations.md#recommended-method)):
 Attribute      | Type   | Default | Description                                                                          |
 ---------------|--------|---------|--------------------------------------------------------------------------------------|
 `_api_receive` | `bool` | `true`  | Enables or disables the `ReadListener`, `DeserializeListener` and `ValidateListener` |
-`_api_respond` | `bool` | `true`  | Enables or disables `SerializeListener`                                              |
-`_api_persist` | `bool` | `true`  | Enables or disables `WriteLister`                                                    |
+`_api_respond` | `bool` | `true`  | Enables or disables `SerializeListener`, `RespondListener`                           |
+`_api_persist` | `bool` | `true`  | Enables or disables `WriteListener`                                                    |

core/external-vocabularies.md

@@ -37,7 +37,7 @@ The generated JSON for products and the related context document will now use ex
 {
   "@context": "/contexts/Book",
   "@id": "/books/22",
-  "@type": "https://schema.org/Product",
+  "@type": "https://schema.org/Book",
   "name": "My awesome book"
 }
 ```

core/filters.md

@@ -154,7 +154,7 @@ use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
 
 /**
  * @ApiResource()
- * @ApiFilter(SearchFilter::class, properties={"id": "exact", "price": "exact", "name": "partial"})
+ * @ApiFilter(SearchFilter::class, properties={"id": "exact", "price": "exact", "description": "partial"})
  */
 class Offer
 {
@@ -163,10 +163,9 @@ class Offer
 ```
 
 `http://localhost:8000/api/offers?price=10` will return all offers with a price being exactly `10`.
-`http://localhost:8000/api/offers?name=shirt` will return all offers with a description containing the word "shirt".
-`http://localhost:8000/api/offers?name[]=shirt&name[]=sweat` will return all offers with a description containing the word "shirt" or containing the word "sweat".
+`http://localhost:8000/api/offers?description=shirt` will return all offers with a description containing the word "shirt".
 
-Filters can be combined together: `http://localhost:8000/api/offers?price=10&name=shirt`
+Filters can be combined together: `http://localhost:8000/api/offers?price=10&description=shirt`
 
 It is possible to filter on relations too, if `Offer` has a `Product` relation:
 
@@ -241,6 +240,7 @@ Use the default behavior of the DBMS | `null`
 Exclude items                        | `ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\DateFilter::EXCLUDE_NULL` (`exclude_null`)
 Consider items as oldest             | `ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\DateFilter::INCLUDE_NULL_BEFORE` (`include_null_before`)
 Consider items as youngest           | `ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\DateFilter::INCLUDE_NULL_AFTER` (`include_null_after`)
+Always include items                 | `ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\DateFilter::INCLUDE_NULL_BEFORE_AND_AFTER` (`include_null_before_and_after`)
 
 For instance, exclude entries with a property value of `null`, with the following service definition:
 
@@ -292,7 +292,7 @@ class Offer
 }
 ```
 
-Given that the collection endpoint is `/offers`, you can filter offers by boolean with the following query: `/offers?isAvailableGenericallyInMyCountry=true`.
+Given that the collection endpoint is `/offers`, you can filter offers with the following query: `/offers?isAvailableGenericallyInMyCountry=true`.
 
 It will return all offers where `isAvailableGenericallyInMyCountry` equals `true`.
 
@@ -324,7 +324,7 @@ class Offer
 }
 ```
 
-Given that the collection endpoint is `/offers`, you can filter offers by boolean with the following query: `/offers?sold=1`.
+Given that the collection endpoint is `/offers`, you can filter offers with the following query: `/offers?sold=1`.
 
 It will return all offers with `sold` equals `1`.
 
@@ -1006,42 +1006,6 @@ final class UserFilterConfigurator
 
 Done: Doctrine will automatically filter all "UserAware" entities!
 
-### Overriding Extraction of Properties from the Request
-
-You can change the way the filter parameters are extracted from the request. This can be done by overriding the `extractProperties(\Symfony\Component\HttpFoundation\Request $request)`
-method.
-
-In the following example, we will completely change the syntax of the order filter to be the following: `?filter[order][property]`
-
-```php
-<?php
-// api/src/Filter/CustomOrderFilter.php
-
-namespace App\Filter;
-
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter;
-use Symfony\Component\HttpFoundation\Request;
-
-final class CustomOrderFilter extends OrderFilter
-{
-    protected function extractProperties(Request $request): array
-    {
-        return $request->query->get('filter[order]', []);
-    }
-}
-```
-
-Finally, register the custom filter:
-
-```yaml
-# api/config/services.yaml
-services:
-    # ...
-    'App\Filter\CustomOrderFilter': ~
-        # Uncomment only if autoconfiguration isn't enabled
-        #tags: [ 'api_platform.filter' ]
-```
-
 ## ApiFilter Annotation
 
 The annotation can be used on a `property` or on a `class`.

core/form-data.md

@@ -40,7 +40,7 @@ final class DeserializeListener
 
     public function onKernelRequest(GetResponseEvent $event): void {
         $request = $event->getRequest();
-        if ($request->isMethodSafe() || $request->isMethod(Request::METHOD_DELETE)) {
+        if ($request->isMethodSafe(false) || $request->isMethod(Request::METHOD_DELETE)) {
             return;
         }
 
@@ -84,4 +84,4 @@ services:
         decorates: 'api_platform.listener.request.deserialize'
         arguments:
             $decorated: '@App\EventListener\DeserializeListener.inner'
-```
+```

core/graphql.md

@@ -14,9 +14,11 @@ Once enabled, you have nothing to do: your schema describing your API is automat
 
 To enable GraphQL and GraphiQL interface in your API, simply require the [graphql-php](https://webonyx.github.io/graphql-php/) package using Composer and clear the cache one more time:
 
-    $ composer require webonyx/graphql-php && bin/console cache:clear
+```bash
+docker-compose exec php composer req webonyx/graphql-php && bin/console cache:clear
+```
 
-You can now use GraphQL at the endpoint: `http://localhost/graphql`.
+You can now use GraphQL at the endpoint: `https://localhost:8443/graphql`.
 
 ## GraphiQL