[TASK] Remove ampersands from doc block params 94/62594/2
authorAlexander Schnitzler <git@alexanderschnitzler.de>
Tue, 10 Dec 2019 16:10:08 +0000 (17:10 +0100)
committerAndreas Fernandez <a.fernandez@scripting-base.de>
Wed, 11 Dec 2019 08:36:58 +0000 (09:36 +0100)
As a prepatory work for a better static code analysis
all ampersands have been removed from doc block params.

The doc block must not reflect whether a variable is
passed by value or reference.

Releases: master
Resolves: #89912
Change-Id: Ibead2ec2db6487e32bcd5fc271a6566bab46d255
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/62594
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Oliver Bartsch <bo@cedev.de>
Reviewed-by: Mathias Brodala <mbrodala@pagemachine.de>
Reviewed-by: Björn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: Andreas Fernandez <a.fernandez@scripting-base.de>
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Oliver Bartsch <bo@cedev.de>
Tested-by: Mathias Brodala <mbrodala@pagemachine.de>
Tested-by: Björn Jacob <bjoern.jacob@tritum.de>
Tested-by: Andreas Fernandez <a.fernandez@scripting-base.de>
25 files changed:
typo3/sysext/backend/Classes/Form/Element/InlineElementHookInterface.php
typo3/sysext/belog/Classes/Domain/Repository/LogEntryRepository.php
typo3/sysext/core/Classes/DataHandling/DataHandlerCheckModifyAccessListHookInterface.php
typo3/sysext/core/Classes/Mail/Rfc822AddressesParser.php
typo3/sysext/core/Classes/Resource/Security/FileMetadataPermissionsAspect.php
typo3/sysext/core/Classes/TypoScript/ExtendedTemplateService.php
typo3/sysext/core/Classes/TypoScript/Parser/TypoScriptParser.php
typo3/sysext/core/Tests/Unit/DataHandling/Fixtures/AllowAccessHookFixture.php
typo3/sysext/extbase/Classes/Configuration/AbstractConfigurationManager.php
typo3/sysext/extbase/Classes/Hook/DataHandler/CheckFlexFormValue.php
typo3/sysext/extbase/Classes/Persistence/Generic/Backend.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/BindVariableValue.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/Comparison.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/ConstraintInterface.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/LogicalAnd.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/LogicalNot.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/LogicalOr.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/Statement.php
typo3/sysext/extbase/Classes/Persistence/Generic/Storage/Typo3DbQueryParser.php
typo3/sysext/extbase/Classes/Property/PropertyMapper.php
typo3/sysext/extbase/Classes/Property/TypeConverter/ObjectConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/PersistentObjectConverter.php
typo3/sysext/extbase/Classes/Reflection/ObjectAccess.php
typo3/sysext/extensionmanager/Classes/Utility/Parser/MirrorXmlPullParser.php
typo3/sysext/scheduler/Classes/Task/ExecuteSchedulableCommandAdditionalFieldProvider.php

index 13b7661..800ee99 100644 (file)
@@ -27,7 +27,7 @@ interface InlineElementHookInterface
      * @param array $childRecord The current record of that foreign_table
      * @param array $childConfig TCA configuration of the current field of the child record
      * @param bool $isVirtual Defines whether the current records is only virtually shown and not physically part of the parent record
-     * @param array &$enabledControls (reference) Associative array with the enabled control items
+     * @param array $enabledControls (reference) Associative array with the enabled control items
      */
     public function renderForeignRecordHeaderControl_preProcess($parentUid, $foreignTable, array $childRecord, array $childConfig, $isVirtual, array &$enabledControls);
 
@@ -39,7 +39,7 @@ interface InlineElementHookInterface
      * @param array $childRecord The current record of that foreign_table
      * @param array $childConfig TCA configuration of the current field of the child record
      * @param bool $isVirtual Defines whether the current records is only virtually shown and not physically part of the parent record
-     * @param array &$controlItems (reference) Associative array with the currently available control items
+     * @param array $controlItems (reference) Associative array with the currently available control items
      */
     public function renderForeignRecordHeaderControl_postProcess($parentUid, $foreignTable, array $childRecord, array $childConfig, $isVirtual, array &$controlItems);
 }
index fd2989e..12cc38e 100644 (file)
@@ -98,7 +98,7 @@ class LogEntryRepository extends \TYPO3\CMS\Extbase\Persistence\Repository
      *
      * @param \TYPO3\CMS\Belog\Domain\Model\Constraint $constraint
      * @param \TYPO3\CMS\Extbase\Persistence\QueryInterface $query
-     * @param array &$queryConstraints the query constraints to add to, will be modified
+     * @param array $queryConstraints the query constraints to add to, will be modified
      */
     protected function addPageTreeConstraintsToQuery(\TYPO3\CMS\Belog\Domain\Model\Constraint $constraint, \TYPO3\CMS\Extbase\Persistence\QueryInterface $query, array &$queryConstraints)
     {
@@ -126,7 +126,7 @@ class LogEntryRepository extends \TYPO3\CMS\Extbase\Persistence\Repository
      *
      * @param \TYPO3\CMS\Belog\Domain\Model\Constraint $constraint
      * @param \TYPO3\CMS\Extbase\Persistence\QueryInterface $query
-     * @param array &$queryConstraints the query constraints to add to, will be modified
+     * @param array $queryConstraints the query constraints to add to, will be modified
      */
     protected function addUsersAndGroupsToQueryConstraints(\TYPO3\CMS\Belog\Domain\Model\Constraint $constraint, \TYPO3\CMS\Extbase\Persistence\QueryInterface $query, array &$queryConstraints)
     {
index 24a3494..392f282 100644 (file)
@@ -22,7 +22,7 @@ interface DataHandlerCheckModifyAccessListHookInterface
     /**
      * Hook that determines whether a user has access to modify a table.
      *
-     * @param bool &$accessAllowed Whether the user has access to modify a table
+     * @param bool $accessAllowed Whether the user has access to modify a table
      * @param string $table The name of the table to be modified
      * @param \TYPO3\CMS\Core\DataHandling\DataHandler $parent The calling parent object
      */
index 8cd5655..1111861 100644 (file)
@@ -367,7 +367,7 @@ class Rfc822AddressesParser
      *
      * @internal
      * @param string $string The string to check.
-     * @param int &$num        The number of occurrences.
+     * @param int $num The number of occurrences.
      * @param string $char   The character to count.
      * @return int The number of occurrences of $char in $string, adjusted for backslashes.
      */
@@ -541,7 +541,7 @@ class Rfc822AddressesParser
      * mailbox =   addr-spec            ; simple address
      * phrase route-addr ; name and route-addr
      *
-     * @param string &$mailbox The string to check.
+     * @param string $mailbox The string to check.
      * @return bool Success or failure.
      */
     protected function validateMailbox(&$mailbox)
index d8308cf..4386f6a 100644 (file)
@@ -57,7 +57,7 @@ class FileMetadataPermissionsAspect implements DataHandlerCheckModifyAccessListH
      * We "abuse" it here to actually check if access is allowed to sys_file_metadata.
      *
      *
-     * @param int &$accessAllowed Whether the user has access to modify a table
+     * @param int $accessAllowed Whether the user has access to modify a table
      * @param string $table The name of the table to be modified
      * @param DataHandler $parent The calling parent object
      * @throws \UnexpectedValueException
index 1de43ca..7034085 100644 (file)
@@ -649,7 +649,7 @@ class ExtendedTemplateService extends TemplateService
      * and turns it into a hierarchical array to show dependencies (used by TemplateAnalyzer)
      *
      * @param array $depthDataArr (empty array on external call)
-     * @param int &$pointer Element number (1! to count()) of $this->hierarchyInfo that should be processed.
+     * @param int $pointer Element number (1! to count()) of $this->hierarchyInfo that should be processed.
      * @return array Processed hierachyInfo.
      */
     public function ext_process_hierarchyInfo(array $depthDataArr, &$pointer)
index 5c704a8..1bc4f72 100644 (file)
@@ -977,8 +977,8 @@ class TypoScriptParser
      *
      * @param string $filename Full absolute path+filename to the typoscript file to be included
      * @param int $cycleCounter Counter for detecting endless loops
-     * @param bool $returnFiles When set, filenames of included files will be prepended to the array &$includedFiles
-     * @param array &$includedFiles Array to which the filenames of included files will be prepended (referenced)
+     * @param bool $returnFiles When set, filenames of included files will be prepended to the array $includedFiles
+     * @param array $includedFiles Array to which the filenames of included files will be prepended (referenced)
      * @return string the unparsed TypoScript content from external files
      */
     protected static function importExternalTypoScriptFile($filename, $cycleCounter, $returnFiles, array &$includedFiles)
@@ -1077,9 +1077,9 @@ class TypoScriptParser
      *
      * @param string $filename Relative path to the typoscript file to be included
      * @param int $cycle_counter Counter for detecting endless loops
-     * @param bool $returnFiles When set, filenames of included files will be prepended to the array &$includedFiles
-     * @param string &$newString The output string to which the content of the file will be prepended (referenced
-     * @param array &$includedFiles Array to which the filenames of included files will be prepended (referenced)
+     * @param bool $returnFiles When set, filenames of included files will be prepended to the array $includedFiles
+     * @param string $newString The output string to which the content of the file will be prepended (referenced
+     * @param array $includedFiles Array to which the filenames of included files will be prepended (referenced)
      * @param string $optionalProperties
      * @param string $parentFilenameOrPath The parent file (with absolute path) or path for relative includes
      * @static
@@ -1134,9 +1134,9 @@ class TypoScriptParser
      *
      * @param string $dirPath Relative path to the directory to be included
      * @param int $cycle_counter Counter for detecting endless loops
-     * @param bool $returnFiles When set, filenames of included files will be prepended to the array &$includedFiles
-     * @param string &$newString The output string to which the content of the file will be prepended (referenced)
-     * @param array &$includedFiles Array to which the filenames of included files will be prepended (referenced)
+     * @param bool $returnFiles When set, filenames of included files will be prepended to the array $includedFiles
+     * @param string $newString The output string to which the content of the file will be prepended (referenced)
+     * @param array $includedFiles Array to which the filenames of included files will be prepended (referenced)
      * @param string $optionalProperties
      * @param string $parentFilenameOrPath The parent file (with absolute path) or path for relative includes
      * @static
index ceb6a53..f516e67 100644 (file)
@@ -25,7 +25,7 @@ class AllowAccessHookFixture implements DataHandlerCheckModifyAccessListHookInte
     /**
      *  Check modify access list
      *
-     * @param bool &$accessAllowed
+     * @param bool $accessAllowed
      * @param string $table
      * @param DataHandler $parent
      */
index 5d7a58a..a6b8e52 100644 (file)
@@ -239,7 +239,7 @@ abstract class AbstractConfigurationManager implements \TYPO3\CMS\Core\Singleton
      * If called by \TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::overrideSwitchableControllerActionsFromFlexForm,
      * $switchableControllerActions may contain an alternative controller configuration defined via plugin flexform.
      *
-     * @param array &$frameworkConfiguration
+     * @param array $frameworkConfiguration
      * @param array $switchableControllerActions
      * @deprecated since TYPO3 v10, will be removed in one of the next major versions of TYPO3, probably version 11.0 or 12.0.
      */
index b058846..0f2fa56 100644 (file)
@@ -26,8 +26,8 @@ class CheckFlexFormValue
      * Check flexform value before merge
      *
      * @param DataHandler $dataHander
-     * @param array &$currentValue
-     * @param array &$newValue
+     * @param array $currentValue
+     * @param array $newValue
      */
     public function checkFlexFormValue_beforeMerge(DataHandler $dataHander, array &$currentValue, array &$newValue)
     {
index 32a65fe..e95497d 100644 (file)
@@ -409,7 +409,7 @@ class Backend implements \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface
      * @param \TYPO3\CMS\Extbase\Persistence\ObjectStorage $objectStorage The object storage to be persisted.
      * @param \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $parentObject The parent object. One of the properties holds the object storage.
      * @param string $propertyName The name of the property holding the object storage.
-     * @param array &$row The row array of the parent object to be persisted. It's passed by reference and gets filled with either a comma separated list of uids (csv) or the number of contained objects.
+     * @param array $row The row array of the parent object to be persisted. It's passed by reference and gets filled with either a comma separated list of uids (csv) or the number of contained objects.
      */
     protected function persistObjectStorage(\TYPO3\CMS\Extbase\Persistence\ObjectStorage $objectStorage, \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $parentObject, $propertyName, array &$row)
     {
@@ -939,7 +939,7 @@ class Backend implements \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface
      * Adds common database fields to a row
      *
      * @param \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object
-     * @param array &$row
+     * @param array $row
      */
     protected function addCommonFieldsToRow(\TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object, array &$row)
     {
@@ -957,7 +957,7 @@ class Backend implements \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface
      * Adjusts the common date fields of the given row to the current time
      *
      * @param \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object
-     * @param array &$row The row to be updated
+     * @param array $row The row to be updated
      */
     protected function addCommonDateFieldsToRow(\TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object, array &$row)
     {
index 230bb28..d98a86d 100644 (file)
@@ -38,7 +38,7 @@ class BindVariableValue implements \TYPO3\CMS\Extbase\Persistence\Generic\Qom\Bi
     /**
      * Fills an array with the names of all bound variables in the operand
      *
-     * @param array &$boundVariables
+     * @param array $boundVariables
      */
     public function collectBoundVariableNames(&$boundVariables)
     {
index a9c3e52..10d16c0 100644 (file)
@@ -134,7 +134,7 @@ class Comparison implements ComparisonInterface
     /**
      * Fills an array with the names of all bound variables in the constraints
      *
-     * @param array &$boundVariables
+     * @param array $boundVariables
      */
     public function collectBoundVariableNames(&$boundVariables)
     {
index 2cc4640..ecabc8b 100644 (file)
@@ -25,7 +25,7 @@ interface ConstraintInterface
     /**
      * Fills an array with the names of all bound variables in the constraints
      *
-     * @param array &$boundVariables
+     * @param array $boundVariables
      */
     public function collectBoundVariableNames(&$boundVariables);
 }
index 467bb36..d5c8186 100644 (file)
@@ -46,7 +46,7 @@ class LogicalAnd implements AndInterface
     /**
      * Fills an array with the names of all bound variables in the constraints
      *
-     * @param array &$boundVariables
+     * @param array $boundVariables
      */
     public function collectBoundVariableNames(&$boundVariables)
     {
index e6bfc02..5fab3db 100644 (file)
@@ -38,7 +38,7 @@ class LogicalNot implements NotInterface
     /**
      * Fills an array with the names of all bound variables in the constraint
      *
-     * @param array &$boundVariables
+     * @param array $boundVariables
      */
     public function collectBoundVariableNames(&$boundVariables)
     {
index 5d0d997..b11e752 100644 (file)
@@ -48,7 +48,7 @@ class LogicalOr implements OrInterface
     /**
      * Fills an array with the names of all bound variables in the constraints
      *
-     * @param array &$boundVariables
+     * @param array $boundVariables
      */
     public function collectBoundVariableNames(&$boundVariables)
     {
index 8e06dde..27d7874 100644 (file)
@@ -65,7 +65,7 @@ class Statement implements ConstraintInterface
     /**
      * Fills an array with the names of all bound variables in the constraints
      *
-     * @param array &$boundVariables
+     * @param array $boundVariables
      */
     public function collectBoundVariableNames(&$boundVariables)
     {
index ffb5590..52a83d1 100644 (file)
@@ -989,9 +989,9 @@ class Typo3DbQueryParser
      * adds a union statement to the query, mostly for tables referenced in the where condition.
      * The property for which the union statement is generated will be appended.
      *
-     * @param string &$className The name of the parent class, will be set to the child class after processing.
-     * @param string &$tableName The name of the parent table, will be set to the table alias that is used in the union statement.
-     * @param string &$propertyPath The remaining property path, will be cut of by one part during the process.
+     * @param string $className The name of the parent class, will be set to the child class after processing.
+     * @param string $tableName The name of the parent table, will be set to the table alias that is used in the union statement.
+     * @param string $propertyPath The remaining property path, will be cut of by one part during the process.
      * @param string $fullPropertyPath The full path the the current property, will be used to make table names unique.
      * @throws Exception
      * @throws InvalidRelationConfigurationException
index 7c72771..f93cf4a 100644 (file)
@@ -137,7 +137,7 @@ class PropertyMapper implements \TYPO3\CMS\Core\SingletonInterface
      * @param mixed $source the source data to map. MUST be a simple type, NO object allowed!
      * @param string $targetType The type of the target; can be either a class name or a simple type.
      * @param PropertyMappingConfigurationInterface $configuration Configuration for the property mapping.
-     * @param array &$currentPropertyPath The property path currently being mapped; used for knowing the context in case an exception is thrown.
+     * @param array $currentPropertyPath The property path currently being mapped; used for knowing the context in case an exception is thrown.
      * @throws Exception\TypeConverterException
      * @throws Exception\InvalidPropertyMappingConfigurationException
      * @return mixed an instance of $targetType
index 89eded2..f0020cb 100644 (file)
@@ -211,7 +211,7 @@ class ObjectConverter extends AbstractTypeConverter
      * constructor argument values are missing from the given array the method
      * looks for a default value in the constructor signature. Furthermore, the constructor arguments are removed from $possibleConstructorArgumentValues
      *
-     * @param array &$possibleConstructorArgumentValues
+     * @param array $possibleConstructorArgumentValues
      * @param string $objectType
      * @return object The created instance
      * @throws \TYPO3\CMS\Extbase\Property\Exception\InvalidTargetException if a required constructor argument is missing
index e6398c4..1c9ee06 100644 (file)
@@ -179,7 +179,7 @@ class PersistentObjectConverter extends ObjectConverter
      *
      * @param array $source
      * @param string $targetType
-     * @param array &$convertedChildProperties
+     * @param array $convertedChildProperties
      * @param \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration
      * @return object
      * @throws \TYPO3\CMS\Extbase\Property\Exception\InvalidPropertyMappingConfigurationException
index db2e113..afc218b 100644 (file)
@@ -158,7 +158,7 @@ class ObjectAccess
      * on it without checking if it existed.
      * - else, return FALSE
      *
-     * @param mixed &$subject The target object or array
+     * @param mixed $subject The target object or array
      * @param string $propertyName Name of the property to set
      * @param mixed $propertyValue Value of the property
      * @param bool $forceDirectAccess directly access property using reflection(!)
index 6eb5c99..2fc8add 100644 (file)
@@ -116,7 +116,7 @@ class MirrorXmlPullParser extends AbstractMirrorXmlParser
      * Method will read until it finds the end of the given element.
      * If element has no value, method returns NULL.
      *
-     * @param string &$elementName name of element to retrieve it's value from
+     * @param string $elementName name of element to retrieve it's value from
      * @return string an element's value if it has a value, otherwise NULL
      */
     protected function getElementValue(&$elementName)
index 60d6684..df84d82 100644 (file)
@@ -66,7 +66,7 @@ class ExecuteSchedulableCommandAdditionalFieldProvider implements AdditionalFiel
     /**
      * Render additional information fields within the scheduler backend.
      *
-     * @param array &$taskInfo Array information of task to return
+     * @param array $taskInfo Array information of task to return
      * @param AbstractTask|null $task When editing, reference to the current task. NULL when adding.
      * @param SchedulerModuleController $schedulerModule Reference to the calling object (BE module of the Scheduler)
      * @return array Additional fields
@@ -96,7 +96,7 @@ class ExecuteSchedulableCommandAdditionalFieldProvider implements AdditionalFiel
     /**
      * Validates additional selected fields
      *
-     * @param array &$submittedData
+     * @param array $submittedData
      * @param SchedulerModuleController $schedulerModule
      * @return bool
      */