forked from Logicify/mautic-advanced-templates-bundle
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implemented twig content loader to watch dynamic content
- Loading branch information
Dmitry Berezovsky
committed
Nov 7, 2018
1 parent
aad028a
commit e2b8bd6
Showing
4 changed files
with
196 additions
and
10 deletions.
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,170 @@ | ||
| <?php | ||
|
|
||
| namespace MauticPlugin\MauticAdvancedTemplatesBundle\Helper; | ||
|
|
||
| use Mautic\CoreBundle\Factory\ModelFactory; | ||
| use Mautic\DynamicContentBundle\Entity\DynamicContent; | ||
| use Mautic\DynamicContentBundle\Helper\DynamicContentHelper; | ||
| use Psr\Log\LoggerInterface; | ||
| use Twig_Error_Loader; | ||
| use Twig_Source; | ||
|
|
||
| class Twig_Loader_DynamicContent implements \Twig_LoaderInterface, \Twig_ExistsLoaderInterface, \Twig_SourceContextLoaderInterface | ||
| { | ||
| private static $NAME_PREFIX = 'dc:'; | ||
|
|
||
| /** | ||
| * @var ModelFactory | ||
| */ | ||
| private $modelFactory; | ||
| /** | ||
| * @var LoggerInterface | ||
| */ | ||
| protected $logger; | ||
| /** | ||
| * @var DynamicContentHelper | ||
| */ | ||
| private $dynamicContentHelper; | ||
|
|
||
| /** | ||
| * Twig_Loader_DynamicContent constructor. | ||
| * @param LoggerInterface $logger | ||
| * @param ModelFactory $modelFactory | ||
| * @param DynamicContentHelper $dynamicContentHelper | ||
| */ | ||
| public function __construct(LoggerInterface $logger, ModelFactory $modelFactory, DynamicContentHelper $dynamicContentHelper) | ||
| { | ||
| $this->modelFactory = $modelFactory; | ||
| $this->logger = $logger; | ||
| $this->dynamicContentHelper = $dynamicContentHelper; | ||
| $logger->debug('Twig_Loader_DynamicContent: created $twigDynamicContentLoader'); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Gets the source code of a template, given its name. | ||
| * | ||
| * @param string $name The name of the template to load | ||
| * | ||
| * @return string The template source code | ||
| * | ||
| * @throws Twig_Error_Loader When $name is not found | ||
| * | ||
| * @deprecated since 1.27 (to be removed in 2.0), implement Twig_SourceContextLoaderInterface | ||
| */ | ||
| public function getSource($name) | ||
| { | ||
| @trigger_error(sprintf('Calling "getSource" on "%s" is deprecated since 1.27. Use getSourceContext() instead.', get_class($this)), E_USER_DEPRECATED); | ||
| return $this->getSourceContext($name)->getCode(); | ||
| } | ||
|
|
||
| /** | ||
| * Gets the cache key to use for the cache for a given template name. | ||
| * | ||
| * @param string $name The name of the template to load | ||
| * | ||
| * @return string The cache key | ||
| * | ||
| * @throws Twig_Error_Loader When $name is not found | ||
| */ | ||
| public function getCacheKey($name) | ||
| { | ||
| return $name; | ||
| } | ||
|
|
||
| /** | ||
| * Returns true if the template is still fresh. | ||
| * | ||
| * @param string $name The template name | ||
| * @param int $time Timestamp of the last modification time of the | ||
| * cached template | ||
| * | ||
| * @return bool true if the template is fresh, false otherwise | ||
| * | ||
| * @throws Twig_Error_Loader When $name is not found | ||
| */ | ||
| public function isFresh($name, $time) | ||
| { | ||
| // TODO: Implement isFresh() method. | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the source context for a given template logical name. | ||
| * | ||
| * @param string $name The template logical name | ||
| * | ||
| * @return Twig_Source | ||
| * | ||
| * @throws Twig_Error_Loader When $name is not found | ||
| */ | ||
| public function getSourceContext($name) | ||
| { | ||
| $dynamicContent = $this->findTemplate($this->aliasForTemplateName($name)); | ||
| if ($dynamicContent == null) { | ||
| throw new Twig_Error_Loader('Template ' . $name . ' does not exist'); | ||
| } | ||
| return new Twig_Source($dynamicContent->getContent(), $name); | ||
|
|
||
| } | ||
|
|
||
| private function aliasForTemplateName($name) | ||
| { | ||
| return str_replace(Twig_Loader_DynamicContent::$NAME_PREFIX, '', $name); | ||
| } | ||
|
|
||
| /** | ||
| * @param $resourceAlias | ||
| * @return null|DynamicContent | ||
| */ | ||
| private function findTemplate($resourceAlias) | ||
| { | ||
| $model = $this->modelFactory->getModel('dynamicContent'); | ||
| $this->logger->debug('Twig_Loader_DynamicContent: Loading dynamic content by alias: ' . $resourceAlias); | ||
| $result = $model->getEntities( | ||
| [ | ||
| 'filter' => [ | ||
| 'where' => [ | ||
| [ | ||
| 'col' => 'e.name', | ||
| 'expr' => 'eq', | ||
| 'val' => $resourceAlias, | ||
| ], | ||
| [ | ||
| 'col' => 'e.isPublished', | ||
| 'expr' => 'eq', | ||
| 'val' => 1, | ||
| ] | ||
| ] | ||
| ], | ||
| 'ignore_paginator' => true, | ||
| ]); | ||
|
|
||
| if (count($result) === 0) { | ||
| return null; | ||
| } | ||
| return $result[1]; // Strange, but result is in the element 1 not 0... | ||
| } | ||
|
|
||
| /** | ||
| * Check if we have the source code of a template, given its name. | ||
| * | ||
| * @param string $name The name of the template to check if we can load | ||
| * | ||
| * @return bool If the template source code is handled by this loader or not | ||
| */ | ||
| public function exists($name) | ||
| { | ||
| $this->logger->debug('Twig_Loader_DynamicContent: EXISTS called for ' . $name); | ||
| return $this->supports($name) && $this->findTemplate($this->aliasForTemplateName($name)) !== null; | ||
| } | ||
|
|
||
| /** | ||
| * @param $name | ||
| * @return bool | ||
| */ | ||
| public function supports($name) | ||
| { | ||
| return strpos($name, Twig_Loader_DynamicContent::$NAME_PREFIX) === 0; | ||
| } | ||
| } |