ccc21150ef40cd5afe478ecd0c1748be1ea197a8
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Be / Buttons / ShortcutViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons;
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 * *
12 * This script is distributed in the hope that it will be useful, but *
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- *
14 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser *
15 * General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU Lesser General Public *
18 * License along with the script. *
19 * If not, see http://www.gnu.org/licenses/lgpl.html *
20 * *
21 * The TYPO3 project - inspiring people to share! *
22 * */
23 /**
24 * View helper which returns shortcut button with icon
25 * Note: This view helper is experimental!
26 *
27 * = Examples =
28 *
29 * <code title="Default">
30 * <f:be.buttons.shortcut />
31 * </code>
32 * <output>
33 * Shortcut button as known from the TYPO3 backend.
34 * By default the current page id, module name and all module arguments will be stored
35 * </output>
36 *
37 * <code title="Explicitly set parameters to be stored in the shortcut">
38 * <f:be.buttons.shortcut getVars="{0: 'M', 1: 'myOwnPrefix'}" setVars="{0: 'function'}" />
39 * </code>
40 * <output>
41 * Shortcut button as known from the TYPO3 backend.
42 * This time only the specified GET parameters and SET[]-settings will be stored.
43 * Note:
44 * Normally you won't need to set getVars & setVars parameters in Extbase modules
45 * </output>
46 */
47 class ShortcutViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper {
48
49 /**
50 * Renders a shortcut button as known from the TYPO3 backend
51 *
52 * @param array $getVars list of GET variables to store. By default the current id, module and all module arguments will be stored
53 * @param array $setVars list of SET[] variables to store. See template::makeShortcutIcon(). Normally won't be used by Extbase modules
54 * @return string the rendered shortcut button
55 * @see template::makeShortcutIcon()
56 */
57 public function render(array $getVars = array(), array $setVars = array()) {
58 $enableBookmarks = $GLOBALS['BE_USER']->getTSConfigVal('options.enableBookmarks');
59
60 if ($enableBookmarks) {
61 $doc = $this->getDocInstance();
62 $currentRequest = $this->controllerContext->getRequest();
63 $extensionName = $currentRequest->getControllerExtensionName();
64 $moduleName = $currentRequest->getPluginName();
65 if (count($getVars) === 0) {
66 $modulePrefix = strtolower('tx_' . $extensionName . '_' . $moduleName);
67 $getVars = array('id', 'M', $modulePrefix);
68 }
69 $getList = implode(',', $getVars);
70 $setList = implode(',', $setVars);
71 return $doc->makeShortcutIcon($getList, $setList, $moduleName);
72 }
73 return '';
74
75 }
76 }