Victoire / victoire

Bundle/WidgetBundle/Twig/LinkExtension.php

<?php

namespace Victoire\Bundle\WidgetBundle\Twig;

use Doctrine\ORM\EntityManager;
use Symfony\Bundle\FrameworkBundle\Routing\Router;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Victoire\Bundle\BusinessEntityBundle\Helper\BusinessEntityHelper;
use Victoire\Bundle\BusinessPageBundle\Helper\BusinessPageHelper;
use Victoire\Bundle\CoreBundle\Entity\Link;
use Victoire\Bundle\PageBundle\Helper\PageHelper;
use Victoire\Bundle\ViewReferenceBundle\ViewReference\ViewReference;

/**
 * Twig extension for rendering a link.
 */
class LinkExtension extends \Twig_Extension
{
    protected $router;
    protected $analytics;
    protected $businessEntityHelper; // @victoire_business_page.business_entity_helper
    protected $BusinessPageHelper; // @victoire_business_page.business_page_helper
    protected $pageHelper;
    protected $em; // @doctrine.orm.entity_manager
    protected $abstractBusinessTemplates;

    /**
     * LinkExtension constructor.
     *
     * @param Router       $router
     * @param RequestStack $requestStack
     * @param $analytics
     * @param BusinessEntityHelper $businessEntityHelper
     * @param BusinessPageHelper   $BusinessPageHelper
     * @param PageHelper           $pageHelper
     * @param EntityManager        $em
     * @param array                $abstractBusinessTemplates
     */
    public function __construct(
        Router $router,
        RequestStack $requestStack,
        $analytics,
        BusinessEntityHelper $businessEntityHelper,
        BusinessPageHelper $BusinessPageHelper,
        PageHelper $pageHelper,
        EntityManager $em,
        $abstractBusinessTemplates = []
    ) {
        $this->router = $router;
        $this->request = $requestStack->getCurrentRequest();
        $this->analytics = $analytics;
        $this->businessEntityHelper = $businessEntityHelper;
        $this->BusinessPageHelper = $BusinessPageHelper;
        $this->pageHelper = $pageHelper;
        $this->em = $em;
        $this->abstractBusinessTemplates = $abstractBusinessTemplates;
    }

    /**
     * Returns a list of functions to add to the existing list.
     *
     * @return \Twig_SimpleFunction[] An array of functions
     */
    public function getFunctions()
    {
        return [
            new \Twig_SimpleFunction('vic_link_url', [$this, 'victoireLinkUrl']),
            new \Twig_SimpleFunction('vic_link', [$this, 'victoireLink'], ['is_safe' => ['html']]),
            new \Twig_SimpleFunction('vic_menu_link', [$this, 'victoireMenuLink'], ['is_safe' => ['html']]),
            new \Twig_SimpleFunction('vic_business_link', [$this, 'victoireBusinessLink'], ['is_safe' => ['html']]),
        ];
    }

    /**
     * Generate the complete link (with the a tag).
     *
     * @param array  $parameters   The link parameters (go to LinkTrait to have the list)
     * @param string $avoidRefresh Do we have to refresh or not ?
     * @param array  $url          Fallback url
     *
     * @return string
     */
    public function victoireLinkUrl($parameters, $avoidRefresh = true, $url = '#')
    {
        $referenceType = isset($parameters['referenceType']) ? $parameters['referenceType'] : UrlGeneratorInterface::ABSOLUTE_PATH;

        $viewReference = isset($parameters['viewReference']) ? $parameters['viewReference'] : null;
        switch ($parameters['linkType']) {
            case 'viewReference':
                if ($viewReference instanceof ViewReference) {
                    $viewReference = $viewReference->getId();
                }

                if (!empty($parameters['viewReferencePage'])) {
                    $page = $parameters['viewReferencePage'];
                } else {
                    $page = $this->pageHelper->findPageByParameters([
                        'id'     => $viewReference,
                        'locale' => $parameters['locale'],
                    ]);
                }

                $linkUrl = $this->router->generate(
                    'victoire_core_page_show', [
                        '_locale' => $page->getReference($parameters['locale'])->getLocale(),
                        'url'     => $page->getReference($parameters['locale'])->getUrl(),
                    ],
                    $referenceType
                );
                if ($this->request->getRequestUri() != $linkUrl || !$avoidRefresh) {
                    $url = $linkUrl;
                }
                break;
            case 'route':
                $url = $this->router->generate($parameters['route'], $parameters['routeParameters'], $referenceType);
                break;
            case Link::TYPE_WIDGET:
                $attachedWidget = $parameters[Link::TYPE_WIDGET];
                //fallback when a widget is deleted cascading the relation as null (widget_id = null)
                if ($attachedWidget && method_exists($attachedWidget->getView(), 'getUrl')) {

                    //create base url
                    $url = $this->router->generate('victoire_core_page_show', ['_locale' => $attachedWidget->getView()->getLocale(), 'url' => $attachedWidget->getView()->getUrl()], $referenceType);

                    //If widget in the same view
                    if (rtrim($this->request->getRequestUri(), '/') == rtrim($url, '/')) {
                        $url = '';
                    }
                    //Add anchor part
                    $url .= '#vic-widget-'.$attachedWidget->getId().'-container-anchor';
                }
                break;
            default:
                $url = $parameters['url'];
        }

        return $url;
    }

    /**
     * Generate the complete link (with the a tag).
     *
     * @param array  $parameters The link parameters (go to LinkTrait to have the list)
     * @param string $label      link label
     * @param array  $attr       custom attributes
     *
     * @return string
     */
    public function victoireLink($parameters, $label, $attr = [], $currentClass = 'active', $url = '#')
    {
        $referenceLink = UrlGeneratorInterface::ABSOLUTE_PATH;
        $attachedWidget = isset($parameters[Link::TYPE_WIDGET]) ? $parameters[Link::TYPE_WIDGET] : null;

        if ($parameters['linkType'] == Link::TYPE_WIDGET && $attachedWidget && method_exists($attachedWidget->getView(), 'getUrl')) {
            $viewUrl = $this->router->generate('victoire_core_page_show', ['_locale' => $attachedWidget->getView()->getLocale(), 'url' => $attachedWidget->getView()->getUrl()], $referenceLink);
            if (rtrim($this->request->getRequestUri(), '/') == rtrim($viewUrl, '/')) {
                $attr['data-scroll'] = 'smooth';
            }
        }

        //Avoid to refresh page if not needed
        if ($this->request->getRequestUri() == $this->victoireLinkUrl($parameters, false)) {
            $this->addAttr('class', $currentClass, $attr);
        }

        //Build the target attribute
        if ($parameters['target'] == 'ajax-modal') {
            $attr['data-toggle'] = 'ajax-modal';
        } elseif ($parameters['target'] == '') {
            $attr['target'] = '_parent';
        } else {
            $attr['target'] = $parameters['target'];
        }

        //Add the analytics tracking code attribute
        if (isset($parameters['analyticsTrackCode'])) {
            $this->addAttr('onclick', $parameters['analyticsTrackCode'], $attr);
        }

        $url = $this->victoireLinkUrl($parameters, true, $url);
        //Creates a new twig environment
        $twig = new \Twig_Environment(new \Twig_Loader_Array(['linkTemplate' => '{{ link|raw }}']));

        return $twig->render('linkTemplate', ['link' => '<a href="'.$url.'" '.$this->formatAttributes($attr).'>'.$label.'</a>']);
    }

    /**
     * Generate the complete menu link item (with the li tag).
     *
     * @param array  $parameters The link parameters (go to LinkTrait to have the list)
     * @param string $label      link label
     * @param array  $attr       custom attributes

There is no parameter named $attr. Was it maybe removed?

     *
     * @return string
     */
    public function victoireMenuLink($parameters, $label, $linkAttr = [], $listAttr = [])
    {
        if ($this->request->getRequestUri() == $this->victoireLinkUrl($parameters, false)) {
            $this->addAttr('class', 'active', $listAttr);
        }

        return '<li '.$this->formatAttributes($listAttr).'>'.$this->victoireLink($parameters, $label, $linkAttr, false, '#top').'</li>';
    }

    public function victoireBusinessLink($businessEntityInstance, $templateId = null, $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)
    {
        if (isset($this->abstractBusinessTemplates[$templateId])) {
            $templateId = $this->abstractBusinessTemplates[$templateId];
        }
        if (!$templateId) {
            $templateId = $this->BusinessPageHelper
                ->guessBestPatternIdForEntity(new \ReflectionClass($businessEntityInstance), $businessEntityInstance->getId(), $this->em);
        }

        $page = $this->pageHelper->findPageByParameters([
            'templateId' => $templateId,
            'entityId'   => $businessEntityInstance->getId(),
        ]);

        $parameters = [
            'linkType'        => 'route',
            'route'           => 'victoire_core_page_show',
            'routeParameters' => [
                'url' => $page->getReference()->getUrl(),
                '_locale' => $page->getLocale()

The method getLocale() does not seem to exist on object<Victoire\Bundle\CoreBundle\Entity\View>.

            ],
            'referenceType' => $referenceType,
        ];

        return $this->victoireLinkUrl($parameters);
    }

    /**
     * Add a given attribute to given attributes.
     *
     * @param string $label
     * @param string $value
     * @param array  $attr  The current attributes array
     *
     * @return LinkExtension
     **/
    protected function addAttr($label, $value, &$attr)
    {
        if (!isset($attr[$label])) {
            $attr[$label] = '';
        } else {
            $attr[$label] .= ' ';
        }
        $attr[$label] .= $value;

        return $this;
    }

    /**
     * Returns the name of the extension.
     *
     * @return string The extension name
     */
    public function getName()
    {
        return 'victoire_link_extension';
    }

    private function formatAttributes($attributes)
    {
        array_walk($attributes, function (&$item, $key) {
            if (is_array($item)) {
                $item = implode($item, ' ');
            }
            $item = $key.'="'.$item.'"';
        });

        return implode($attributes, ' ');
    }
}