Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
[TASK] Improve IconViewHelper documentation
Add missing documentation to IconViewHelper and extend some of the
already existing argument descriptions.

Resolves: #90859
Releases: master, 9.5
Change-Id: Id681f796e94db5b5bc0727a4a68dd19fecf8af77
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/63910
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Daniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: Daniel Goerz <daniel.goerz@posteo.de>
  • Loading branch information
IndyIndyIndy authored and ervaude committed Mar 27, 2020
1 parent 567f38e commit e8596f5
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions typo3/sysext/core/Classes/ViewHelpers/IconViewHelper.php
Expand Up @@ -68,11 +68,11 @@ class IconViewHelper extends AbstractViewHelper
*/
public function initializeArguments()
{
$this->registerArgument('identifier', 'string', 'the table for the record icon', true);
$this->registerArgument('size', 'string', 'the icon size', false, Icon::SIZE_SMALL);
$this->registerArgument('overlay', 'string', '', false, null);
$this->registerArgument('state', 'string', '', false, IconState::STATE_DEFAULT);
$this->registerArgument('alternativeMarkupIdentifier', 'string', '', false, null);
$this->registerArgument('identifier', 'string', 'Identifier of the icon as registered in the Icon Registry.', true);
$this->registerArgument('size', 'string', 'Desired size of the icon. All values of the Icons.sizes enum are allowed, these are: "small", "default", "large" and "overlay".', false, Icon::SIZE_SMALL);
$this->registerArgument('overlay', 'string', 'Identifier of an overlay icon as registered in the Icon Registry.', false, null);
$this->registerArgument('state', 'string', 'Sets the state of the icon. All values of the Icons.states enum are allowed, these are: "default" and "disabled".', false, IconState::STATE_DEFAULT);
$this->registerArgument('alternativeMarkupIdentifier', 'string', 'Alternative icon identifier. Takes precedence over the identifier if supported by the IconProvider.', false, null);
}

/**
Expand Down

0 comments on commit e8596f5

Please sign in to comment.