Merge branch '2.3'

Author: dunglas

.travis.yml

@@ -1,4 +1,6 @@
-language: node
+language: node_js
+node_js:
+  - 'stable'
 
 cache:
   yarn: true
@@ -7,6 +9,10 @@ env:
   global:
     secure: gjiWHIgNjLXuEFmLiepiOTHOuauHfeKHutrE0sBwFZUQzP9FoGTZzJub1z8/vm+hhygA+TZbB0iclygHyNrXCkZyNdnZXChXl4iPdYqY3OARPOAbQff16+/XSUDsZ/Ok1etdb3kKor1R4rBt/WywBvXmmdggumTA3yT5ExI+dyomdONo4yMUZ7g1la0ehMEzGqyVjt0nUW31PN3l6dI1qgigHCuotSrrpWP6fTXuUh5l6YA7KXb/V1hJxaGENLz1Cdfk0sF66e4KsV/DX6JZSqpvdqVB8OTPU+si511yJtGS8OeuLs4RqmXMLrY/ChCodlYnfCE+NleBFpUnCVqth/RDRh7LvplUJlpsXNcfyoA3mOFmZa0euOMCqJ3qwESz802Y9c5oN63hn2OUF/raFDc3SMMC86FFHxwyYjz5+yzXYupnFNj39NKdQ1v1KBbY8BD8UT8RU3mlu4/3LRz0tSamREHj3pGgBmvgUZfUE1dMngeaZjOmBaIZH8TnKQ75CvfnoT+LJnZo6g9g4uwz6jtaIziSMZ0OW/95nF8yx+xONbHEtt5ex5M09NOFsN2vB2bcUAgIjyGrmmNLQadwJyQv557IGPEE5CyGhJpXh9XZ+WMw2vO45MOw4sQPkARF6OJkMteqFc2NLXMOQJ07EScbgEKR/9VOcyxIk/7a7nc=
 
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash
+  - export PATH="$HOME/.yarn/bin:$PATH"
+
 install:
   - pip install --user proselint
   - cp .proselintrc ~

client-generator/images/adnew.png

@@ -3,6 +3,7 @@
 API Platform Client Generator is a generator for scaffolding apps with Create-Retrieve-Update-Delete features for any API exposing a Hydra documentation. Currently the following targets are available:
 
  * React/Redux
+ * React Native
  * Vue.js
 
 The generator works especially well with APIs built with the [API Platform](https://api-platform.com) framework.

client-generator/images/del.png

@@ -0,0 +1,90 @@
+React Native generator
+======================
+
+Create a React Native application using [React Community's Create React Native App](https://github.com/react-community/create-react-native-app)
+
+```bash
+$ yarn add -g expo-cli
+$ expo init my-app
+$ cd my-app
+```
+
+Install:  React Native Elements, React Native Router Flux, React Native Vector Icons, Redux, React Redux, Redux Thunk, Redux Form, Prop Types
+
+```bash
+$ yarn add redux react-redux redux-thunk redux-form react-native-elements react-native-router-flux 
+react-native-vector-icons prop-types
+```
+
+Install the generator globally:
+
+```bash
+$ yarn global add @api-platform/client-generator
+```
+
+In the app directory, generate the files for the resource you want:
+
+```
+    $ generate-api-platform-client https://demo.api-platform.com  -g react-native --resource foo
+    # Replace the URL by the entrypoint of your Hydra-enabled API
+    # Omit the resource flag to generate files for all resource types exposed by the API
+```
+Create **Router.js** file to import all routes
+
+```javascript
+import React from 'react';
+import { Router, Stack } from 'react-native-router-flux';
+//replace "book" with the name of resource type
+import BookRoutes from './routes/book';
+
+const RouterComponent = () => {
+  return (
+      <Router>
+        <Stack key="root">
+          {BookRoutes}
+        </Stack>
+      </Router>
+  );
+};
+
+export default RouterComponent;
+```
+Here is an example of  **App.js**
+
+```javascript
+import React, { Component } from 'react';
+import { Provider } from 'react-redux';
+import thunk from 'redux-thunk';
+import { createStore, applyMiddleware, combineReducers} from 'redux';
+import { View } from 'react-native';
+import {reducer as form} from 'redux-form';
+//replace "book" with the name of resource type
+import book from './reducers/book';
+import Router from './Router';
+
+export default class App extends Component {
+  render() {
+    const store = createStore(combineReducers({
+      book,
+      form
+    }), {}, applyMiddleware(thunk));
+    return (
+        <Provider store={store}>
+          <View style={{flex: 1}}>
+            <Router/>
+          </View>
+        </Provider>
+    );
+  }
+}
+```
+
+The code is ready to be executed!
+```bash
+$ expo start
+```
+
+#### Example of running  application on IOS simulator
+
+![List](images/list.png) ![Show](images/item.png)
+ ![Add](images/adnew.png) ![Delete](images/del.png)

client-generator/images/item.png

@@ -38,16 +38,19 @@ Bootstrap 4 - from release 0.1.16
 
 In the app directory, generate the files for the resource you want:
 
-    $ generate-api-platform-client https://demo.api-platform.com src/ --resource foo
-    # Replace the URL by the entrypoint of your Hydra-enabled API
-    # Omit the resource flag to generate files for all resource types exposed by the API
+```bash
+$ generate-api-platform-client https://demo.api-platform.com src/ --resource book
+# Replace the URL by the entrypoint of your Hydra-enabled API
+# Omit the resource flag to generate files for all resource types exposed by the API
+```
 
 The code is ready to be executed! Register the generated reducers and components in the `index.js` file, here is an example:
 
 ```javascript
 import React from 'react';
-import ReactDom from 'react-dom';
-import registerServiceWorker from './registerServiceWorker';
+import ReactDOM from 'react-dom';
+import * as serviceWorker from './serviceWorker';
+
 import { createStore, combineReducers, applyMiddleware } from 'redux';
 import { Provider } from 'react-redux';
 import thunk from 'redux-thunk';
@@ -56,28 +59,31 @@ import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
 import createBrowserHistory from 'history/createBrowserHistory';
 import { syncHistoryWithStore, routerReducer as routing } from 'react-router-redux'
 
-// Replace "foo" with the name of the resource type
-import foo from './reducers/foo/';
-import fooRoutes from './routes/foo';
+// Replace "book" with the name of the resource type
+import book from './reducers/book/';
+import bookRoutes from './routes/book';
 
 const store = createStore(
-  combineReducers({routing, form, foo}), // Don't forget to register the reducers here
+  combineReducers({routing, form, book}), // Don't forget to register the reducers here
   applyMiddleware(thunk),
 );
 
 const history = syncHistoryWithStore(createBrowserHistory(), store);
 
-ReactDom.render(
+ReactDOM.render(
   <Provider store={store}>
     <Router history={history}>
       <Switch>
-        {fooRoutes}
+        {bookRoutes}
         <Route render={() => <h1>Not Found</h1>}/>
       </Switch>
     </Router>
   </Provider>,
   document.getElementById('root')
 );
 
-registerServiceWorker();
+// If you want your app to work offline and load faster, you can change
+// unregister() to register() below. Note this comes with some pitfalls.
+// Learn more about service workers: http://bit.ly/CRA-PWA
+serviceWorker.unregister();
 ```

client-generator/images/list.png

@@ -207,7 +207,7 @@ There is two solutions to achieve that:
 
 #### Use Swagger Decorator
 
-By following the doc about [Override the Swagger Documentation](swagger.md##overriding-the-swagger-documentation)
+By following the doc about [Override the Swagger Documentation](swagger.md#overriding-the-swagger-documentation)
 and adding the ability to retrieve a `_api_swagger_context` in route
 parameters, you should be able to display your custom endpoint.
 

client-generator/index.md

@@ -32,7 +32,7 @@ vich_uploader:
 
 ## Configuring the Entity Receiving the Uploaded File
 
-In our exemple, we will create a `MediaObject` API resource. We will post files
+In our example, we will create a `MediaObject` API resource. We will post files
 to this resource endpoint, and then link the newly created resource to another
 resource (in our case: Book).
 

client-generator/react-native.md

@@ -136,6 +136,10 @@ Case insensitivity may already be enforced at the database level depending on th
 used. If you are using MySQL, note that the commonly used `utf8_unicode_ci` collation (and its sibling `utf8mb4_unicode_ci`)
 are already case insensitive, as indicated by the `_ci` part in their names.
 
+Note: Search filters with the exact strategy can have multiple values for a same property (in this case the condition will be similar to a SQL IN clause).
+
+Syntax: `?property[]=foo&property[]=bar`
+
 In the following example, we will see how to allow the filtering of a list of e-commerce offers:
 
 ```php
@@ -160,6 +164,7 @@ 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".
 
 Filters can be combined together: `http://localhost:8000/api/offers?price=10&name=shirt`
 
@@ -680,7 +685,7 @@ final class RegexpFilter extends AbstractContextAwareFilter
         ) {
             return;
         }
-        
+
         $parameterName = $queryNameGenerator->generateParameterName($property); // Generate a unique parameter name to avoid collisions with other filters
         $queryBuilder
             ->andWhere(sprintf('REGEXP(o.%s, :%s) = 1', $property, $parameterName))
@@ -1074,7 +1079,7 @@ class DummyCar
      * @ApiFilter(SearchFilter::class, properties={"colors.prop": "ipartial"})
      */
     private $colors;
-    
+
     // ...
 }
 

client-generator/react.md

@@ -99,14 +99,14 @@ final class UuidNormalizer implements DenormalizerInterface
 Tag this service as a `api_platform.identifier.normalizer`:
 
 ```xml
-  <service id="App\identifier\UuidNormalizer" class="App\identifier\UuidNormalizer" public="false">
+  <service id="App\Identifier\UuidNormalizer" class="App\Identifier\UuidNormalizer" public="false">
       <tag name="api_platform.identifier.normalizer" />
   </service>
 ```
 
 ```yaml
 services:
-    App\identifier\UuidNormalizer:
+    App\Identifier\UuidNormalizer:
         tags:
             - { name: api_platform.identifier.normalizer }
 ```

core/dto.md

@@ -462,6 +462,29 @@ class Question
 }
 ```
 
+### Access Control of Subresources
+
+The `subresourceOperations` attribute also allows you to add an access control on each path with the attribute `access_control`.
+
+```php
+<?php
+// api/src/Entity/Question.php
+
+/**
+ * ...
+ * @ApiResource(
+ *     subresourceOperations={
+ *          "answer_get_subresource"= {
+ *              "method"="GET",
+ *              "access_control"="has_role('ROLE_AUTHENTICATED')"
+ *          }
+ *      }
+ * )
+ class Question
+ {
+ }
+```
+
 ### Control the Depth of Subresources
 
 You can control depth of subresources with the parameter `maxDepth`. For example, if `Answer` entity also have subresource
@@ -663,7 +686,7 @@ use Symfony\Component\Serializer\Annotation\Groups;
 class Book
 {
     //...
-    
+
     /**
      * @Groups("special")
      */

core/file-upload.md

@@ -20,7 +20,7 @@ fresh, because the cache is purged in real time.
 The support for most specific cases such as the invalidation of collections when a document is added or removed or for
 relationships and inverse relations is built-in.
 
-We also included [Varnish](https://varnish-cache.org/) in the [Docker setup](../deployment/docker.md) provided with the
+We also included [Varnish](https://varnish-cache.org/) in the [Docker setup](../distribution/index.md#using-the-official-distribution-recommended) provided with the
 distribution of API Platform, so this feature works out of the box.
 
 Integration with Varnish and the Doctrine ORM is shipped with the core library. You can easily implement the support for

core/filters.md

@@ -308,7 +308,7 @@ class Book
 }
 ```
 
-The following rules apply when denormalizating embedded relations:
+The following rules apply when denormalizing embedded relations:
 
 * If an `@id` key is present in the embedded resource, then the object corresponding to the given URI will be retrieved through
 the data provider. Any changes in the embedded relation will also be applied to that object.
@@ -450,6 +450,7 @@ namespace App\Serializer;
 
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\SerializerAwareInterface;
 use Symfony\Component\Serializer\SerializerAwareTrait;
 
@@ -495,7 +496,7 @@ class BookAttributeNormalizer implements ContextAwareNormalizerInterface, Serial
     private function passOn($object, $format = null, array $context = [])
     {
         if (!$this->serializer instanceof NormalizerInterface) {
-            throw new LogicException(sprintf('Cannot normalize object "%s" because the injected serializer is not a normalizer', $object));
+            throw new \LogicException(sprintf('Cannot normalize object "%s" because the injected serializer is not a normalizer', $object));
         }
 
         $context[self::BOOK_ATTRIBUTE_NORMALIZER_ALREADY_CALLED] = true;
@@ -606,7 +607,7 @@ final class ApiNormalizer implements NormalizerInterface, DenormalizerInterface,
 API Platform is able to guess the entity identifier using [Doctrine metadata](http://doctrine-orm.readthedocs.org/en/latest/reference/basic-mapping.html#identifiers-primary-keys).
 It also supports composite identifiers.
 
-If you are not using the Doctrine ORM Provider, you must explictely mark the identifier using the `identifier` attribute of
+If you are not using the Doctrine ORM Provider, you must explicitly mark the identifier using the `identifier` attribute of
 the `ApiPlatform\Core\Annotation\ApiProperty` annotation.  For example:
 
 

core/identifiers.md

@@ -103,7 +103,7 @@ class Product // The class name will be used to name exposed resources
     public $id;
 
     /**
-     * @param string $name A name property - this description will be avaliable in the API documentation too.
+     * @param string $name A name property - this description will be available in the API documentation too.
      *
      * @ORM\Column
      * @Assert\NotBlank

core/operations.md

@@ -643,9 +643,9 @@ ISBN isn't valid...
 ## Adding GraphQL Support
 
 Isn't API Platform a REST **and** GraphQL framework? That's true! GraphQL support isn't enabled by default, to add it we
-need to install the [graphql-php](https://webonyx.github.io/graphql-php/) library. Run the following command:
+need to install the [graphql-php](https://webonyx.github.io/graphql-php/) library. Run the following command (the cache needs to be cleared twice):
 
-    $ docker-compose exec php composer req webonyx/graphql-php
+    $ docker-compose exec php composer req webonyx/graphql-php && bin/console cache:clear
 
 You now have a GraphQL API! Open `https://localhost:8443/graphql` to play with it using the nice [GraphiQL](https://github.com/graphql/graphiql)
 UI that is shipped with API Platform: