[Twig] Split SonataAdminExtension

[tambait]

Subject

I am targeting this branch, because BC.

Closes #6639.

Changelog

### Added
- Added `Sonata\AdminBundle\Twig\Extension\SecurityExtension`
- Added `Sonata\AdminBundle\Twig\Extension\CanonicalizeExtension`
- Added `Sonata\AdminBundle\Twig\Extension\XEditableExtension`
- Added `Sonata\AdminBundle\Twig\Extension\RenderElementExtension`
### Deprecated
- Deprecated `SonataAdminExtension::MOMENT_UNSUPPORTED_LOCALES` constant
- Deprecated `SonataAdminExtension::setXEditableTypeMapping()` method
- Deprecated `SonataAdminExtension::getXEditableType()` method
- Deprecated `SonataAdminExtension::getXEditableChoices()` method
- Deprecated `SonataAdminExtension::getCanonicalizedLocaleForMoment()` method
- Deprecated `SonataAdminExtension::getCanonicalizedLocaleForSelect2()` method
- Deprecated `SonataAdminExtension::isGrantedAffirmative()` method
- Deprecated `SonataAdminExtension::renderListElement()` method
- Deprecated `SonataAdminExtension::renderViewElement()` method
- Deprecated `SonataAdminExtension::renderViewElementCompare()` method
- Deprecated `SonataAdminExtension::renderRelationElement()` method
- Deprecated `SonataAdminExtension::getTemplate()` method
- Deprecated `SonataAdminExtension::getTemplateRegistry()` method

[SonataCI]

Could you please rebase your PR and fix merge conflicts?

[VincentLanglet]

@tambait Hi !

Thanks for taking this issue.

Our policy is to do as much as possible on 3.x branch, and in this case you can.

You should

• Add CanonicalizeExtension
• Add SecurityExtension
• Add XEditableExtension
• Deprecate methods on SonataAdminExtension

Then in master we remove the deprecated methods. :)

[SonataCI]

Could you please rebase your PR and fix merge conflicts?

[tambait]

@tambait Hi !

Thanks for taking this issue.

Our policy is to do as much as possible on 3.x branch, and in this case you can.

You should

* Add CanonicalizeExtension

* Add SecurityExtension

* Add XEditableExtension

* Deprecate methods on SonataAdminExtension

Then in master we remove the deprecated methods. :)

Thanks for reminding. I had this morning idea to work/merge on 3.x but diverged from it somehow :)

What about config file, Resources/config/twig.php when it should be modified?

[VincentLanglet]

What about config file, Resources/config/twig.php when it should be modified?

You can declare new extension on 3.x, and add NEXT_MAJOR comment to remove the extra param from the constructor.

[tambait]

@VincentLanglet can you please help with this :)

I have a series of similar errors in tests most pointing to the same lines in SonataAdminExtension. For example,

102) Sonata\AdminBundle\Tests\Twig\Extension\SonataAdminExtensionTest::testRenderListElement with data set
#100 ('<td class="sonata-ba-list-fie...n</td>', 'text', 'A very long string', array(array(10, 'More', 'Less')))
Twig\Error\RuntimeError: An exception has been thrown during the rendering of a template ("Undefined offset: 1").

/sonata/twig-extensions/src/Resources/views/CRUD/base_list_field.html.twig:43
/sonata/twig-extensions/vendor/twig/twig/src/Template.php:367
/sonata/twig-extensions/vendor/twig/twig/src/Template.php:379
/sonata/twig-extensions/vendor/twig/twig/src/TemplateWrapper.php:40
/sonata/twig-extensions/src/Twig/Extension/SonataAdminExtension.php:815
/sonata/twig-extensions/src/Twig/Extension/SonataAdminExtension.php:284
/sonata/twig-extensions/tests/Twig/Extension/SonataAdminExtensionTest.php:428

I initially wasn't sure why this happens because I didn't see that tested metods are calling any of the methods I'm deprecating but then I realized that errors are caused because I've added sonata_deprecation_mute to two filter methods, for example:

getFilters()

   [...]
    //NEXT_MAJOR remove this filter
    new TwigFilter(
        'sonata_xeditable_choices',
        [$this, 'getXEditableChoices']
    ),
    [ ...]

getXEditableChoices method

public function getXEditableChoices(FieldDescriptionInterface $fieldDescription)
{

    if ('sonata_deprecation_mute' !== \func_get_args()[1] ?? null) {
        @trigger_error(sprintf(
            'The %s method is deprecated in favor of XEditableExtension::getXEditableChoices since version 3.x
             and will be removed in 4.0.',
            __METHOD__
        ), E_USER_DEPRECATED);
    }
 [...]
}

Should I remove sonata_deprecation_mute and leave only trigger_error or I shoudl do something else?

[VincentLanglet]

@tambait Didn't read everything but

if ('sonata_deprecation_mute' !== (\func_get_args()[1] ?? null)) {

instead of

if ('sonata_deprecation_mute' !== \func_get_args()[1] ?? null) {

I'll make a review later

[franmomu]

About the constructor, I don't know if we can just make it @internal (since now), do not change it and make the necessary changes in 4.x branch.

One way to avoid BC break I guess would be if the getFunctions(), getFilters(), etc methods from the new extensions return empty arrays and make that SonataAdminExtension delegate to those extensions, something like:

public function isGrantedAffirmative($role, $object = null, $field = null)
{
    if (null === $this->securityExtension) {
        $this->securityExtension = new SecurityExtension($this->securityChecker);
    }
    
    return $this->securityExtension->isGrantedAffirmative($role, $object, $field);
}

[VincentLanglet]

I didn't follow a lot this PR.
Is it ready for review @franmomu @tambait ?

[tambait]

@VincentLanglet

I didn't follow a lot this PR.
Is it ready for review @franmomu @tambait ?

franmomu was doing most of the work in recent period and few days ago he requested a review, so I believe it's ready.

franmomu requested a review from sonata-project/contributors 3 days ago

[franmomu]

I fixed some tests some days ago, now it's rebased and added an upgrade note. I think it's ready for review.

[VincentLanglet]

Is it ok for you @core23 ?

[VincentLanglet]

Thanks @tambait