EZP-29848: Make existing AdminUI tabs extendable by allowing template path and parameters change #728
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * @copyright Copyright (C) eZ Systems AS. All rights reserved. | ||
| * @license For full copyright and license information view LICENSE file distributed with this source code. | ||
| */ | ||
| declare(strict_types=1); | ||
|
|
||
| namespace EzSystems\EzPlatformAdminUi\Tab; | ||
|
|
||
| use EzSystems\EzPlatformAdminUi\Tab\Event\TabViewRenderEvent; | ||
| use EzSystems\EzPlatformAdminUi\Tab\Event\TabEvents; | ||
| use Symfony\Component\EventDispatcher\EventDispatcherInterface; | ||
| use Symfony\Component\Translation\TranslatorInterface; | ||
| use Twig\Environment; | ||
|
|
||
| /** | ||
| * Base class representing Tab using EventDisaptcher for extensibility. | ||
| * | ||
| * It extends AbstractTab by adding Event Dispatching before rendering view. | ||
| */ | ||
| abstract class AbstractEventDispatchingTab extends AbstractTab | ||
| { | ||
| /** @var \Symfony\Component\EventDispatcher\EventDispatcherInterface */ | ||
| protected $eventDispatcher; | ||
|
|
||
| /** | ||
| * @param \Twig\Environment $twig | ||
| * @param \Symfony\Component\Translation\TranslatorInterface $translator | ||
| * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher | ||
| */ | ||
| public function __construct( | ||
| Environment $twig, | ||
| TranslatorInterface $translator, | ||
| EventDispatcherInterface $eventDispatcher | ||
| ) { | ||
| parent::__construct($twig, $translator); | ||
|
|
||
| $this->eventDispatcher = $eventDispatcher; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function renderView(array $parameters): string | ||
| { | ||
| $event = new TabViewRenderEvent( | ||
| $this->getIdentifier(), | ||
| $this->getTemplate(), | ||
| $this->getTemplateParameters($parameters) | ||
| ); | ||
| $this->eventDispatcher->dispatch(TabEvents::TAB_RENDER, $event); | ||
|
|
||
| return $this->twig->render( | ||
| $event->getTemplate(), | ||
| $event->getParameters() | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| */ | ||
| abstract public function getTemplate(): string; | ||
|
|
||
| /** | ||
| * @param mixed[] $contextParameters | ||
| * | ||
| * @return mixed[] | ||
| */ | ||
| abstract public function getTemplateParameters(array $contextParameters = []): array; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * @copyright Copyright (C) eZ Systems AS. All rights reserved. | ||
| * @license For full copyright and license information view LICENSE file distributed with this source code. | ||
| */ | ||
| declare(strict_types=1); | ||
|
|
||
| namespace EzSystems\EzPlatformAdminUi\Tab\Event; | ||
|
|
||
| use Symfony\Component\EventDispatcher\Event; | ||
|
|
||
| class TabViewRenderEvent extends Event | ||
| { | ||
| /** @var string */ | ||
| private $tabIdentifier; | ||
|
|
||
| /** @var string */ | ||
| private $template; | ||
|
|
||
| /** @var array */ | ||
| private $parameters; | ||
|
|
||
| /** | ||
| * @param string $tabIdentifier | ||
| * @param string $template | ||
| * @param array $parameters | ||
| */ | ||
| public function __construct(string $tabIdentifier, string $template, array $parameters = []) | ||
| { | ||
| $this->tabIdentifier = $tabIdentifier; | ||
| $this->template = $template; | ||
| $this->parameters = $parameters; | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| */ | ||
| public function getTabIdentifier(): string | ||
| { | ||
| return $this->tabIdentifier; | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| */ | ||
| public function getTemplate(): string | ||
| { | ||
| return $this->template; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $template | ||
| */ | ||
| public function setTemplate(string $template): void | ||
| { | ||
| $this->template = $template; | ||
| } | ||
|
|
||
| /** | ||
| * @return array | ||
| */ | ||
| public function getParameters(): array | ||
| { | ||
| return $this->parameters; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $parameters | ||
| */ | ||
| public function setParameters(array $parameters): void | ||
| { | ||
| $this->parameters = $parameters; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review note: Same as below.