From 471c7574dac9d1dd52262bffff03bb70bae26f18 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20E=C3=9Fl?= <indy.essl@gmail.com>
Date: Fri, 27 Mar 2020 14:48:16 +0100
Subject: [PATCH] [TASK] Improve IconViewHelper documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
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/+/63955
Tested-by: Susanne Moog <look@susi.dev>
Tested-by: Daniel Goerz <daniel.goerz@posteo.de>
Tested-by: Frank Nägler <frank.naegler@typo3.org>
Tested-by: TYPO3com <noreply@typo3.com>
Reviewed-by: Susanne Moog <look@susi.dev>
Reviewed-by: Daniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: Frank Nägler <frank.naegler@typo3.org>
---
.../sysext/core/Classes/ViewHelpers/IconViewHelper.php | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/typo3/sysext/core/Classes/ViewHelpers/IconViewHelper.php b/typo3/sysext/core/Classes/ViewHelpers/IconViewHelper.php
index 1f45a55e7ad8..dd6bfba63149 100644
--- a/typo3/sysext/core/Classes/ViewHelpers/IconViewHelper.php
+++ b/typo3/sysext/core/Classes/ViewHelpers/IconViewHelper.php
@@ -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);
}
/**
--
GitLab