Add TemplateRegistryAwareInterface #6390

wbloszyk · 2020-09-15T08:50:58Z

Subject

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

Changelog

### Added
-  `Sonata\AdminBundle\Templating\TemplateRegistryAwareInterface` with `getTemplateRegistry()`, `hasTemplateRegistry()` and `setTemplateRegistry()` methods

OskarStark · 2020-09-15T12:42:40Z

src/Admin/AbstractAdmin.php

-     * @return MutableTemplateRegistryInterface
-     */
-    final public function getTemplateRegistry()
+    final public function getTemplateRegistry(): ?MutableTemplateRegistryInterface


Why it can return null?

I can in 3.x.

It won't in master. A next major would be needed indeed.

OskarStark · 2020-09-15T12:43:01Z

src/Templating/TemplateRegistryOwnerInterface.php

+interface TemplateRegistryOwnerInterface
+{
+    // NEXT_MAJOR: uncomment this method in 4.0
+    //public function getTemplateRegistry(): MutableTemplateRegistryInterface;


And here it cannot?

OskarStark · 2020-09-15T12:43:13Z

src/Admin/AbstractAdmin.php

@@ -1353,7 +1353,7 @@ public function generateMenuUrl($name, array $parameters = [], $referenceType =
        return $this->routeGenerator->generateMenuUrl($this, $name, $parameters, $referenceType);
    }

-    final public function setTemplateRegistry(MutableTemplateRegistryInterface $templateRegistry)
+    final public function setTemplateRegistry(MutableTemplateRegistryInterface $templateRegistry): void


Imo this is a BC break

phansys · 2020-09-17T12:14:27Z

Other packages use the term "aware" instead "owner" for cases like this (ContainerAwareInterface, LoggerAwareInterface, etc).
IMO, based on that premise, we should rename this interface to TemplateRegistryAwareInterface.

VincentLanglet · 2020-09-18T07:45:59Z

@wbloszyk Please wait for multiple approval before merging (generally 2 is fine).
And if possible, it's generally better to not merge our own PR. ;)

wbloszyk · 2020-09-18T07:54:31Z

I ask about merge on slack. I prefer 1 approve per refactoring PR and 2+ for new feature.

VincentLanglet · 2020-09-18T08:12:42Z

src/Templating/TemplateRegistryAwareInterface.php

+namespace Sonata\AdminBundle\Templating;
+
+/**
+ * /**


Typo in comment

VincentLanglet · 2020-09-18T08:13:24Z

I ask about merge on slack. I prefer 1 approve per refactoring PR and 2+ for new feature.

It's a team project. And people can't be connected every day.

greg0ire · 2020-09-18T17:24:49Z

Also, it's open-source software… there are a loooooot more users than a company project.

wbloszyk requested a review from a team September 15, 2020 08:53

OskarStark reviewed Sep 15, 2020

View reviewed changes

wbloszyk requested review from VincentLanglet and OskarStark September 15, 2020 12:54

Add TemplateRegistryAwareInterface

4b0d16b

wbloszyk force-pushed the add_template_reg_interface branch from 1b49dbf to 4b0d16b Compare September 17, 2020 14:28

wbloszyk changed the title ~~Add TemplateRegistryOwnerInterface~~ Add TemplateRegistryAwareInterface Sep 17, 2020

wbloszyk requested review from a team and core23 September 17, 2020 14:31

VincentLanglet approved these changes Sep 18, 2020

View reviewed changes

wbloszyk merged commit a00155f into sonata-project:3.x Sep 18, 2020

wbloszyk deleted the add_template_reg_interface branch September 18, 2020 06:51

VincentLanglet reviewed Sep 18, 2020

View reviewed changes

src/Templating/TemplateRegistryAwareInterface.php

namespace Sonata\AdminBundle\Templating;

/**

* /**

Copy link

Member

VincentLanglet Sep 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in comment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add TemplateRegistryAwareInterface #6390

Add TemplateRegistryAwareInterface #6390

wbloszyk commented Sep 15, 2020 •

edited

Loading

OskarStark Sep 15, 2020

VincentLanglet Sep 15, 2020

OskarStark Sep 15, 2020

OskarStark Sep 15, 2020

VincentLanglet Sep 15, 2020

phansys commented Sep 17, 2020

VincentLanglet commented Sep 18, 2020

wbloszyk commented Sep 18, 2020

VincentLanglet Sep 18, 2020

VincentLanglet commented Sep 18, 2020

greg0ire commented Sep 18, 2020

Add TemplateRegistryAwareInterface #6390

Add TemplateRegistryAwareInterface #6390

Conversation

wbloszyk commented Sep 15, 2020 • edited Loading

Subject

Changelog

OskarStark Sep 15, 2020

Choose a reason for hiding this comment

VincentLanglet Sep 15, 2020

Choose a reason for hiding this comment

OskarStark Sep 15, 2020

Choose a reason for hiding this comment

OskarStark Sep 15, 2020

Choose a reason for hiding this comment

VincentLanglet Sep 15, 2020

Choose a reason for hiding this comment

phansys commented Sep 17, 2020

VincentLanglet commented Sep 18, 2020

wbloszyk commented Sep 18, 2020

VincentLanglet Sep 18, 2020

Choose a reason for hiding this comment

VincentLanglet commented Sep 18, 2020

greg0ire commented Sep 18, 2020

wbloszyk commented Sep 15, 2020 •

edited

Loading