[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / Core / Widget / WidgetRequest.php
1 <?php
2 namespace TYPO3\CMS\Fluid\Core\Widget;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * Represents a widget request.
19 * @internal It is a purely internal class which should not be used outside of Fluid.
20 */
21 class WidgetRequest extends \TYPO3\CMS\Extbase\Mvc\Web\Request
22 {
23 /**
24 * @var \TYPO3\CMS\Fluid\Core\Widget\WidgetContext
25 */
26 protected $widgetContext;
27
28 /**
29 * @return \TYPO3\CMS\Fluid\Core\Widget\WidgetContext
30 */
31 public function getWidgetContext()
32 {
33 return $this->widgetContext;
34 }
35
36 /**
37 * @param \TYPO3\CMS\Fluid\Core\Widget\WidgetContext $widgetContext
38 */
39 public function setWidgetContext(\TYPO3\CMS\Fluid\Core\Widget\WidgetContext $widgetContext)
40 {
41 $this->widgetContext = $widgetContext;
42 $this->setControllerObjectName($widgetContext->getControllerObjectName());
43 }
44
45 /**
46 * Returns the unique URI namespace for this widget in the format pluginNamespace[widgetIdentifier]
47 *
48 * @return string
49 */
50 public function getArgumentPrefix()
51 {
52 return $this->widgetContext->getParentPluginNamespace() . '[' . $this->widgetContext->getWidgetIdentifier() . ']';
53 }
54 }