[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Form / PasswordViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
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 * View Helper which creates a simple Password Text Box (<input type="password">).
19 *
20 * = Examples =
21 *
22 * <code title="Example">
23 * <f:form.password name="myPassword" />
24 * </code>
25 * <output>
26 * <input type="password" name="myPassword" value="default value" />
27 * </output>
28 */
29 class PasswordViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
30 {
31 /**
32 * @var string
33 */
34 protected $tagName = 'input';
35
36 /**
37 * Initialize the arguments.
38 */
39 public function initializeArguments()
40 {
41 parent::initializeArguments();
42 $this->registerTagAttribute(
43 'disabled',
44 'string',
45 'Specifies that the input element should be disabled when the page loads'
46 );
47 $this->registerTagAttribute(
48 'maxlength',
49 'int',
50 'The maxlength attribute of the input field (will not be validated)'
51 );
52 $this->registerTagAttribute('placeholder', 'string', 'The placeholder of the textfield');
53 $this->registerTagAttribute('readonly', 'string', 'The readonly attribute of the input field');
54 $this->registerTagAttribute('size', 'int', 'The size of the input field');
55 $this->registerArgument(
56 'errorClass',
57 'string',
58 'CSS class to set if there are errors for this view helper',
59 false,
60 'f3-form-error'
61 );
62 $this->registerUniversalTagAttributes();
63 }
64
65 /**
66 * Renders the password input field.
67 *
68 * @return string
69 */
70 public function render()
71 {
72 $name = $this->getName();
73 $this->registerFieldNameForFormTokenGeneration($name);
74 $this->setRespectSubmittedDataValue(true);
75
76 $this->tag->addAttribute('type', 'password');
77 $this->tag->addAttribute('name', $name);
78 $this->tag->addAttribute('value', $this->getValueAttribute());
79
80 $this->addAdditionalIdentityPropertiesIfNeeded();
81 $this->setErrorClassAttribute();
82
83 return $this->tag->render();
84 }
85 }