Skip to content

Commit

Permalink
[TASK] Remove superfluous doc comments in ViewHelpers
Browse files Browse the repository at this point in the history
Refs #1044
  • Loading branch information
derhansen committed Oct 23, 2022
1 parent fdd23c0 commit 3d3bdab
Show file tree
Hide file tree
Showing 17 changed files with 10 additions and 48 deletions.
3 changes: 0 additions & 3 deletions Classes/ViewHelpers/AbstractPrefillViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ abstract class AbstractPrefillViewHelper extends AbstractViewHelper
{
/**
* Returns the current plugin namespace
*
* @param Request $request
* @return string
*/
protected function getPluginNamespace(Request $request): string
{
Expand Down
4 changes: 0 additions & 4 deletions Classes/ViewHelpers/Be/BackendUserViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,7 @@ public function initializeArguments(): void
}

/**
* @param array $arguments
* @param \Closure $renderChildrenClosure
* @param RenderingContextInterface $renderingContext
* @return array|false|mixed
* @throws \Doctrine\DBAL\Driver\Exception
*/
public static function renderStatic(
array $arguments,
Expand Down
3 changes: 0 additions & 3 deletions Classes/ViewHelpers/Be/IsActionEnabledViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@ public function render(): bool

/**
* Checks, if the current backend user has sufficient table permissions to perform the given action
*
* @param string $action
* @return bool
*/
private function checkAccess(string $action): bool
{
Expand Down
6 changes: 0 additions & 6 deletions Classes/ViewHelpers/Category/CountViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,6 @@ public function initializeArguments(): void
$this->registerArgument('categoryUid', 'int', 'Uid of the category', true);
}

/**
* @param array $arguments
* @param \Closure $renderChildrenClosure
* @param RenderingContextInterface $renderingContext
* @return int
*/
public static function renderStatic(
array $arguments,
\Closure $renderChildrenClosure,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ public function initializeArguments(): void
* of remaining free places.
*
* The returned array index starts at 1 if at least one registration is possible
*
* @return array
*/
public function render(): array
{
Expand Down
1 change: 0 additions & 1 deletion Classes/ViewHelpers/Format/ICalendarDateViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ public function initializeArguments(): void
* Formats the given date according to rfc5545
*
* @see http://tools.ietf.org/html/rfc5545#section-3.3.5
* @return string
*/
public function render(): string
{
Expand Down
2 changes: 0 additions & 2 deletions Classes/ViewHelpers/Format/ICalendarDescriptionViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ public function initializeArguments(): void

/**
* Formats the given description according to RFC 2445
*
* @return string
*/
public function render(): string
{
Expand Down
7 changes: 5 additions & 2 deletions Classes/ViewHelpers/MetaTagViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,11 @@ public function initializeArguments(): void
$this->registerArgument('content', 'string', 'Content of meta tag', true, null, false);
}

public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
{
public static function renderStatic(
array $arguments,
\Closure $renderChildrenClosure,
RenderingContextInterface $renderingContext
) {
// Skip if current record is part of tt_content CType shortcut
if (!empty($GLOBALS['TSFE']->recordRegister)
&& is_array($GLOBALS['TSFE']->recordRegister)
Expand Down
2 changes: 0 additions & 2 deletions Classes/ViewHelpers/PrefillViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ public function initializeArguments(): void
/**
* If the current field is available in POST data of the current request, return the value, otherwise
* a property from fe_user (if logged in and if the given field is configured to be prefilled) is returned.
*
* @return string
*/
public function render(): string
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ public function initializeArguments(): void
/**
* Returns a string to be used as prefill value for the given registration field (type=input). If the form
* has already been submitted, the submitted value for the field is returned.
*
* @return string
*/
public function render(): string
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ public function initializeArguments(): void
* Returns, if the given $currentValue is selected/checked for the given registration field is selected
* If no originalRequest exist (form is not submitted), true is returned if the given $currentValue
* matches the default value of the field
*
* @return bool
*/
public function render(): bool
{
Expand Down
2 changes: 0 additions & 2 deletions Classes/ViewHelpers/Registration/HmacViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ public function initializeArguments(): void

/**
* Returns the hmac for the given registration in order to cancel the registration
*
* @return string
*/
public function render(): string
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ public function initializeArguments(): void
* Evaluates the condition
*
* @param array|null $arguments
* @return bool
*/
protected static function evaluateCondition($arguments = null): bool
{
Expand Down
5 changes: 0 additions & 5 deletions Classes/ViewHelpers/TitleViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,6 @@ public function initializeArguments(): void
);
}

/**
* @param array $arguments
* @param \Closure $renderChildrenClosure
* @param RenderingContextInterface $renderingContext
*/
public static function renderStatic(
array $arguments,
\Closure $renderChildrenClosure,
Expand Down
3 changes: 0 additions & 3 deletions Classes/ViewHelpers/Uri/OnlineCalendarViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,6 @@ public function initializeArguments(): void
}

/**
* @param array $arguments
* @param \Closure $renderChildrenClosure
* @param RenderingContextInterface $renderingContext
* @return string
*/
public static function renderStatic(
Expand Down
10 changes: 5 additions & 5 deletions Classes/ViewHelpers/Uri/PageViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ public function initializeArguments(): void
}

/**
* @param array $arguments
* @param \Closure $renderChildrenClosure
* @param RenderingContextInterface $renderingContext
* @return string Rendered page URI
*/
public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
{
public static function renderStatic(
array $arguments,
\Closure $renderChildrenClosure,
RenderingContextInterface $renderingContext
) {
$pageUid = $arguments['pageUid'];
$additionalParams = $arguments['additionalParams'];
$pageType = $arguments['pageType'];
Expand Down
3 changes: 0 additions & 3 deletions Classes/ViewHelpers/Validation/ErrorClassViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@ public function initializeArguments(): void
parent::initializeArguments();
}

/**
* @return string
*/
public function render(): string
{
$result = '';
Expand Down

0 comments on commit 3d3bdab

Please sign in to comment.