Skip to content

Remove references to DunglasActionBundle #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 14, 2017
Merged

Remove references to DunglasActionBundle #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions core/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ final class BookMailSubscriber implements EventSubscriberInterface
}
```

If you use the official API Platform distribution, creating the previous class is enough. [DunglasActionBundle](https://github.com/dunglas/DunglasActionBundle)
(installed by default) will automatically register this subscriber as a service and will inject its dependencies using [the
autowiring feature of the Symfony Dependency Injection Container](http://symfony.com/doc/current/components/dependency_injection/autowiring.html).
If you use the official API Platform distribution, creating the previous class is enough. The Symfony Dependency Injection
component will automatically register this subscriber as a service and will inject its dependencies thanks to the [autowiring
feature](http://symfony.com/doc/current/components/dependency_injection/autowiring.html).

If you don't have DunglasActionBundle installed, [the subscriber must be registered manually](http://symfony.com/doc/current/components/http_kernel/introduction.html#creating-an-event-listener).
Alternatively, [the subscriber must be registered manually](http://symfony.com/doc/current/components/http_kernel/introduction.html#creating-an-event-listener).

[Doctrine events](http://doctrine-orm.readthedocs.org/en/latest/reference/events.html#reference-events-lifecycle-events)
are also available (if you use it) if you want to hook at the object lifecycle events.
Expand Down
17 changes: 7 additions & 10 deletions core/operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ API Platform Core relies on the concept of operations. Operations can be applied
an implementation point of view, an operation is a link between a resource, a route and its related controller.

API Platform automatically registers typical [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) operations
and describes them in the exposed documentation (Hydra and NelmioApiDoc). It also creates and registers routes corresponding
and describes them in the exposed documentation (Hydra and Swagger). It also creates and registers routes corresponding
to these operations in the Symfony routing system (if it is available).

The behavior of built-in operations is briefly presented in the [Getting started](getting-started.md#mapping-the-entities)
Expand Down Expand Up @@ -353,15 +353,12 @@ implements the [Action-Domain-Responder](https://github.com/pmjones/adr) pattern

Note: [the event system](events.md) should be preferred over custom controllers when applicable.

The distribution of API Platform also comes with an enhanced action system for Symfony pre-installed: [DunglasActionBundle](https://github.com/dunglas/DunglasActionBundle).
*DunglasActionBundle* eases the implementation of the ADR pattern with Symfony and improves the developer experience.

It automatically registers action classes stored in `src/*Bundle/Action` and `src/*Bundle/Controller` directories as autowired
services.
The distribution of API Platform also eases the implementation of the ADR pattern: it automatically registers action classes
stored in `src/AppBundle/Action` and `src/AppBundle/Controller` as autowired services.

Thanks to the [autowiring](http://symfony.com/doc/current/components/dependency_injection/autowiring.html) feature of the
Symfony dependency injection container, services required by an action can be type-hinted in its controller, it will be automatically
instantiated and injected, without having to declare it explicitly.
Symfony Dependency Injection container, services required by an action can be type-hinted in its constructor, it will be
automatically instantiated and injected, without having to declare it explicitly.

In the following example, the built-in `GET` operation is registered as well as a custom operation called `special`.
The `special` operation reference the Symfony route named `book_special`.
Expand Down Expand Up @@ -473,8 +470,8 @@ It is mandatory to set the `_api_resource_class` and `_api_item_operation_name`
operation) in the parameters of the route (`defaults` key). It allows API Platform and the Symfony routing system to hook
together.

Here we consider that DunglasActionBundle is installed (the default when using the API Platform distribution). This
action will be automatically registered as a service (the service name is the same as the class name: `AppBundle\Action\BookSpecial`).
Here we consider that the autowiring enabled for controller classes (the default when using the API Platform distribution).
This action will be automatically registered as a service (the service name is the same as the class name: `AppBundle\Action\BookSpecial`).

API Platform automatically retrieves the appropriate PHP entity then deserializes it, and for `POST` and `PUT` requests
updates the entity with data provided by the user.
Expand Down