Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alterphp/easyadminextensionbundle
Provides some additional features to EasyAdminBundle for Symfony
https://github.com/alterphp/easyadminextensionbundle
admin easyadmin easyadmin-extension symfony symfony-bundle
Last synced: 1 day ago
JSON representation
Provides some additional features to EasyAdminBundle for Symfony
- Host: GitHub
- URL: https://github.com/alterphp/easyadminextensionbundle
- Owner: alterphp
- License: mit
- Created: 2017-05-09T20:46:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T13:41:00.000Z (about 1 year ago)
- Last Synced: 2024-12-21T23:06:02.750Z (1 day ago)
- Topics: admin, easyadmin, easyadmin-extension, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 829 KB
- Stars: 256
- Watchers: 15
- Forks: 58
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
EasyAdmin Extension
===================
[](https://packagist.org/packages/alterphp/easyadmin-extension-bundle) [](https://travis-ci.org/alterphp/EasyAdminExtensionBundle) [](https://insight.sensiolabs.com/projects/a7179df5-4ed7-468c-899c-891535dbe802) [](https://coveralls.io/github/alterphp/EasyAdminExtensionBundle?branch=master) [](https://packagist.org/packages/alterphp/easyadmin-extension-bundle)
EasyAdmin Extension provides some useful extensions to [EasyAdmin](https://github.com/EasyCorp/EasyAdminBundle) admin generator for Symfony.
* Branch `3.x` of this bundle requires at least __PHP 7.1__ and __Symfony 4.2__ components or stack and is suitable for EasyAdmin `^2.2.2` (Versions v2.2.0 and v2.2.1 are not allowed as they don't have native menu permissions). It allows installation of EasyAdmin `2.2.0` or upper and Symfony 5 as well. __Extension bundle implementation of list filters is NOT COMPATIBLE with EasyAdmin dynamic list filters !__ That's why we introduced the following change :
> :exclamation: __BC BREAK__ list filters implemented by this extension bundle now use `ext_filters` query/form parameter, as `filters` is now used by native EasyAdmin for its own implementation of dynamic list filters.
* Branch `2.x` of this bundle requires at least __PHP 7.1__ and __Symfony 4.1__ components or stack and is suitable for EasyAdmin `2.0.x` and `2.1.x`. __It does not allow installation of EasyAdmin `2.2.0` or upper !__
* Branch `1.x` of this bundle requires at least __PHP 7.0__ and __Symfony 3.0__ components or stack and is suitable for EasyAdmin `1.x`.
__Features__
* [List filters form](#list-filters-form)
* [Register its own form types and aliases](#register-your-own-form-types-with-a-short-name-aliasing-form-types)
* [Embed lists in EDIT and SHOW views](#embed-lists-in-edit-and-show-views)
* [Autocomplete option to create related entity](#autocomplete-add-new-option-create-for-modal-in-new-and-edit)
* [Role based access permissions](#define-access-permissions)
* [Confirmation modal for custom POST actions (without form)](#confirmation-modal-for-custom-post-actions-without-form)
* [Form fields by exclusion](#exclude-fields-in-forms)
* [Vertical theme for SHOW view](#use-template-show-vertical-boostrap)
Installation
------------
### Step 1: Download the Bundle
```bash
$ composer require alterphp/easyadmin-extension-bundle
```
This command requires you to have Composer installed globally, as explained
in the [Composer documentation](https://getcomposer.org/doc/00-intro.md).
### Step 2: Enable the Bundle
```php
=', operator: gte }
- { name: maxSubscriptionLTE, property: maxSubscriptions, label: 'Max subscriptions <=', operator: lte }
```
Available built-in operators are listed in `AlterPHP\EasyAdminExtensionBundle\Model\ListFilter` class, as constant `OPERATOR_*` :
* __equals__: Is equal to
* __not__: Is different of
* __in__: Is in (`array` or Doctrine `Collection` expected)
* __notin__: Is not in (`array` or Doctrine `Collection` expected)
* __gt__: Is greater than
* __gte__: Is greater than or equal to
* __lt__: Is lower than
* __lte__: Is lower than or equal to
* __like__: Is LIKE %filterValue%
### Filter list and search on request parameters
* EasyAdmin allows filtering list with `dql_filter` configuration entry. But this is not dynamic and must be configured as an apart list in `easy_admin` configuration.*
This extension allows to __dynamically filter lists__ by adding `ext_filters` parameter in the URL parameters. Having a list of books at URL `?action=list&entity=Book` with a releaseYear field, you can filter on books releasd in 2016 by requesting `?action=list&entity=Book&ext_filters[entity.releaseDate]=2016`. It only matches exact values, but you can chain them. To request books released in 2015 and 2016, you must request `?action=list&entity=Book&ext_filters[entity.releaseDate][]=2015&ext_filters[entity.releaseDate][]=2016`.
This `ext_filters` parameter is transmitted to the referer used for post update/delete/create redirection AND for search !
### Register your own form types with a short name (aliasing form types)
You have custom form types that you want to use in the EasyAdmin configuration. You can already register them with FQCN ... but it's quite boring and makes the admin massively enlarged. This feature allows you to define your own form types with short names, by configuration.
Let's see how to register them with those 2 examples (enum and statusable) :
```yaml
easy_admin_extension:
custom_form_types:
enum: Admin\Form\Type\EnumType
statusable: Admin\Form\Type\StatusableType
```
### Embed lists in edit and show views
#### Options
Embedded lists are useful to show relations to en entity in its *NEW/EDIT/FORM* or *SHOW* view. It relies on the *LIST* view of the related entities you want to embed in the parent EDIT/SHOW view. Options must be defined in `type_options` key for a *NEW/EDIT/FORM* view, or in `template_options` for a *SHOW* view.
Available options are :
- `entity`: Entity config name (key under the EasyAdmin `entities` config)
- `ext_filters`: Request filters to apply on the list
- `hidden_fields`: List of fields (columns) to hide from list fields config
- `max_results`: Number of items par page (list.max_results config is used if not defined)
- `sort`: Sort to apply
- `parent_entity_fqcn`: Parent entity FQCN in order to guess default filters (only when embedded in *SHOW* view, almost never required)
- `parent_entity_property`: Matching property name on parent entity FQCN (only when embedded in *SHOW* view, if `property` is not an ORM field)
- `entity_fqcn`: Listed entities FQCN in order to guess default filters (only when embedded in *SHOW* view, almost never required)
#### Options guesser based on ORM metadata
Service EmbeddedListHelper is intended to guess `entity` entry for embedded_list. It's reads ORM metadata, based on parent entity (the one that embeds the list) and property name.
It also guess default filter (relation between the parent and embedded list) for most of cases.
#### Edit view
Use pre-configured type `embedded_list` in the form definition :
```yaml
easy_admin:
entities:
Event:
class: App\Entity\Event
Promoter:
class: App\Entity\Promoter
form:
fields:
# ...
- { type: group, label: Events, css_class: 'col-sm-12', icon: calendar }
- { property: events, label: '', type: embedded_list, type_options: { entity: Event, ext_filters: { 'entity.promoter': 'form:parent.data.id' } } }
```
But in many cases, the EmbeddedListHelper guesses __type_options__ for you, and you just have to write :
```yaml
easy_admin:
entities:
Event:
class: App\Entity\Event
Promoter:
class: App\Entity\Promoter
form:
fields:
# ...
- { type: group, label: Events, css_class: 'col-sm-12', icon: calendar }
- { property: events, label: '', type: embedded_list }
```
Let's see the result !
#### Show view
Using guesser for classic \*ToMany relations :
```yaml
easy_admin:
entities:
Event:
class: App\Entity\Event
Promoter:
class: App\Entity\Promoter
show:
fields:
# ...
- { property: events, label: '', type: embedded_list }
```
Use following __template_options__ to pass options.
#### Disabling "Open in new tab" link at the bottom of embedded lists
* __globally__ in `config/packages/easy_admin_extension.yaml` :
```yaml
easy_admin_extension:
embedded_list:
open_new_tab: false
```
* __by entity__ in `config/packages/easy_admin.yaml` :
```yaml
easy_admin:
entities:
YourEntity:
class: App\Entity\YourEntity
embeddedList:
open_new_tab: false
```
### Autocomplete add new option 'create' for modal in new and edit
#### Configure form type 'easyadmin_autocomplete', add type_options: { attr: { create: true } }
```yaml
easy_admin:
entities:
Promoter:
class: App\Entity\Promoter
Event:
class: App\Entity\Event
form:
fields:
# ...
- { property: 'promoter', type: 'easyadmin_autocomplete', type_options: { attr: { create: true } } }
```
### Define access permissions
#### Global minimum role access
You can define a minimum role to access the EasyAdmin controller (any action handled by the controller) :
```yaml
easy_admin_extension:
minimum_role: ROLE_ADMIN
```
This is just a global restriction, that should live with a security firewall as described in [Symfony documentation](https://symfony.com/doc/current/security.html).
#### Per entity action role permissions
You can also define role permissions per entity action :
```yaml
easy_admin:
entities:
Product:
class: App\Entity\Product
list:
role: ROLE_ADMIN_PRODUCT_LIST
search:
role: ROLE_ADMIN_PRODUCT_SEARCH
new:
role: ROLE_ADMIN_PRODUCT_NEW
edit:
role: ROLE_ADMIN_PRODUCT_EDIT
show:
role: ROLE_ADMIN_PRODUCT_SHOW
delete:
role: ROLE_ADMIN_PRODUCT_DELETE
```
Above configuration define a required _role_ per action for *Product* entity. This is too verbose, isn't it ? Let's sum up as following :
```yaml
easy_admin:
entities:
Product:
class: App\Entity\Product
role_prefix: ROLE_ADMIN_PRODUCT
```
Entity _role_prefix_ defines all actions required roles by appending the action name to the prefix.
#### Per entity field role permissions in form
You can also define role permissions per entity field in a form:
```yaml
easy_admin:
entities:
Product:
class: App\Entity\Product
form:
fields:
- { property: enabled, role: ROLE_ADMIN }
```
If user do not hold the required role, the form field will be disabled.
### Confirmation modal for custom POST actions without form
A generic confirmation modal asks for confirmation (or any custom message) for links with `data-confirm` attribute (that may contain the custom message) and URL in `data-href` attribute.
Easy configurable with custom list actions by adding a `confirm` key :
```yaml
easyadmin:
entities:
User:
list:
actions:
- { name: disable, icon: ban, title: Disable user, label: false, target: _blank, confirm: User will lose any access to the platform ! }
```
To keep the confirmation modal behavior while creating [a custom action template](https://symfony.com/doc/2.x/bundles/EasyAdminBundle/tutorials/custom-actions.html#custom-templates-for-actions) you need to use the action template provided by this bundle, replacing ` {{ include('@EasyAdmin/default/action.html.twig') }}
` by ` {{ include('@EasyAdminExtension/default/action.html.twig') }}`.
### Exclude fields in forms
```yaml
easyadmin:
entities:
User:
form:
exclude_fields: ['references']
```
In such entity:
```php