[TASK] Sync CMS Fluid with Flow Fluid 1.1 (part1)
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / Core / ViewHelper / Facets / PostParseInterface.php
1 <?php
2 namespace TYPO3\CMS\Fluid\Core\ViewHelper\Facets;
3
4 /* *
5 * This script is backported from the TYPO3 Flow package "TYPO3.Fluid". *
6 * *
7 * It is free software; you can redistribute it and/or modify it under *
8 * the terms of the GNU Lesser General Public License, either version 3 *
9 * of the License, or (at your option) any later version. *
10 * *
11 * The TYPO3 project - inspiring people to share! *
12 * */
13
14 /**
15 * Post Parse Facet. Your view helper should implement this if you want a callback
16 * to be called directly after the syntax tree node corresponding to this view
17 * helper has been built.
18 *
19 * In the callback, it is possible to store some variables inside the
20 * parseVariableContainer (which is different from the runtime variable container!).
21 * This implicates that you usually have to adjust the \TYPO3\CMS\Fluid\View\TemplateView
22 * in case you implement this facet.
23 *
24 * Normally, this facet is not needed, except in really really rare cases.
25 */
26 interface PostParseInterface {
27
28 /**
29 * Callback which is called directly after the corresponding syntax tree
30 * node to this view helper has been built.
31 * This is a parse-time callback, which does not change the rendering of a
32 * view helper.
33 *
34 * You can store some data inside the variableContainer given here, which
35 * can be used f.e. inside the TemplateView.
36 *
37 * @param \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $syntaxTreeNode The current node in the syntax tree corresponding to this view helper.
38 * @param array $viewHelperArguments View helper arguments as an array of SyntaxTrees. If you really need an argument, make sure to call $viewHelperArguments[$argName]->render(...)!
39 * @param \TYPO3\CMS\Fluid\Core\ViewHelper\TemplateVariableContainer $variableContainer Variable container you can use to pass on some variables to the view.
40 * @return void
41 */
42 static public function postParseEvent(\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $syntaxTreeNode, array $viewHelperArguments, \TYPO3\CMS\Fluid\Core\ViewHelper\TemplateVariableContainer $variableContainer);
43
44 }
45
46 ?>