[TASK] Use scalar types in phpDoc 44/44844/2
authorWouter Wolters <typo3@wouterwolters.nl>
Fri, 20 Nov 2015 21:43:27 +0000 (22:43 +0100)
committerGeorg Ringer <georg.ringer@gmail.com>
Fri, 20 Nov 2015 21:47:33 +0000 (22:47 +0100)
Scalar types should always be written in the same form.
"int", not "integer"; "bool", not "boolean"; "float",
not "real" or "double".

Resolves: #71746
Releases: master
Change-Id: I47d43e5b68187cd07301d277875ba333325e29c7
Reviewed-on: https://review.typo3.org/44844
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
28 files changed:
Build/.php_cs
typo3/sysext/backend/Classes/Controller/EditDocumentController.php
typo3/sysext/backend/Classes/Domain/Repository/Module/BackendModuleRepository.php
typo3/sysext/backend/Classes/History/RecordHistory.php
typo3/sysext/backend/Classes/Toolbar/Enumeration/InformationStatus.php
typo3/sysext/backend/Classes/View/BackendLayoutView.php
typo3/sysext/core/Classes/Authentication/BackendUserAuthentication.php
typo3/sysext/core/Classes/Configuration/TypoScript/ConditionMatching/AbstractConditionMatcher.php
typo3/sysext/core/Classes/Database/DatabaseConnection.php
typo3/sysext/core/Classes/Localization/LocalizationFactory.php
typo3/sysext/core/Classes/Resource/FileRepository.php
typo3/sysext/core/Classes/Resource/Index/FileIndexRepository.php
typo3/sysext/core/Classes/Service/AbstractService.php
typo3/sysext/core/Classes/Utility/ClientUtility.php
typo3/sysext/core/Tests/Functional/DataHandling/Framework/DataSet.php
typo3/sysext/dbal/Classes/Database/DatabaseConnection.php
typo3/sysext/form/Classes/Controller/FrontendController.php
typo3/sysext/form/Classes/Domain/Builder/ElementBuilder.php
typo3/sysext/form/Classes/Domain/Builder/FormBuilder.php
typo3/sysext/form/Classes/Domain/Model/Element.php
typo3/sysext/form/Classes/Domain/Validator/AbstractValidator.php
typo3/sysext/form/Classes/Utility/ElementCounter.php
typo3/sysext/form/Classes/ViewHelpers/AggregateSelectOptionsViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/PlainMailViewHelper.php
typo3/sysext/indexed_search/Classes/Indexer.php
typo3/sysext/install/Classes/FolderStructure/DirectoryNode.php
typo3/sysext/install/Classes/FolderStructure/FileNode.php
typo3/sysext/workspaces/Classes/ColumnDataProviderInterface.php

index ff345f3..721d492 100644 (file)
@@ -65,6 +65,7 @@ return Symfony\CS\Config\Config::create()
         'single_quote',
         'duplicate_semicolon',
         'extra_empty_lines',
-        'phpdoc_no_package'
+        'phpdoc_no_package',
+        'phpdoc_scalar'
     ])
     ->finder($finder);
\ No newline at end of file
index 5826b95..8c695dd 100644 (file)
@@ -214,7 +214,7 @@ class EditDocumentController extends AbstractModule
     /**
      * Workspace used for the editing action.
      *
-     * @var NULL|integer
+     * @var NULL|int
      */
     protected $workspace;
 
index 3f6c07f..c8cc08a 100644 (file)
@@ -86,7 +86,7 @@ class BackendModuleRepository implements \TYPO3\CMS\Core\SingletonInterface
      * Finds a module menu entry by name
      *
      * @param string $name
-     * @return \TYPO3\CMS\Backend\Domain\Model\Module\BackendModule|boolean
+     * @return \TYPO3\CMS\Backend\Domain\Model\Module\BackendModule|bool
      */
     public function findByModuleName($name)
     {
index 9f4f06b..4cf7d1e 100644 (file)
@@ -1012,7 +1012,7 @@ class RecordHistory
      * to an empty string.
      *
      * @param string $name Name of the argument
-     * @return array|string|integer
+     * @return array|string|int
      */
     protected function getArgument($name)
     {
index c2a526e..91521e5 100644 (file)
@@ -61,7 +61,7 @@ class InformationStatus extends \TYPO3\CMS\Core\Type\Enumeration
      * Check if the given status is greater than this status instance
      *
      * @param InformationStatus $status
-     * @return boolean
+     * @return bool
      */
     public function isGreaterThan(InformationStatus $status)
     {
index 115a9a8..bcf25ae 100644 (file)
@@ -137,7 +137,7 @@ class BackendLayoutView implements \TYPO3\CMS\Core\SingletonInterface
      *
      * @param string $tableName
      * @param array $data
-     * @return NULL|integer
+     * @return NULL|int
      */
     protected function determinePageId($tableName, array $data)
     {
index 0bfb5d5..77f194b 100644 (file)
@@ -1817,7 +1817,7 @@ class BackendUserAuthentication extends \TYPO3\CMS\Core\Authentication\AbstractU
      * @param int $pid PageUid
      * @param string $table Table name
      * @param string $field Field name
-     * @return \TYPO3\CMS\Core\Resource\Folder|boolean The default upload folder for this user
+     * @return \TYPO3\CMS\Core\Resource\Folder|bool The default upload folder for this user
      */
     public function getDefaultUploadFolder($pid = null, $table = null, $field = null)
     {
index bd93fb1..560d537 100644 (file)
@@ -197,7 +197,7 @@ abstract class AbstractConditionMatcher
      *
      * @param string $key The condition to match against its criterias.
      * @param string $value
-     * @return NULL|boolean Result of the evaluation; NULL if condition could not be evaluated
+     * @return NULL|bool Result of the evaluation; NULL if condition could not be evaluated
      */
     protected function evaluateConditionCommon($key, $value)
     {
@@ -438,7 +438,7 @@ abstract class AbstractConditionMatcher
      * e.g. "[MyCompany\MyPackage\ConditionMatcher\MyOwnConditionMatcher = myvalue]"
      *
      * @param string $condition The condition to match
-     * @return NULL|boolean Result of the evaluation; NULL if condition could not be evaluated
+     * @return NULL|bool Result of the evaluation; NULL if condition could not be evaluated
      * @throws \TYPO3\CMS\Core\Configuration\TypoScript\Exception\InvalidTypoScriptConditionException
      */
     protected function evaluateCustomDefinedCondition($condition)
index d5b5944..f74155d 100644 (file)
@@ -1131,7 +1131,7 @@ class DatabaseConnection
      * MySQLi fetch_assoc() wrapper function
      *
      * @param bool|\mysqli_result|object $res MySQLi result object / DBAL object
-     * @return array|boolean Associative array of result row.
+     * @return array|bool Associative array of result row.
      */
     public function sql_fetch_assoc($res)
     {
@@ -1153,7 +1153,7 @@ class DatabaseConnection
      * MySQLi fetch_row() wrapper function
      *
      * @param bool|\mysqli_result|object $res MySQLi result object / DBAL object
-     * @return array|boolean Array with result rows.
+     * @return array|bool Array with result rows.
      */
     public function sql_fetch_row($res)
     {
index 128dde0..91a1dd3 100644 (file)
@@ -75,7 +75,7 @@ class LocalizationFactory implements \TYPO3\CMS\Core\SingletonInterface
      * @param string $charset Character set (option); if not set, determined by the language key
      * @param int $errorMode Error mode (when file could not be found): 0 - syslog entry, 1 - do nothing, 2 - throw an exception$
      * @param bool $isLocalizationOverride TRUE if $fileReference is a localization override
-     * @return array|boolean
+     * @return array|bool
      */
     public function getParsedData($fileReference, $languageKey, $charset = '', $errorMode = 0, $isLocalizationOverride = false)
     {
index 675c94b..b13f0f7 100644 (file)
@@ -116,7 +116,7 @@ class FileRepository extends AbstractRepository
      * Find FileReference objects by uid
      *
      * @param int $uid The UID of the sys_file_reference record
-     * @return FileReference|boolean
+     * @return FileReference|bool
      * @throws \InvalidArgumentException
      * @api
      */
index e86aa14..3d2ad93 100644 (file)
@@ -78,7 +78,7 @@ class FileIndexRepository implements SingletonInterface
      * Retrieves Index record for a given $combinedIdentifier
      *
      * @param string $combinedIdentifier
-     * @return array|boolean
+     * @return array|bool
      */
     public function findOneByCombinedIdentifier($combinedIdentifier)
     {
@@ -90,7 +90,7 @@ class FileIndexRepository implements SingletonInterface
      * Retrieves Index record for a given $fileUid
      *
      * @param int $fileUid
-     * @return array|boolean
+     * @return array|bool
      */
     public function findOneByUid($fileUid)
     {
@@ -107,7 +107,7 @@ class FileIndexRepository implements SingletonInterface
      *
      * @param int $storageUid
      * @param string $identifier
-     * @return array|boolean
+     * @return array|bool
      *
      * @internal only for use from FileRepository
      */
@@ -122,7 +122,7 @@ class FileIndexRepository implements SingletonInterface
      *
      * @param int $storageUid
      * @param string $identifierHash
-     * @return array|boolean
+     * @return array|bool
      *
      * @internal only for use from FileRepository
      */
@@ -140,7 +140,7 @@ class FileIndexRepository implements SingletonInterface
      * Retrieves Index record for a given $fileObject
      *
      * @param \TYPO3\CMS\Core\Resource\FileInterface $fileObject
-     * @return array|boolean
+     * @return array|bool
      *
      * @internal only for use from FileRepository
      */
index 51bf5ee..15cb9e6 100644 (file)
@@ -291,7 +291,7 @@ abstract class AbstractService
      * Check if a file exists and is readable.
      *
      * @param string $absFile File name with absolute path.
-     * @return string|boolean File name or FALSE.
+     * @return string|bool File name or FALSE.
      */
     public function checkInputFile($absFile)
     {
@@ -313,7 +313,7 @@ abstract class AbstractService
      *
      * @param string $absFile File name to read from.
      * @param int $length Maximum length to read. If empty the whole file will be read.
-     * @return string|boolean $content or FALSE
+     * @return string|bool $content or FALSE
      */
     public function readFile($absFile, $length = 0)
     {
@@ -332,7 +332,7 @@ abstract class AbstractService
      *
      * @param string $content Content to write to the file
      * @param string $absFile File name to write into. If empty a temp file will be created.
-     * @return string|boolean File name or FALSE
+     * @return string|bool File name or FALSE
      */
     public function writeFile($content, $absFile = '')
     {
@@ -355,7 +355,7 @@ abstract class AbstractService
      * Create a temporary file.
      *
      * @param string $filePrefix File prefix.
-     * @return string|boolean File name or FALSE
+     * @return string|bool File name or FALSE
      */
     public function tempFile($filePrefix)
     {
index e063c3f..57b71b9 100644 (file)
@@ -173,7 +173,7 @@ class ClientUtility
      * stripping of any non-numeric values in the beginning of the string first.
      *
      * @param string $version A string with version number, eg. "/7.32 blablabla
-     * @return double Returns double value, eg. "7.32
+     * @return float Returns double value, eg. "7.32
      */
     public static function getVersion($version)
     {
index 14aec47..8bdd50e 100644 (file)
@@ -205,7 +205,7 @@ class DataSet
 
     /**
      * @param string $tableName
-     * @return NULL|integer
+     * @return NULL|int
      */
     public function getIdIndex($tableName)
     {
index 0bc83b4..8f93a4d 100644 (file)
@@ -2272,7 +2272,7 @@ class DatabaseConnection extends \TYPO3\CMS\Core\Database\DatabaseConnection
      * MySQLi fetch_assoc() wrapper function
      *
      * @param bool|\mysqli_result|object $res MySQLi result object / DBAL object
-     * @return array|boolean Associative array of result row.
+     * @return array|bool Associative array of result row.
      */
     public function sql_fetch_assoc($res)
     {
@@ -2342,7 +2342,7 @@ class DatabaseConnection extends \TYPO3\CMS\Core\Database\DatabaseConnection
      * MySQLi fetch_row() wrapper function
      *
      * @param bool|\mysqli_result|object $res MySQLi result object / DBAL object
-     * @return array|boolean Array with result rows.
+     * @return array|bool Array with result rows.
      */
     public function sql_fetch_row($res)
     {
index 917907c..43887db 100755 (executable)
@@ -58,7 +58,7 @@ class FrontendController extends ActionController
     /**
      * TRUE if the validation of the form should be skipped
      *
-     * @var boolean
+     * @var bool
      */
     protected $skipValidation = false;
 
index 6a39954..36e5b6b 100644 (file)
@@ -447,7 +447,7 @@ class ElementBuilder
      *
      * @param string $needle
      * @param array $haystack
-     * @return boolean TRUE if found
+     * @return bool TRUE if found
      */
     protected function arrayKeyExists($needle, array $haystack = array())
     {
index 2cd8403..e4daaa7 100644 (file)
@@ -618,7 +618,7 @@ class FormBuilder
     /**
      * TRUE if the content element rendering should be disabled.
      *
-     * @return boolean
+     * @return bool
      */
     public function getDisableContentElementRendering()
     {
index 1311ecb..757793e 100644 (file)
@@ -111,7 +111,7 @@ class Element extends AbstractEntity
     /**
      * TRUE if the element should be displayed
      *
-     * @var boolean
+     * @var bool
      */
     protected $showElement;
 
index 26490fd..0fac6ab 100755 (executable)
@@ -47,7 +47,7 @@ abstract class AbstractValidator extends \TYPO3\CMS\Extbase\Validation\Validator
      * This validator always needs to be executed even if the given value is empty.
      * See AbstractValidator::validate()
      *
-     * @var boolean
+     * @var bool
      */
     protected $acceptsEmptyValues = false;
 
index fc087f5..002dabf 100644 (file)
@@ -17,14 +17,14 @@ namespace TYPO3\CMS\Form\Utility;
 class ElementCounter implements \TYPO3\CMS\Core\SingletonInterface
 {
     /**
-     * @var integer
+     * @var int
      */
     protected $elementCounter = 0;
 
     /**
      * Raise the element counter by one
      *
-     * @return integer
+     * @return int
      */
     public function getElementId()
     {
index c2f648f..558b86d 100644 (file)
@@ -34,7 +34,7 @@ class AggregateSelectOptionsViewHelper extends AbstractViewHelper
 
     /**
      * @param Element $model
-     * @param boolean $returnSelectedValues
+     * @param bool $returnSelectedValues
      * @return array
      */
     public function render(Element $model, $returnSelectedValues = false)
index 8557f5a..7634efa 100644 (file)
@@ -24,8 +24,8 @@ class PlainMailViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewH
      *
      * @param mixed $labelContent
      * @param mixed $content
-     * @param boolean $newLineAfterLabel
-     * @param integer $indent
+     * @param bool $newLineAfterLabel
+     * @param int $indent
      * @return string
      */
     public function render($labelContent = null, $content = null, $newLineAfterLabel = false, $indent = 0)
@@ -125,7 +125,7 @@ class PlainMailViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewH
     /**
      * Set the current indent level
      *
-     * @param integer $indent
+     * @param int $indent
      * @return void
      */
     public function setIndent($indent = 0)
index ff18212..08bf720 100644 (file)
@@ -2010,7 +2010,7 @@ class Indexer
      * maps frequency from a real number in [0;1] to an integer in [0;$this->freqRange] with anything above $this->freqMax as 1
      * and back.
      *
-     * @param double $freq Frequency
+     * @param float $freq Frequency
      * @return int Frequency in range.
      */
     public function freqMap($freq)
index 266e728..4a24d7a 100644 (file)
@@ -23,7 +23,7 @@ use TYPO3\CMS\Install\Status;
 class DirectoryNode extends AbstractNode implements NodeInterface
 {
     /**
-     * @var NULL|integer Default for directories is octal 02775 == decimal 1533
+     * @var NULL|int Default for directories is octal 02775 == decimal 1533
      */
     protected $targetPermission = '2775';
 
index 2e969ad..562f283 100644 (file)
@@ -22,7 +22,7 @@ use TYPO3\CMS\Install\Status;
 class FileNode extends AbstractNode implements NodeInterface
 {
     /**
-     * @var NULL|integer Default for files is octal 0664 == decimal 436
+     * @var NULL|int Default for files is octal 0664 == decimal 436
      */
     protected $targetPermission = '0664';
 
index 5cc9704..e422957 100644 (file)
@@ -26,7 +26,7 @@ interface ColumnDataProviderInterface
 
     /**
      * @param Domain\Model\CombinedRecord $combinedRecord
-     * @return string|integer|array
+     * @return string|int|array
      */
     public function getData(\TYPO3\CMS\Workspaces\Domain\Model\CombinedRecord $combinedRecord);
 }