Merge pull request #3625 from ostark/redirect

Idea: Allow error/notice message with the redirect tag
craftcms · Jan 15, 2019 · 0869136 · 0869136
2 parents 25566f7 + b2d5dae
commit 0869136
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 1 deletion.
diff --git a/CHANGELOG-v3.1.md b/CHANGELOG-v3.1.md
@@ -107,6 +107,7 @@
 - The `app/migrate` web action now applies pending `project.yaml` changes, if the `useProjectConfigFile` config setting is enabled.
 - The `svg()` function now strips `<title>`, `<desc>`, and comments from the SVG document as part of its sanitization process.
 - The `svg()` function now supports a `class` argument, which will add a class name to the root `<svg>` node. ([#3174](https://github.com/craftcms/cms/issues/3174))
+- The `{% redirect %}` tag now supports `with notice` and `with error` params for setting flash messages. ([#3625](https://github.com/craftcms/cms/pull/3625))
 - `info` buttons can now also have a `warning` class.
 - User permission definitions can now include `info` and/or `warning` keys.
 - The old “Administrate users” permission has been renamed to “Moderate users”.

diff --git a/docs/dev/tags/redirect.md b/docs/dev/tags/redirect.md
@@ -25,3 +25,13 @@ You can customize which status code accompanies your redirect response by typing
 ```twig
 {% redirect "pricing" 301 %}
 ```
+
+### Flash Messages
+
+You can optionally set flash messages that will show up for the user on the next request using the `with notice` and/or `with error` params:
+
+```twig
+{% if not currentUser.isInGroup('members') %}
+    {% redirect "pricing" 301 with notice "You have to be a member to access that!" %}
+{% endif %}
+```
diff --git a/src/web/twig/nodes/RedirectNode.php b/src/web/twig/nodes/RedirectNode.php
@@ -25,8 +25,23 @@ class RedirectNode extends \Twig_Node
      */
     public function compile(\Twig_Compiler $compiler)
     {
+        $compiler->addDebugInfo($this);
+
+        if ($this->hasNode('error')) {
+            $compiler
+                ->write('\Craft::$app->getSession()->setError(')
+                ->subcompile($this->getNode('error'))
+                ->raw(");\n");
+        }
+
+        if ($this->hasNode('notice')) {
+            $compiler
+                ->write('\Craft::$app->getSession()->setNotice(')
+                ->subcompile($this->getNode('notice'))
+                ->raw(");\n");
+        }
+
         $compiler
-            ->addDebugInfo($this)
             ->write('\Craft::$app->getResponse()->redirect(' . UrlHelper::class . '::url(')
             ->subcompile($this->getNode('path'))
             ->raw('), ')

diff --git a/src/web/twig/tokenparsers/RedirectTokenParser.php b/src/web/twig/tokenparsers/RedirectTokenParser.php
@@ -37,6 +37,13 @@ public function parse(\Twig_Token $token)
             $nodes['httpStatusCode'] = new \Twig_Node_Expression_Constant(302, 1);
         }
 
+        // Parse flash message(s)
+        while ($stream->test(\Twig_Token::NAME_TYPE, 'with')) {
+            $stream->next();
+            $type = $stream->expect(\Twig_Token::NAME_TYPE, ['notice', 'error'])->getValue();
+            $nodes[$type] = $this->parser->getExpressionParser()->parseExpression();
+        }
+
         $this->parser->getStream()->expect(\Twig_Token::BLOCK_END_TYPE);
 
         return new RedirectNode($nodes, [], $lineno, $this->getTag());