[TASK] Streamline return tags in phpdocs
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Form / Select / OptgroupViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Fluid\ViewHelpers\Form\Select;
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 * Adds custom `<optgroup>` tags inside an `<f:form.select>`,
19 * supports further child `<f:form.select.option>` tags.
20 *
21 * @api
22 */
23 class OptgroupViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
24 {
25 /**
26 * @var string
27 */
28 protected $tagName = 'optgroup';
29
30 /**
31 * Initialize additional arguments available for this tag view helper.
32 */
33 public function initializeArguments()
34 {
35 $this->registerUniversalTagAttributes();
36 $this->registerArgument('additionalAttributes', 'array', 'Additional tag attributes. They will be added directly to the resulting HTML tag.');
37 $this->registerArgument('data', 'array', 'Additional data-* attributes. They will each be added with a "data-" prefix.');
38 $this->registerTagAttribute('label', 'string', 'Human-readable label property for the generated optgroup tag');
39 $this->registerTagAttribute('disabled', 'boolean', 'If true, option group is rendered as disabled', false, false);
40 }
41
42 /**
43 * @return string
44 */
45 public function render()
46 {
47 if ($this->arguments['disabled']) {
48 $this->tag->addAttributes('disabled', 'disabled');
49 } else {
50 $this->tag->removeAttribute('disabled');
51 }
52
53 $this->tag->setContent($this->renderChildren());
54 return $this->tag->render();
55 }
56 }