Inital commit

local/modules/TheliaSmarty/Template/Plugins/FlashMessage.php

@@ -0,0 +1,155 @@
+<?php
+/*************************************************************************************/
+/*      This file is part of the Thelia package.                                     */
+/*                                                                                   */
+/*      Copyright (c) OpenStudio                                                     */
+/*      email : dev@thelia.net                                                       */
+/*      web : http://www.thelia.net                                                  */
+/*                                                                                   */
+/*      For the full copyright and license information, please view the LICENSE.txt  */
+/*      file that was distributed with this source code.                             */
+/*************************************************************************************/
+
+namespace TheliaSmarty\Template\Plugins;
+
+use Symfony\Component\HttpFoundation\RequestStack;
+use Thelia\Core\HttpFoundation\Session\Session;
+use Thelia\Core\Template\Element\FlashMessage as FlashMessageBag;
+use TheliaSmarty\Template\AbstractSmartyPlugin;
+use TheliaSmarty\Template\SmartyPluginDescriptor;
+use Thelia\Core\Translation\Translator;
+
+/**
+ * Plugin for smarty defining blocks allowing to get flash message
+ * A flash message is a variable, array, object stored in session under the flashMessage key
+ * ex $SESSION['flashMessage']['myType']
+ *
+ * blocks :
+ *
+ * ```
+ * {flash type="myType"}
+ *     <div class="alert alert-success">{$MESSAGE}</div>
+ * {/flash}
+ * ```
+ * Class Form
+ *
+ * @package Thelia\Core\Template\Smarty\Plugins
+ * @author  Guillaume MOREL <gmorel@openstudio.fr>
+ * @author  Julien Chanséaume <jchanseaume@openstudio.fr>
+ */
+class FlashMessage extends AbstractSmartyPlugin
+{
+    /** @var RequestStack Request service */
+    protected $requestStack;
+
+    /** @var FlashMessageBag $results */
+    protected $results;
+
+    /** @var Translator */
+    protected $translator;
+
+    public function __construct(RequestStack $requestStack, Translator $translator)
+    {
+        $this->requestStack = $requestStack;
+        $this->translator = $translator;
+    }
+
+    /**
+     * Process the count function: executes a loop and return the number of items found
+     *
+     * @param array $params parameters array
+     * @param \Smarty_Internal_Template $template
+     *
+     * @return int                       the item count
+     * @throws \InvalidArgumentException if a parameter is missing
+     *
+     */
+    public function hasFlashMessage(
+        $params,
+        /** @noinspection PhpUnusedParameterInspection */
+        $template
+    ) {
+        $type = $this->getParam($params, 'type', null);
+
+        if (null == $type) {
+            throw new \InvalidArgumentException(
+                $this->translator->trans("Missing 'type' parameter in {hasflash} function arguments")
+            );
+        }
+
+        return $this->getSession()->getFlashBag()->has($type);
+    }
+
+    /**
+     * Get FlashMessage
+     * And clean session from this key
+     *
+     * @param array $params Block parameters
+     * @param mixed $content Block content
+     * @param \Smarty_Internal_Template $template Template
+     * @param bool $repeat Control how many times
+     *                                            the block is displayed
+     *
+     * @return mixed
+     */
+    public function getFlashMessage($params, $content, \Smarty_Internal_Template $template, &$repeat)
+    {
+        $type = $this->getParam($params, 'type', false);
+
+        if (null === $content) {
+            $this->results = new FlashMessageBag();
+
+            if (false === $type) {
+                $this->results->addAll($this->getSession()->getFlashBag()->all());
+            } else {
+                $this->results->add(
+                    $type,
+                    $this->getSession()->getFlashBag()->get($type, [])
+                );
+            }
+
+            if ($this->results->isEmpty()) {
+                $repeat = false;
+            }
+        } else {
+            $this->results->next();
+        }
+
+        if ($this->results->valid()) {
+            $message = $this->results->current();
+            $template->assign("TYPE", $message["type"]);
+            $template->assign("MESSAGE", $message["message"]);
+
+            $repeat = true;
+        }
+
+        if ($content !== null) {
+            if ($this->results->isEmpty()) {
+                $content = "";
+            }
+
+            return $content;
+        }
+
+        return '';
+    }
+
+    /**
+     * @return array an array of SmartyPluginDescriptor
+     */
+    public function getPluginDescriptors()
+    {
+        return [
+            new SmartyPluginDescriptor("function", "hasflash", $this, "hasFlashMessage"),
+            new SmartyPluginDescriptor("block", "flash", $this, "getFlashMessage")
+        ];
+    }
+
+    /**
+     * @return Session
+     */
+    protected function getSession()
+    {
+        return $this->requestStack->getCurrentRequest()->getSession();
+    }
+}