src/Twig/TwigExtension.php line 164

Open in your IDE?
  1. <?php
  3. namespace App\Twig;
  5. use App\Entity\HtmlBlocks;
  6. use App\Entity\Locales;
  7. use App\Entity\Setting;
  8. use App\Service\SimpleCache;
  9. use Doctrine\Persistence\ManagerRegistry;
  10. use Twig\Environment;
  11. use Twig\Extension\AbstractExtension;
  12. use Twig\TwigFilter;
  13. use Twig\TwigFunction;
  15. class TwigExtension extends AbstractExtension
  16. {
  17.     private ?\Symfony\Component\DependencyInjection\ContainerInterface $container = null;
  19.     public function __construct(private readonly \App\Service\ImageCacheService $imageCacheService, private readonly \Symfony\Component\HttpKernel\KernelInterface $kernel, private readonly \Symfony\Component\Routing\RouterInterface $router, private readonly ManagerRegistry $doctrine, private readonly \Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface $authorizationChecker, private readonly \Symfony\Component\HttpFoundation\RequestStack $requestStack, private readonly \App\Service\ServiceController $serviceController, private readonly SimpleCache $cache, private $projectRoot)
  20.     {
  21.         $this->container = $this->kernel->getContainer();
  22.     }
  24.     public function getName()
  25.     {
  26.         return 'twig_extension';
  27.     }
  29.     #[\Override]
  30.     public function getFilters()
  31.     {
  32.         return [
  33.             new TwigFilter('cacheBust', fn ($asset) => $this->cacheBust($asset)),
  34.             new TwigFilter('html_entity_decode', fn ($string) => html_entity_decode($string)),
  35.         ];
  36.     }
  38.     #[\Override]
  39.     public function getFunctions()
  40.     {
  41.         return [
  42.             new TwigFunction('renderComponents', fn ($positionId, $pageComponents) => $this->renderComponents($positionId, $pageComponents)),
  43.             new TwigFunction('removeBracesFromSlug', fn ($string) => $this->removeBracesFromSlug($string)),
  44.             new TwigFunction('generatePath', fn ($request, $pageID, $parametersArray = []) => $this->generatePath($request, $pageID, $parametersArray)),
  45.             new TwigFunction('imageCache', fn ($pathtofile, $filter, $width = 0, $height = 0, $background = 'transparent') => $this->imageCache($pathtofile, $filter, $width, $height, $background)),
  46.             new TwigFunction('fetchLocales', fn () => $this->fetchLocales()),
  47.             new TwigFunction('breadcrumbs', function ($pageEntity = null, $currentUrl = null) {
  48.                 $this->breadcrumbs($pageEntity, $currentUrl);
  49.             }),
  50.             new TwigFunction('renderHtmlBlock', $this->renderHtmlBlock(...), ['needs_environment' => true]),
  51.             new TwigFunction('allowInlineEditor', fn ($entity, $field) => $this->allowInlineEditor($entity, $field)),
  52.             new TwigFunction('showAdminControlLinks', fn ($entity, $route) => $this->showAdminControlLinks($entity, $route)),
  53.             new TwigFunction('moneyFormat', fn ($number) => $this->moneyFormat($number)),
  54.             new TwigFunction('domCheckIgnore', fn ($value) => $this->domCheckIgnore($value)),
  55.             new TwigFunction('componentEntities', fn ($pageComponents, $entityName = null, $field = null) => $this->componentEntities($pageComponents, $entityName, $field)),
  56.             new TwigFunction('componentEntity', fn ($pageComponents, $field = null) => $this->componentEntity($pageComponents, $field)),
  57.             new TwigFunction('replaceIfComponentDataExists', fn ($pageComponents, $field = null, $fallback = null) => $this->replaceIfComponentDataExists($pageComponents, $field, $fallback)),
  58.             new TwigFunction('forceRenderHtmlBlock', fn ($identifier) => $this->forceRenderHtmlBlock($identifier)),
  59.             new TwigFunction('renderSetting', fn ($id, $field) => $this->renderSetting($id, $field), ['is_safe' => ['html']]),
  60.         ];
  61.     }
  63.     public function renderSetting($id, $field)
  64.     {
  65.         /** @var array $setting */
  66.         $setting = $this->doctrine->getRepository(Setting::class)->findActiveSetting($id);
  68.         if (!$setting) {
  69.             return '';
  70.         }
  72.         if (!array_key_exists($field, $setting)) {
  73.             return '';
  74.         }
  76.         return nl2br((string) $setting[$field]);
  77.     }
  79.     // fetch field from selected entity from a page component - use if you have multiple components on the same page
  80.     public function componentEntities($pageComponents, $entityName = null, $field = null)
  81.     {
  82.         $component = [];
  83.         $checkfield = substr((string) $field, 0, 3);
  84.         if ('get' != $checkfield) {
  85.             $field = 'get'.ucwords((string) $field);
  86.         }
  87.         if (isset($component['urlKey'])) {
  88.             foreach ($pageComponents as $component) {
  89.                 if (strtolower((string) $component['urlKey']) === strtolower((string) $entityName) && method_exists($component['entity'], $field)) {
  90.                     return call_user_func([$component['entity'], $field]);
  91.                 }
  92.             }
  93.         }
  94.     }
  96.     // fetch field from url component - only if using a url based component
  97.     public function componentEntity($pageComponents, $field = null)
  98.     {
  99.         $checkfield = substr((string) $field, 0, 3);
  100.         if ('get' != $checkfield) {
  101.             $field = 'get'.ucwords((string) $field);
  102.         }
  104.         // ADDED AS VAR WAS MISSING _ CW
  105.         $entityName = '';
  106.         foreach ($pageComponents as $component) {
  107.             if (isset($component['urlKey']) && strtolower((string) $component['urlKey']) === strtolower($entityName) && method_exists($component['entity'], $field)) {
  108.                 return call_user_func([$component['entity'], $field]);
  109.             }
  110.         }
  111.     }
  113.     // Simlar to the above 'componentEntity' function except you can use a fallback string
  114.     // This was intented to be used as an alternative to an if statement
  115.     public function replaceIfComponentDataExists($pageComponents, $field = null, $fallback = null)
  116.     {
  117.         $data = null;
  118.         $checkfield = substr((string) $field, 0, 3);
  119.         if ('get' != $checkfield) {
  120.             $field = 'get'.ucwords((string) $field);
  121.         }
  122.         foreach ($pageComponents as $component) {
  123.             if ((isset($component['urlKey']) && null != $component['urlKey']) && null != $component['data'] && method_exists($component['entity'], $field)) {
  124.                 $data = call_user_func([$component['entity'], $field]);
  125.             }
  126.         }
  128.         if (null == $data) {
  129.             return $fallback;
  130.         }
  132.         return $data;
  133.     }
  135.     public function moneyFormat($number)
  136.     {
  137.         return number_format($number, 2, ',', '.');
  138.     }
  140.     // fix for the domcrawler (which gathers component positions on the add/edit page controller )
  141.     // used to ignore app.request or app.user twig functions - wasn't an issue on my testing machine but did effect TREV
  142.     public function domCheckIgnore($value)
  143.     {
  144.         if (is_array($value)) {
  145.             return null;
  146.         }
  148.         return $value;
  149.     }
  151.     // fetch image or generate new depending on parameter provided - this function may get overriden by the App/Twig/AdminTwigExtension
  152.     public function imageCache($pathtofile, $filter, $width = 0, $height = 0, $background = 'transparent')
  153.     {
  154.         echo $this->imageCacheService->imageCache($pathtofile, $filter, $width, $height, $background);
  155.     }
  157.     // generate page url which translates to the current locale
  158.     // get all slugs stored in the array cache to generate the path
  159.     // example : <a href="{{generatePath( app.request, 7, {'blog_category': post.category.slug, 'blog_post_slug': post.slug}  )}}">
  160.     public function generatePath($request, $pageID, $parametersArray = [])
  161.     {
  162.         $locale = $request->getLocale();
  163.         $session = $request->getSession();
  164.         $localePages = $session->get('localePages');
  165.         $not_found = [];
  167.         $slugCache = $this->cache->get('slugCache');
  169.         if (null == $slugCache) { // prevents error in page admin ( dom crawer issue with app.request )
  170.             return false;
  171.         }
  173.         foreach (unserialize($slugCache) as $page) {
  174.             if ($page['id'] == $pageID) {
  175.                 $finalUrl = $page['slug'];
  176.                 $confirmedPagePieces = explode('/', (string) $page['slug']);
  177.                 foreach ($parametersArray as $key => $parameter) {
  178.                     $slugCheck = str_replace(' ', '', (string) $key);
  179.                     $slugKey = array_search('{'.$slugCheck.'}', $confirmedPagePieces);
  180.                     if (!is_numeric($slugKey)) {
  181.                         $not_found[$key] = $parameter;
  182.                     } else {
  183.                         $finalUrl = str_replace('{'.$slugCheck.'}', $parameter, (string) $finalUrl);
  184.                     }
  185.                 }
  187.                 $getparams = '';
  188.                 if (count($not_found) > 0) {
  189.                     $getparams = '?';
  190.                     foreach ($not_found as $extraParam => $extraParamValue) {
  191.                         $getparams .= $extraParam.'='.$extraParamValue.'&';
  192.                     }
  193.                     $getparams = rtrim($getparams, '&');
  194.                 }
  196.                 return '/'.str_replace('//', '/', $finalUrl.$getparams);
  197.             }
  198.         }
  200.         $getparams = '';
  201.         if (count($not_found) > 0) {
  202.             $getparams = '?path=notfound&';
  203.             foreach ($not_found as $extraParam => $extraParamValue) {
  204.                 $getparams .= $extraParam.'='.$extraParamValue.'&';
  205.             }
  206.             $getparams = rtrim($getparams, '&');
  207.         }
  209.         return '#'.$getparams;
  210.     }
  212.     // used to tidy page {slugs}
  213.     public function removeBracesFromSlug($string)
  214.     {
  215.         return preg_replace('#{[\s\S]+?}#', '', (string) $string);
  216.     }
  218.     // Inserts the relevant component into the page template
  219.     // Also assists the new/edit page component selector (domcrawler picks up on the domcheck attribute)
  220.     public function renderComponents($positionId, $pageComponents)
  221.     {
  222.         if ($pageComponents) {
  223.             if ('domcheck' == $pageComponents[0]['position']) {
  224.                 echo "<div data-cms='domcheck'>".$positionId.'</div>';
  225.             }
  227.             foreach ($pageComponents as $component) {
  228.                 if ($component['position'] == $positionId && array_key_exists('data', $component)) {
  229.                     return $component['data'];
  230.                 }
  231.             }
  232.         }
  233.     }
  235.     // Inserts the relevant htmlblock into the page template
  236.     // Also assists the new/edit page component selector (domcrawler picks up on the domcheck attribute)
  237.     public function renderHtmlBlock(Environment $environment, $positionId, $pageHtmlblocks, $page = null)
  238.     {
  239.         if ($pageHtmlblocks) {
  240.             if ('domcheck' == $pageHtmlblocks[0]['position']) {
  241.                 echo "<div data-cms='domcheckhtml'>".$positionId.'</div>';
  242.             }
  244.             foreach ($pageHtmlblocks as $block) {
  245.                 $block['page'] = $page ?? null;
  246.                 if ($block['position'] == $positionId && array_key_exists('data', $block)) {
  247.                     if ($this->authorizationChecker->isGranted('ROLE_PAGE_EDITOR')) {
  248.                         return $this->getInlineEditorHTML(HtmlBlocks::class, 'html', $block['data'], $block['blockId'], 'HtmlBlock');
  249.                     }
  251.                     return $environment->render('@theme/common/htmlblock.html.twig', ['block' => $block]);
  252.                 }
  253.             }
  254.         }
  255.     }
  257.     // Inserts the relevant htmlblock into the page template
  258.     // This function is not used tied to the CMS - renders same block on every page
  259.     public function forceRenderHtmlBlock($identifier)
  260.     {
  261.         if ($identifier) {
  262.             $block = $this->doctrine->getRepository(HtmlBlocks::class)->findOneBy(['title' => $identifier, 'deleted' => false, 'active' => true]);
  264.             if (null !== $block) {
  265.                 if ($this->authorizationChecker->isGranted('ROLE_PAGE_EDITOR')) {
  266.                     return $this->getInlineEditorHTML(HtmlBlocks::class, 'html', $block->getHtml(), $block->getId(), 'HtmlBlock');
  267.                 }
  269.                 return $block->getHtml();
  270.             }
  271.         }
  272.     }
  274.     public function allowInlineEditor($entity, $field)
  275.     {
  276.         $namespaceMeta = $this->serviceController->getBundleNameFromEntity($entity, $field);
  277.         $getterMethod = 'get'.ucwords((string) $field);
  278.         $editText = $entity->{$getterMethod}();
  280.         if ('' == $editText) {
  281.             $editText = '&nbsp;';
  282.             // return null;
  283.         }
  285.         $request = $this->requestStack->getCurrentRequest();
  286.         // $request = $this->container->get('request');
  287.         if ($request->query->has('preview')) {
  288.             return $editText;
  289.         }
  291.         if ($this->authorizationChecker->isGranted('ROLE_PAGE_EDITOR')) {
  292.             return $this->getInlineEditorHTML($namespaceMeta['full'], $field, $editText, $entity->getId(), $namespaceMeta['short'], $namespaceMeta['fieldmeta']);
  293.         }
  295.         return $editText;
  296.     }
  298.     public function showAdminControlLinks($entity, $route)
  299.     {
  300.         $namespaceMeta = $this->serviceController->getBundleNameFromEntity($entity);
  302.         $url = $this->router->generate($route, ['id' => $entity->getId()]);
  304.         if ($this->authorizationChecker->isGranted('ROLE_ADMIN')) {
  305.             $buttons = "<div class='adminControlButtons'>";
  306.             $buttons .= "    <div class='inlineEditorToolboxContainer'>Admin Control (".$namespaceMeta['short'].')</div>';
  307.             $buttons .= "    <div class='inlineEditorToolboxLink'><a href='".$url."' data-toggle='tooltip' title='View/Edit' ><span class='glyphicon glyphicon-pencil'></span>&nbsp;View/Edit</a></div>";
  308.             $buttons .= '</div>';
  310.             return $buttons;
  311.         }
  312.     }
  314.     public function getInlineEditorHTML($namespace, $field, $content, $id, $entityname = null, $fieldmeta = null)
  315.     {
  316.         // show inline editor
  317.         $request = $this->requestStack->getCurrentRequest();
  318.         $locale = $request->getLocale();
  319.         $showFullEditor = 1;
  320.         if (null != $fieldmeta && 'string' == $fieldmeta['type']) {
  321.             $showFullEditor = 0;
  322.         }
  323.         // Redactor required uniqueIDs - classes conflicted if multiple editors were used
  324.         $uniqueID = substr(md5(random_int(1, 9999)), 0, 7);
  325.         $editor = "<div class='inlineEditorContainer'>";
  326.         $editor .= "    <div id='inlineEditor-message-".$uniqueID."' class='inlineEditorToolboxContainer'>Editable (".$entityname.':'.$field.')</div>';
  327.         $editor .= "    <div class='inlineEditorToolboxSave'><a data-toggle='tooltip' title='Save Text' id='btn-save-".$uniqueID."' style='display:none'><span class='glyphicon glyphicon-floppy-disk'></span>&nbsp;Save</a></div>";
  328.         // $editor .= "    <div class='inlineEditorToolboxClose'><a data-toggle='tooltip' title='Close Editor' id='btn-cancel-".$uniqueID."' style='display:none'><span class='glyphicon glyphicon-remove-sign'></span></a></div>";
  330.         $editor .= "    <div class='inlineEditor' data-fulleditor='".$showFullEditor."' id='".$uniqueID."' data-entitynamespace='".$namespace."'  data-entityfield='".$field."' data-id='".$id."' data-locale='".$locale."' >";
  331.         if (0 == $showFullEditor) {
  332.             $editor .= '<p>';
  333.         }
  334.         $editor .= $content;
  335.         if (0 == $showFullEditor) {
  336.             $editor .= '</p>';
  337.         }
  338.         $editor .= '    </div>';
  340.         // if($showFullEditor ==1){
  341.         //     $editor .= "    <textarea class='inlineEditor' data-fulleditor='".$showFullEditor."' id='".$uniqueID."' data-entitynamespace='".$namespace."'  data-entityfield='".$field."' data-id='".$id."' data-locale='".$locale."' >";
  342.         //     $editor .= $content;
  343.         //     $editor .= "    </textarea>";
  344.         // }else{
  345.         //     $editor .= "    <input type='text' class='inlineEditor' data-fulleditor='".$showFullEditor."' value='".$content."' id='".$uniqueID."' data-entitynamespace='".$namespace."'  data-entityfield='".$field."' data-id='".$id."' data-locale='".$locale."' />";
  346.         // }
  348.         $editor .= '</div>';
  350.         return $editor;
  351.     }
  353.     // simple function to fetch all locales
  354.     // done this way to ensure locale switch buttons work on non cms pages
  355.     public function fetchLocales()
  356.     {
  357.         return $this->doctrine->getRepository(Locales::class)->findBy(['active' => true]);
  358.     }
  360.     public function breadcrumbs($pageEntity = null, $currentUrl = null)
  361.     {
  362.         // // this function generates a full url category path
  364.         // $currentUrl = $this->container->get('request')->getUri();
  366.         if (null != $pageEntity && null != $currentUrl) {
  367.             $exploded = explode('/', (string) $currentUrl);
  368.             unset($exploded[0]);
  369.             $exploded = array_values($exploded);
  371.             $structure = [];
  372.             $explodedCount = count($exploded);
  373.             for ($i = 0; $i < $explodedCount; ++$i) {
  374.                 if (array_key_exists($i - 1, $structure)) {
  375.                     $structure[$i] = $structure[$i - 1]['url'].'/'.$exploded[$i];
  376.                 } else {
  377.                     $structure[$i] = '/'.$exploded[$i];
  378.                 }
  380.                 $url = array_key_exists($i - 1, $structure) ? $structure[$i - 1]['url'].'/'.$exploded[$i] : '/'.$exploded[$i];
  382.                 $structure[$i] = ['url' => $url, 'title' => $exploded[$i]];
  383.             }
  384.             // print_r($structure);
  385.             $seperater = ' > ';
  386.             $html = '<div class="breadcrumb">';
  387.             $html .= '<span><a href="/">Home</a>'.$seperater.'</span>';
  388.             $count = 0;
  389.             foreach ($structure as $item) {
  390.                 ++$count;
  391.                 if (count($structure) == $count) {
  392.                     $seperater = '';
  393.                 }
  394.                 $html .= '<span><a href="'.$item['url'].'">'.str_replace('-', ' ', ucfirst($item['title'])).'</a>'.$seperater.'</span>';
  395.             }
  396.             $html .= '</div>';
  398.             echo $html;
  399.         }
  400.     }
  402.     // simple function to pluralise text string (adds 's' if array count >1 )
  403.     public function pluralize($text, $array, $plural_version = null)
  404.     {
  405.         return (is_countable($array) ? count($array) : 0) > 1 ? ($plural_version ?: $text.'s') : $text;
  406.     }
  408.     // simple word limiter function
  409.     public function wordLimiter($str, $limit = 30)
  410.     {
  411.         $words = explode(' ', strip_tags((string) $str));
  412.         if ($words > $limit) {
  413.             return implode(' ', array_splice($words, 0, $limit)).'...';
  414.         }
  416.         return $str;
  417.     }
  419.     /**
  420.      * Cache bust specified asset.
  421.      */
  422.     public function cacheBust(mixed $asset)
  423.     {
  424.         $asset = '/'.ltrim((string) $asset, '/');
  425.         $assetPath = sprintf('%s/../public/%s', $this->projectRoot, $asset);
  426.         // If we are assuming a CSS or JS file exists when it doesn't,
  427.         // we probably need to know about it.
  428.         if (!file_exists($assetPath)) {
  429.             throw new \RuntimeException(sprintf('Asset: %s is missing!', $asset));
  430.         }
  431.         $modified = filemtime($assetPath);
  433.         return $asset.sprintf('?version=%d', $modified);
  434.     }
  435. }