Chapters

40 Chapters | 4:19:16 |

01

Installing EasyAdmin

3:29
02

Admin Dashboard

7:31
03

Hello CRUD Controller

6:04
04

Global vs CRUD-Specific Configuration

9:13
05

Controlling the Dashboard Menu

5:55
06

Assets: Custom CSS and JS

8:17
07

Configuring Fields

7:01
08

Fields on some Pages, not Others

3:43
09

Deep Field Configuration

7:54
10

Upload Fields

7:21
11

Controlling the "Formatted Value"

4:23
12

The AssociationField

8:02
13

Auto-complete Association Field & Controlling the Query

5:36
14

AssociationField for a "Many" Collection

6:28
15

The Field Configurator System

7:23
16

Field Configurator Logic

8:32
17

Overriding Field Templates

6:04
18

Creating a Custom Field

5:27
19

configureCrud()

5:38
20

Custom Field JavaScript

5:23
21

Custom Stimulus JavaScript Controller

6:20
22

The Dashboard Page

6:54
23

Service Action Injection

3:14
24

Override all the Templates!

6:47
25

Permissions

6:35
26

Restricting Access to an Entire Crud Section

2:55
27

Entity & Field Permissions

5:39
28

Security Voter & Entity Permissions

8:36
29

The Filter System

6:40
30

Multiple Cruds for a Single Entity?

7:32
31

Extending with Events

8:03
32

Having Fun with the Menu

3:25
33

Conditionally Disabling an Action

8:37
34

Dynamic Disable an Action & AdminContext

10:40
35

Simple Custom GET Action

4:56
36

True Custom Action

5:19
37

Custom Controller & Generating Admin URLs

5:43
38

A Global "Export" Action

10:13
39

Linking to EasyAdmin from Twig

5:01
40

Form Panels

6:41

> Symfony > EasyAdmin! For an Awesomely Powerful Admin Area

Buy Access to Course

36.

True Custom Action

|

Autoplay

Keep on Learning!

If you liked what you've learned so far, dive in! Subscribe to get
access to this tutorial plus video, code and script downloads.

Start your All-Access Pass

Buy just this tutorial for $12.00

Previous Chapter

Next Chapter

With a Subscription, click any sentence in the script to jump to that part of the video!

Login Subscribe

Login or register to check out the script

23 Comments

Sort By

Login or Register to join the conversation

ahmedbhs 2 years ago

Is there a way to add a popup containing a brief description of a given action?

|

Victor SFCASTS ahmedbhs 2 years ago edited

Hey @ahmedbhs ,

That's possible, you can add some custom JavaScript that will intercept the click and show a popup... or even override some core EA templates to add a custom HTML code if needed.

I hope that helps!

Cheers!

|

Omar-Drb 2 years ago

Hi, thanks for the great course.

I have a small problem, I am working on adding a custom action in the detail page, and I created a custom twig template for it, and in order for it to function correctly I need to calculate some data in the backend first, and then pass the result to the frontend to use it in the action.

Here is how I am trying to do it:

...
...
class TicketCrudController extends AbstractCrudController
{
    public static function getEntityFqcn(): string
    {
        return Ticket::class;
    }
    
    ...
    ...

    public function detail(AdminContext $context)
    {
        $detail = parent::detail($context);
        $data = $this->calculate(); // return string
        $detail->set('test', $data);
        return $detail;
    }
}

and in the action template I have:

{# @var ea \EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext #}
{# @var action \EasyCorp\Bundle\EasyAdminBundle\Dto\ActionDto #}
{# @var entity \EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto #}

{{ include('@EasyAdmin/crud/action.html.twig') }}

{{ dump(ea) }}

The problem is that the admin context in the frontend doesn't contain the variable I set in the backend. Is there another way to pass data from backend to frontend.

|

weaverryan SFCASTS Omar-Drb 2 years ago

Hey @Omar-Drb!

I believe you are doing the correct thing. But I think the result is that you will have a variable called test on the frontend: it will not be some new variable inside of ea. Try {{ dump() }} to see ALL of the variable you have available.

Cheers!

1 |

Omar-Drb weaverryan 2 years ago

Thank you very much for your reply,

I checked it but unfortunately these are the only variables that exists:

array:3 [▼
  "action" => EasyCorp\Bundle\EasyAdminBundle\Dto\ActionDto {#668 ▶}
  "ea" => EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext {#798 ▶}
  "app" => Symfony\Bridge\Twig\AppVariable {#1288 ▶}
]

I also tried using the search functionality but there were no variable with the name 'test' anywhere

|

weaverryan SFCASTS Omar-Drb 2 years ago

Hmm, dang! Here how it looks like it should work:

A) You call parent::detail($context). That returns a KeyValueStore object.
B) You call $detail->set('test', $data);, which adds this to the KeyValueStore
C) You return the KeyValueStore from the controller
D) A listener from EasyAdmin is called after your controller. It grabs your return value (the KeyValueStore) - https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/EventListener/CrudResponseListener.php#L28
E) These are used as the variables when rendering the template - see https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/EventListener/CrudResponseListener.php#L37 and https://github.com/EasyCorp/EasyAdminBundle/blob/4.x/src/EventListener/CrudResponseListener.php#L52

So, I don't know what's going wrong. But perhaps you can add some debugging code in the core of EasyAdmin to see what's not working as I expect.

Cheers!

1 |

Rudi-T 3 years ago edited

Just wanted to share this insight:

If you need access to the current entity on a action data attribute, you can use this trick:

Ex show a modal if you want to block a user, that asks if you are sure to block user x?

entity is a var that lives in the twig action template, so you can abuse it like this:

$blockUserAction = static fn(): Action => Action::new('blockUser', 'Block user')
    ->linkToCrudAction('blockUser')
    ->setTemplatePath($postButtonTemplate)
    ->setHtmlAttributes([ // TODO: translate
        'data-confirmation-message' => 'Do you want to block user {% if entity is defined %}{{ entity.instance.username }}{% else %}{{ea.entity.instance.username}}{% endif %}?'
    ])
    ->displayIf(fn(User $user) => $user->getStatus() !== UserStatus::BLOCKED);

Inside your template you can do this:

{# @var action \EasyCorp\Bundle\EasyAdminBundle\Dto\ActionDto #}
{# @var entity \EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto #}
{% set confirmationMessage = action.getHtmlAttributes()['data-confirmation-message']|default('') %}
{% if confirmationMessage != '' %}
{% do action.setHtmlAttributes(action.htmlAttributes|merge({'data-confirmation-message': include(template_from_string(confirmationMessage))})) %}
{% endif %}

You still need to activate this function in Symfony:

services:
    Twig\Extension\StringLoaderExtension: ~

More info: https://twig.symfony.com/doc/3.x/functions/template_from_string.html

|

MolloKhan SFCASTS Rudi-T 3 years ago edited

Hey @Rudi-T

That's a nice trick, but it's not clear to me why you have to write the Twig template code inside a HTML attribute?

Cheers!

|

Rudi-T MolloKhan 3 years ago

Hey @MolloKhan, It's to connect a stimulus controller and set the message of a modal.
A bit like the idea highlighted in this tutorial, that you could implement.

In our solution we don't need a custom template for each modal we show. Very dynamic with almost no code maintenance.

1 |

Rudi-T 3 years ago edited

Is it possible that this is bugged on the latest version?

Warning: Undefined array key "ea"

{# @var ea \EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext #}
{# @var action \EasyCorp\Bundle\EasyAdminBundle\Dto\ActionDto #}
{# @var entity \EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto #}
{# Fix edit bug #}
{% set excludedKey = 'form' %}  
{% set htmlAttributes = action.htmlAttributes|default({}) %} 
{% set filteredHtmlAttributes = htmlAttributes|merge([])|filter((value, key) => key != excludedKey) %} 
{% do action.setHtmlAttributes(filteredHtmlAttributes) %}  
<form action="{{ action.linkUrl }}" method="POST" class="me-2">    
    {{ include('@EasyAdmin/crud/action.html.twig') }} 
</form>

Fix only works if I remove the form attribute of the button

|

weaverryan SFCASTS Rudi-T 3 years ago

Hey @Rudi-T!

Hmm, it's possible, though EasyAdmin hasn't gotten any major upgrades, so nothing "should" have broken. Where does this error come from - like what's the stack trace? And, is your above code (the 3x set and do a work-around for the error)?

Cheers!

|

Rudi-T weaverryan 3 years ago edited

ErrorException:
Warning: Undefined array key "ea"

  at vendor/easycorp/easyadmin-bundle/src/Controller/AbstractCrudController.php:624
  at EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController->getRedirectResponseAfterSave(object(AdminContext), 'edit')
     (vendor/easycorp/easyadmin-bundle/src/Controller/AbstractCrudController.php:263)
  at EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController->edit(object(AdminContext))
     (vendor/symfony/http-kernel/HttpKernel.php:163)
  at Symfony\Component\HttpKernel\HttpKernel->handleRaw(object(Request), 1)
     (vendor/symfony/http-kernel/HttpKernel.php:74)
  at Symfony\Component\HttpKernel\HttpKernel->handle(object(Request), 1, true)
     (vendor/symfony/http-kernel/Kernel.php:184)
  at Symfony\Component\HttpKernel\Kernel->handle(object(Request))
     (vendor/symfony/runtime/Runner/Symfony/HttpKernelRunner.php:35)
  at Symfony\Component\Runtime\Runner\Symfony\HttpKernelRunner->run()
     (vendor/autoload_runtime.php:29)
  at require_once('/Users/mister.x/Projects/easyAdmin/vendor/autoload_runtime.php')
     (public/index.php:5)

SomeWhere from this:

protected function getRedirectResponseAfterSave(AdminContext $context, string $action): RedirectResponse
    {
        $submitButtonName = $context->getRequest()->request->all()['ea']['newForm']['btn'];

I tried adding this manually, but didn't do anything. The only workaround was removing the form attribute.

|

weaverryan SFCASTS Rudi-T 3 years ago

Hmm, yea, something isn't right. I'm actually a bit confused. Here's what I see:

1) We add a new action called approve.
2) We create a custom template to render this action's button - approve_action.html.twig. This is ONLY responsible for rendering the "Approve" button and shouldn't affect anything else. This is also where your big fix code lives.
3) This new button is surrounded by a form that will submit to the "approve" action.

The confusing part is that, from your stacktrace, the error is coming from the edit action - from after a form submit. What I can't figure out is how the approve_action.html.twig is affecting this. When you click "Approve", it it executing the edit action (and not the approve action)? If so, I'd love to see what the action attribute looks like in the form in your HTML.

Cheers!

|

Ruslan-A 3 years ago

Hi! In this lesson we added the "Approve" button to approve questions by users with ROLE_MODERATOR. But what I have to do if I want to show Boolean Field "isApproved" on index or other pages for users with lower roles, for example, ROLE_ADMIN in read-only status? I want that admins can see, approved this question or no.

If I did for this field ->setPermission('ROLE_ADMIN') - the field become editable, If I did ->setPermission('ROLE_MODERATOR') - the field disappears, function hideOn... or showOn do not give me the desired result too.

Thanks in advance!

|

Victor SFCASTS Ruslan-A 3 years ago edited

Hey Ruslan,

Just add a BooleanField and display it on PAGE_INDEX. You can render that field as a a label, see https://symfony.com/bundles/EasyAdminBundle/current/fields/BooleanField.html#renderasswitch - it will mean that users will only be able to read the value. And I suppose you can just show it to anyone, but keep the security role as ROLE_MODERATOR for editing only.

Cheers!

|

Ruslan-A Victor 3 years ago

Thank you, Viktor. It is not so simple. What, if on PAGE_INDEX this field should stay editable for ROLE_MODERATOR and not editable for ROLE_ADMIN?

|

Victor SFCASTS Ruslan-A 3 years ago edited

Hey Ruslan,

I think it's pretty easy actually... just inject the Security service into your controller's constructor and use it to decide either the field should be rendered as a switch or as a label in the configureFields(). And you can wrap in an if to hide it or make it only readonly on edit page for example.

Cheers!

1 |

Scott-1 4 years ago edited

He there

Is there any other way to get the current entity in configureActions without using

->linkToUrl()
->linkToRoute()
->linkToCrudAction()

The reason i am asking this is because i need a few parameters that is in the entity. I also have a custom template because the call is made by my stimulus controller. The only method i have found now is using callable on one of the link methods:

->linkToUrl(function (Blocks $block) {
    return $block->getUrl();
})

I have tried $this->getContext()->getEntity() but getContext() is null. I'm a bit stuck here, hope you can help.

|

MolloKhan SFCASTS Scott-1 4 years ago edited

Hey Scott S.

You can only get the entity instance on the detail or edit page, so, you have to check that first, then you can get the instance through the AdminContext, or you can do it manually by getting the entityId from the request

Cheers!

|

Fabrice 4 years ago

Hello ! Unfortunately with this kind of action in POST, it causes something bad at the front-end. The action becomes a form as agreed, but it will take up a whole line, and the other actions will be shifted below. See for yourself

https://www.noelshack.com/2...

|

weaverryan SFCASTS Fabrice 4 years ago edited

Hey Fabrice!

Hmm, you might be right! But, where/how are you seeing the icons that you posted? On the "index" page, by default, these should be rendered as a drop-down. And if I call showEntityActionsInlined() to expand them, I still don't see the bad behavior. Is this on some other page?

Cheers!

|

Fabrice weaverryan 4 years ago

Hello! Yes, this is on one of my projects, in which the actions are rendered inlined. So maybe it's no wonder it doesn't do it for you. Yet the method of application is the same.

|

weaverryan SFCASTS Fabrice 4 years ago

Hi!

Yea... that's super weird. I can't explain why your version looks bad but mine does not. But, in theory, it makes sense: a form will often be styled differently (often with display: block) than a normal button, which could cause this. In that case, you'll need to add some custom CSS, likely to set the form to display: inline. I'm doing some guessing, but that's the most likely culprit!

Cheers!

|

This tutorial is built on Symfony 6 but works great on Symfony 7!

EasyAdmin 4 Symfony 6

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=8.2.0",
        "ext-ctype": "*",
        "ext-iconv": "*",
        "composer/package-versions-deprecated": "^1.11", // 1.11.99.4
        "doctrine/doctrine-bundle": "^2.1", // 2.5.5
        "doctrine/doctrine-migrations-bundle": "^3.0", // 3.2.1
        "doctrine/orm": "^2.7", // 2.10.4
        "easycorp/easyadmin-bundle": "^4.0", // v4.0.2
        "handcraftedinthealps/goodby-csv": "^1.4", // 1.4.0
        "knplabs/knp-markdown-bundle": "dev-symfony6", // dev-symfony6
        "knplabs/knp-time-bundle": "^1.11", // 1.17.0
        "sensio/framework-extra-bundle": "^6.0", // v6.2.5
        "stof/doctrine-extensions-bundle": "^1.4", // v1.7.0
        "symfony/asset": "6.0.*", // v6.0.1
        "symfony/console": "6.0.*", // v6.0.2
        "symfony/dotenv": "6.0.*", // v6.0.2
        "symfony/flex": "^2.0.0", // v2.4.5
        "symfony/framework-bundle": "6.0.*", // v6.0.2
        "symfony/mime": "6.0.*", // v6.0.2
        "symfony/monolog-bundle": "^3.0", // v3.7.1
        "symfony/runtime": "6.0.*", // v6.0.0
        "symfony/security-bundle": "6.0.*", // v6.0.2
        "symfony/stopwatch": "6.0.*", // v6.0.0
        "symfony/twig-bundle": "6.0.*", // v6.0.1
        "symfony/ux-chartjs": "^2.0", // v2.0.1
        "symfony/webpack-encore-bundle": "^1.7", // v1.13.2
        "symfony/yaml": "6.0.*", // v6.0.2
        "twig/extra-bundle": "^2.12|^3.0", // v3.3.7
        "twig/twig": "^2.12|^3.0" // v3.3.7
    },
    "require-dev": {
        "doctrine/doctrine-fixtures-bundle": "^3.3", // 3.4.1
        "symfony/debug-bundle": "6.0.*", // v6.0.2
        "symfony/maker-bundle": "^1.15", // v1.36.4
        "symfony/var-dumper": "6.0.*", // v6.0.2
        "symfony/web-profiler-bundle": "6.0.*", // v6.0.2
        "zenstruck/foundry": "^1.1" // v1.16.0
    }
}

Previous Chapter

Next Chapter