True Custom Action

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

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!

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.

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

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!

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.

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!

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!

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!

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?

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!

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.

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!

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...

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!

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.

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!