Fix TemplateRegistry usages #6387

wbloszyk · 2020-09-14T09:15:01Z

Subject

Based on #6383 (comment) I made some research and I found what can be improve.

service: admin_code // Admin object
service admin_code.template_registry // TemplateRegistry object dedicated for specify Admin

It mean We should be able to get TemplateRegistry object directly from admin, becouse we can get it from container.

I also remove some unnecessary NEXT_MAJOR

I am targeting this branch, because this change respect BC.

Changelog

### Added
- `Sonata\AdminBundle\Admin\AbstractAdmin::hasTemplateRegistry(): bool`
### Deprecated
- `Sonata\AdminBundle\Admin\AbstractAdmin::setTemplates()`
- `Sonata\AdminBundle\Admin\AbstractAdmin::setTemplate()`

src/Admin/AbstractAdmin.php

jordisala1991 · 2020-09-14T12:45:53Z

This should probably be done on master to avoid BC breaks

wbloszyk · 2020-09-14T12:59:36Z

@jordisala1991

change protected to public in getTemplateRegistry() is BC becouse it is final
throw LogicException is BC too becouse otherwise error You cannot call ... on null will be throw

I think I should revert NEXT_MAJOR. Someone can override getTemplate method.

src/Admin/AbstractAdmin.php

wbloszyk · 2020-09-14T16:45:21Z

@core23 Can we merge it?

src/Admin/AbstractAdmin.php

wbloszyk · 2020-09-14T17:37:15Z

@phansys Sorry for another request for review. I click it before icon refresh. :)

franmomu · 2020-09-14T17:49:14Z

If the plan is to call getTemplateRegistry from the CRUDController shouldn't be added to the AdminInterface?

src/Admin/AdminInterface.php

phansys · 2020-09-14T20:25:32Z

src/Admin/AbstractAdmin.php

    {
-        return $query;
+        return $this->templateRegistry instanceof MutableTemplateRegistryInterface;


Is there any constraint requiring setTemplate() or setTemplates() to be defined? If not, I think we should use TemplateRegistryInterface instead of MutableTemplateRegistryInterface.

In 3.x branch:

public function setTemplates(array $templates) { // NEXT_MAJOR: Remove this line $this->templates = $templates; $this->getTemplateRegistry()->setTemplates($templates); }

I understand that's the case for 3.x, but then we should add a NEXT_MAJOR comment explaining how to proceed in the next major release.
The changes at AdminInterface should refer to TemplateRegistryInterface, right?

$admin->getTemplateRegistry() should be equal to admin_code.template_registry service. It is created on:

final class TemplateRegistry implements MutableTemplateRegistryInterface

So MutableTemplateRegistryInterface will be correct.

IMO we should check against null.

Checking will be add in master. We can't throw exeption becouse someone compare getTemplateRegistry() to null. What we can do in 3.x is only add custom description for $this->getTemplateRegistry()->setTemplates($templates); exception.

I mean: return $this->... !== null

I think @phansys is right, there is no need to return MutableTemplateRegistryInterface if we are not using setTemplates or setTemplate.

@franmomu #6387 (comment)

Update src/Admin/AbstractAdmin.php Co-authored-by: Javier Spagnoletti <[email protected]> Update src/Admin/AbstractAdmin.php Co-authored-by: Javier Spagnoletti <[email protected]> Update src/Admin/AbstractAdmin.php Co-authored-by: Javier Spagnoletti <[email protected]>

core23 · 2020-09-15T06:59:14Z

src/Admin/AdminInterface.php

+ * @method array                            configureActionButtons(string $action, ?object $object = null)
+ * @method string                           getSearchResultLink(object $object)
+ * @method void                             showMosaicButton(bool $isShown)
+ * @method bool                             isDefaultFilter(string $name)                                         // NEXT_MAJOR: Remove this


Not related to this PR, but we can remove this line

To many change on this PR. Lets do it in another PR. Mybe we should create "Clean up" PR? 😅

@phansys

@phansys sugestion is made and accepted by @jordisala1991.

franmomu · 2020-09-15T08:06:27Z

src/Admin/AbstractAdmin.php

    }

-    protected function configureQuery(ProxyQueryInterface $query): ProxyQueryInterface
+    final public function hasTemplateRegistry(): bool


Is this method used outside the AbstractAdmin? If so, should be added to the interface?

It is new method, so it is not used for now. IMO all setTemplateRegistry, getTemplateRegistry and hasTemplateRegistry should be add to seperate TemplateRegistryOwnerInterface. AdminInterface should inplemented it.

…()` and `setTemplates()` in `AbstractAdmin` PR sonata-project#6387 deprecates methods `AbstractAdmin::setTemplate()` and `AbstractAdmin::setTemplates()`, but the documentation still recommends to use them. These calls were updated in order to use the template registry services.

wbloszyk mentioned this pull request Sep 14, 2020

DI in CrudController and make CRUDController a service #6383

Closed

wbloszyk requested a review from a team September 14, 2020 09:17

core23 previously requested changes Sep 14, 2020

View reviewed changes

src/Admin/AbstractAdmin.php Show resolved Hide resolved

src/Admin/AbstractAdmin.php Show resolved Hide resolved

wbloszyk force-pushed the fix_template_registry branch from a19f538 to cf2b06c Compare September 14, 2020 10:48

wbloszyk requested review from core23, VincentLanglet and a team September 14, 2020 10:54

wbloszyk force-pushed the fix_template_registry branch from cf2b06c to c42767a Compare September 14, 2020 12:59

wbloszyk requested a review from jordisala1991 September 14, 2020 13:27

jordisala1991 reviewed Sep 14, 2020

View reviewed changes

src/Admin/AbstractAdmin.php Outdated Show resolved Hide resolved

wbloszyk force-pushed the fix_template_registry branch from c42767a to 9cc0d9f Compare September 14, 2020 14:49

wbloszyk requested a review from jordisala1991 September 14, 2020 14:50

jordisala1991 reviewed Sep 14, 2020

View reviewed changes

src/Admin/AbstractAdmin.php Outdated Show resolved Hide resolved

wbloszyk force-pushed the fix_template_registry branch from 9cc0d9f to ced1804 Compare September 14, 2020 16:30

wbloszyk requested a review from jordisala1991 September 14, 2020 16:31

jordisala1991 previously approved these changes Sep 14, 2020

View reviewed changes

phansys requested changes Sep 14, 2020

View reviewed changes

src/Admin/AbstractAdmin.php Outdated Show resolved Hide resolved

src/Admin/AbstractAdmin.php Outdated Show resolved Hide resolved

wbloszyk dismissed jordisala1991’s stale review via da3f61f September 14, 2020 17:27

wbloszyk force-pushed the fix_template_registry branch from 9561893 to c255ef3 Compare September 14, 2020 17:28

wbloszyk requested review from jordisala1991 and phansys September 14, 2020 17:29

phansys reviewed Sep 14, 2020

View reviewed changes

src/Admin/AbstractAdmin.php Outdated Show resolved Hide resolved

wbloszyk force-pushed the fix_template_registry branch from b37989a to 0bbfc79 Compare September 14, 2020 17:34

phansys approved these changes Sep 14, 2020

View reviewed changes

wbloszyk requested a review from phansys September 14, 2020 17:35

phansys previously approved these changes Sep 14, 2020

View reviewed changes

wbloszyk dismissed phansys’s stale review via c61566f September 14, 2020 18:04

wbloszyk force-pushed the fix_template_registry branch from 0bbfc79 to c61566f Compare September 14, 2020 18:04

wbloszyk requested a review from phansys September 14, 2020 18:04

phansys previously requested changes Sep 14, 2020

View reviewed changes

src/Admin/AdminInterface.php Outdated Show resolved Hide resolved

wbloszyk force-pushed the fix_template_registry branch from c61566f to d796b42 Compare September 14, 2020 18:17

wbloszyk requested a review from phansys September 14, 2020 18:17

phansys reviewed Sep 14, 2020

View reviewed changes

wbloszyk requested a review from phansys September 14, 2020 20:49

wbloszyk force-pushed the fix_template_registry branch from d796b42 to 4313bfc Compare September 14, 2020 22:02

jordisala1991 approved these changes Sep 15, 2020

View reviewed changes

core23 reviewed Sep 15, 2020

View reviewed changes

wbloszyk requested a review from core23 September 15, 2020 07:34

wbloszyk mentioned this pull request Sep 15, 2020

Manual merge #6389

Merged

wbloszyk merged commit 00bf1d6 into sonata-project:3.x Sep 15, 2020

wbloszyk deleted the fix_template_registry branch September 15, 2020 07:48

franmomu reviewed Sep 15, 2020

View reviewed changes

phansys mentioned this pull request Oct 24, 2020

Update docs in order to avoid calling deprecated methods setTemplate() and setTemplates() in AbstractAdmin #6538

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix TemplateRegistry usages #6387

Fix TemplateRegistry usages #6387

wbloszyk commented Sep 14, 2020 •

edited

Loading

jordisala1991 commented Sep 14, 2020

wbloszyk commented Sep 14, 2020

wbloszyk commented Sep 14, 2020

wbloszyk commented Sep 14, 2020

franmomu commented Sep 14, 2020

phansys Sep 14, 2020

wbloszyk Sep 14, 2020

phansys Sep 14, 2020

wbloszyk Sep 14, 2020 •

edited

Loading

jordisala1991 Sep 14, 2020

wbloszyk Sep 14, 2020

jordisala1991 Sep 14, 2020

wbloszyk Sep 14, 2020

franmomu Sep 15, 2020

wbloszyk Sep 15, 2020

core23 Sep 15, 2020

wbloszyk Sep 15, 2020

franmomu Sep 15, 2020

wbloszyk Sep 15, 2020

Fix TemplateRegistry usages #6387

Fix TemplateRegistry usages #6387

Conversation

wbloszyk commented Sep 14, 2020 • edited Loading

Subject

Changelog

jordisala1991 commented Sep 14, 2020

wbloszyk commented Sep 14, 2020

wbloszyk commented Sep 14, 2020

wbloszyk commented Sep 14, 2020

franmomu commented Sep 14, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wbloszyk Sep 14, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wbloszyk commented Sep 14, 2020 •

edited

Loading

wbloszyk Sep 14, 2020 •

edited

Loading