Merge pull request #302 from Florian-Merle/feature/twig-extension-link-from-code

feature: add bitbag_cms_render_link_for_code and bitbag_cms_get_link_…

Author: patrick477

doc/pages.md

@@ -29,6 +29,37 @@ Let's assume you associated pages to specific products. You can render them grou
 Twig function. This is where `nameWhenLinked` and `descriptionWhenLinked` fields are used. If you associate pages to 
 specific sections, they will be displayed in columns titled with section name.
 
+### Render link to page from its code
+
+If you want to create a link to a page from its code, you can do either with `bitbag_cms_render_link_for_code` or `bitbag_cms_get_link_for_code` twig functions. These functions will automatically generate a link with the correct locale.
+
+You can define attributes to customize the tag. You can also customize the displayed name (by default the function will try to display the name when linked, if it is not defined, it will fallback to the page name).
+
+If you only need the link, you can use `bitbag_cms_get_link_for_code`.
+
+You can display a message if the page wasn't found with the `notFoundMessage` option.
+
+```twig
+{{ bitbag_cms_render_link_for_code('code') }}
+{{ bitbag_cms_render_link_for_code('code', { attr: { class: 'ui button' }, name: 'Custom name' }) }}
+{{ bitbag_cms_render_link_for_code('code', {}, 'custom/template.html.twig') }}
+{{ bitbag_cms_get_link_for_code('code') }}
+{{ bitbag_cms_render_link_for_code('wrong-code', { notFoundMessage: 'Page not found' }) }}
+{{ bitbag_cms_get_link_for_code('wrong-code', { notFoundMessage: 'Page not found' }) }}
+
+```
+
+Will render:
+
+```html
+<a href="/{_locale}/pages/{slug}">Name when linked</a>
+<a href="/{_locale}/pages/{slug}" class="ui button">Custom name</a>
+<!-- depends on custom/template.html.twig -->
+/{_locale}/pages/{slug}
+Page not found
+Page not found
+```
+
 ## Customization
 
 If you don't know how to override templates yet, 

src/Resources/config/services/twig.yml

@@ -2,6 +2,7 @@ parameters:
     bitbag_cms.twig.admin_functions:
         - bitbag_cms_render_block
         - bitbag_cms_render_media
+    bitbag_cms.twig.link_template: "@@BitBagSyliusCmsPlugin/Page/link.html.twig"
 
 services:
     bitbag_sylius_cms_plugin.twig.extension.block:
@@ -42,3 +43,13 @@ services:
         arguments:
             - "@twig"
             - "%bitbag_cms.twig.admin_functions%"
+
+    bitbag_sylius_cms_plugin.twig.extension.render_link:
+        class: BitBag\SyliusCmsPlugin\Twig\Extension\RenderLinkExtension
+        arguments:
+            - "@sylius.context.locale"
+            - "@bitbag_sylius_cms_plugin.repository.page"
+            - "@router.default"
+            - "%bitbag_cms.twig.link_template%"
+        tags:
+            - { name: twig.extension }

src/Resources/views/Page/link.html.twig

@@ -0,0 +1,13 @@
+{% if page != null %}
+    <a href="{{ path('bitbag_sylius_cms_plugin_shop_page_show', { slug: page.slug }) }}"
+       {% if options.attr is defined %}
+            {% for attrname, attrvalue in options.attr %}
+                {{ attrname }}="{{ attrvalue }}"
+            {% endfor %}
+        {% endif %}
+    >
+        {{ options.name|default(page.nameWhenLinked)|default(page.name) }}
+    </a>
+{% else %}
+    {{ options.notFoundMessage|default('') }}
+{% endif %}

src/Twig/Extension/RenderLinkExtension.php

@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * Created by Florian Merle - Dedi Agency <florian.merle@dedi-agency.com> <florian.david.merle@gmail.com>
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusCmsPlugin\Twig\Extension;
+
+use BitBag\SyliusCmsPlugin\Repository\PageRepositoryInterface;
+use Sylius\Component\Locale\Context\LocaleContextInterface;
+use Symfony\Component\Routing\RouterInterface;
+
+class RenderLinkExtension extends \Twig_Extension
+{
+    /** @var LocaleContextInterface */
+    private $localeContext;
+
+    /** @var PageRepositoryInterface */
+    private $pageRepository;
+
+    /** @var RouterInterface */
+    private $router;
+
+    /** @var string */
+    private $defaultTemplate;
+
+    public function __construct(
+        LocaleContextInterface $localeContext,
+        PageRepositoryInterface $pageRepository,
+        RouterInterface $router,
+        string $defaultTemplate
+    ) {
+        $this->localeContext = $localeContext;
+        $this->pageRepository = $pageRepository;
+        $this->router = $router;
+        $this->defaultTemplate = $defaultTemplate;
+    }
+
+    public function getFunctions()
+    {
+        return [
+            new \Twig_Function('bitbag_cms_render_link_for_code', [$this, 'renderLinkForCode'], [
+                'needs_environment' => true,
+                'is_safe' => ['html']
+            ]),
+            new \Twig_Function('bitbag_cms_get_link_for_code', [$this, 'getLinkForCode']),
+        ];
+    }
+
+    public function renderLinkForCode(
+        \Twig_Environment $environment,
+        string $code,
+        array $options = [],
+        ?string $template = null
+    ): string {
+        $page = $this->pageRepository->findOneEnabledByCode($code, $this->localeContext->getLocaleCode());
+
+        return $environment->render($template ?? $this->defaultTemplate, [
+            'page' => $page,
+            'options' => $options,
+        ]);
+    }
+
+    public function getLinkForCode(
+        string $code,
+        array $options = []
+    ): string {
+        $page = $this->pageRepository->findOneEnabledByCode($code, $this->localeContext->getLocaleCode());
+        if (!$page) {
+            return isset($options['notFoundMessage']) ? $options['notFoundMessage'] : '';
+        }
+
+        return $this->router->generate('bitbag_sylius_cms_plugin_shop_page_show', ['slug' => $page->getSlug()]);
+    }
+}