[TASK] Make use of bool/int in @param and @return DocComments 56/42256/3
authorWouter Wolters <typo3@wouterwolters.nl>
Tue, 4 Aug 2015 14:56:51 +0000 (16:56 +0200)
committerWouter Wolters <typo3@wouterwolters.nl>
Tue, 4 Aug 2015 15:32:55 +0000 (17:32 +0200)
Resolves: #68732
Releases: master
Change-Id: Ic3c2059ee90185551f77e5b658b686d473291d72
Reviewed-on: http://review.typo3.org/42256
Reviewed-by: Ralf Merz <info@merzilla.de>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
14 files changed:
typo3/sysext/backend/Classes/Clipboard/Clipboard.php
typo3/sysext/backend/Classes/Form/Container/PaletteAndSingleContainer.php
typo3/sysext/backend/Classes/Form/Container/SingleFieldContainer.php
typo3/sysext/backend/Classes/Form/FormEngine.php
typo3/sysext/backend/Classes/Form/Utility/FormEngineUtility.php
typo3/sysext/backend/Classes/Toolbar/ToolbarItemInterface.php
typo3/sysext/core/Classes/Cache/Backend/RedisBackend.php
typo3/sysext/core/Classes/Resource/Driver/DriverInterface.php
typo3/sysext/core/Classes/Resource/Driver/LocalDriver.php
typo3/sysext/core/Classes/Resource/ResourceStorage.php
typo3/sysext/dbal/Classes/Database/Specifics/PostgresSpecifics.php
typo3/sysext/extbase/Tests/Unit/Object/Container/Fixtures/Testclasses.php
typo3/sysext/frontend/Classes/Controller/TypoScriptFrontendController.php
typo3/sysext/rtehtmlarea/Classes/Form/Element/RichTextElement.php

index 4eb0df5..304b8b3 100644 (file)
@@ -494,7 +494,7 @@ class Clipboard {
         *
         * @param string  $str String (already htmlspecialchars()'ed)
         * @param string  $pad Pad reference
-        * @param boolean $active is currently active
+        * @param bool $active is currently active
         * @return string HTML output (htmlspecialchar'ed content inside of tags.)
         */
        public function padTitleWrap($str, $pad, $active) {
index d97de39..43cfa40 100644 (file)
@@ -412,7 +412,7 @@ class PaletteAndSingleContainer extends AbstractContainer {
         * TRUE if field is of type user and to wrapping is requested
         *
         * @param array $element Current element from "target structure" array
-        * @return boolean TRUE if user and noTableWrapping is set
+        * @return bool TRUE if user and noTableWrapping is set
         */
        protected function isUserNoTableWrappingField($element) {
                $table = $this->globalOptions['table'];
index 64bab6e..4b58883 100644 (file)
@@ -445,7 +445,7 @@ class SingleFieldContainer extends AbstractContainer {
        /**
         * Rendering of inline fields should be skipped under certain circumstances
         *
-        * @return boolean TRUE if field should be skipped based on inline configuration
+        * @return bool TRUE if field should be skipped based on inline configuration
         */
        protected function inlineFieldShouldBeSkipped() {
                $table = $this->globalOptions['table'];
index c71fe44..611b1cd 100644 (file)
@@ -905,7 +905,7 @@ class FormEngine {
         * The "entry" pid for inline records. Nested inline records can potentially hang around on different
         * pid's, but the entry pid is needed for AJAX calls, so that they would know where the action takes place on the page structure.
         *
-        * @return integer
+        * @return int
         */
        protected function getInlineFirstPid() {
                $table = $this->table;
index 924a14f..846ca24 100644 (file)
@@ -654,7 +654,7 @@ class FormEngineUtility {
         * Get inlineFirstPid from a given objectId string
         *
         * @param string $domObjectId The id attribute of an element
-        * @return integer|NULL Pid or null
+        * @return int|NULL Pid or null
         * @internal
         */
        static public function getInlineFirstPidFromDomObjectId($domObjectId) {
index dbb9480..b8a80f2 100644 (file)
@@ -26,7 +26,7 @@ interface ToolbarItemInterface {
         * Checks whether the user has access to this toolbar item
         * @TODO: Split into two methods a permission method and a "hasContent" or similar
         *
-        * @return boolean TRUE if user has access, FALSE if not
+        * @return bool TRUE if user has access, FALSE if not
         */
        public function checkAccess();
 
@@ -73,7 +73,7 @@ interface ToolbarItemInterface {
         * By default, extensions should return 50 to be sorted between main core
         * items and other items that should be on the very right.
         *
-        * @return integer 0 .. 100
+        * @return int 0 .. 100
         */
        public function getIndex();
 
index ec8b8a0..ad4dca6 100644 (file)
@@ -504,7 +504,7 @@ class RedisBackend extends AbstractBackend implements TaggableBackendInterface {
         * Helper method to catch invalid identifiers and tags
         *
         * @param mixed $variable Variable to be checked
-        * @return boolean
+        * @return bool
         */
        protected function canBeUsedInStringContext($variable) {
                return is_scalar($variable) || (is_object($variable) && method_exists($variable, '__toString'));
index e310359..a0ae38d 100644 (file)
@@ -454,7 +454,7 @@ interface DriverInterface {
         * @param string  $folderIdentifier
         * @param bool $recursive
         * @param array   $filenameFilterCallbacks callbacks for filtering the items
-        * @return integer Number of files in folder
+        * @return int Number of files in folder
         */
        public function countFilesInFolder($folderIdentifier, $recursive = FALSE, array $filenameFilterCallbacks = array());
 
@@ -464,7 +464,7 @@ interface DriverInterface {
         * @param string  $folderIdentifier
         * @param bool $recursive
         * @param array   $folderNameFilterCallbacks callbacks for filtering the items
-        * @return integer Number of folders in folder
+        * @return int Number of folders in folder
         */
        public function countFoldersInFolder($folderIdentifier, $recursive = FALSE, array $folderNameFilterCallbacks = array());
 
index f8867d2..a0c746a 100644 (file)
@@ -493,7 +493,7 @@ class LocalDriver extends AbstractHierarchicalFilesystemDriver {
         * @param string  $folderIdentifier
         * @param bool $recursive
         * @param array   $folderNameFilterCallbacks callbacks for filtering the items
-        * @return integer Number of folders in folder
+        * @return int Number of folders in folder
         */
        public function countFoldersInFolder($folderIdentifier, $recursive = FALSE, array $folderNameFilterCallbacks = array()) {
                return count($this->getFoldersInFolder($folderIdentifier, 0, 0, $recursive, $folderNameFilterCallbacks));
index 846edb3..3602e40 100644 (file)
@@ -2087,7 +2087,7 @@ class ResourceStorage implements ResourceStorageInterface {
         * @param Folder  $folder
         * @param bool $useFilters
         * @param bool $recursive
-        * @return integer Number of subfolders
+        * @return int Number of subfolders
         * @throws Exception\InsufficientFolderAccessPermissionsException
         */
        public function countFoldersInFolder(Folder $folder, $useFilters = TRUE, $recursive = FALSE) {
index 145c7ef..64ce4f0 100644 (file)
@@ -59,7 +59,7 @@ class PostgresSpecifics extends AbstractSpecifics {
         * Determine the native field length information for a table field.
         *
         * @param string $mysqlType
-        * @param integer $maxLength
+        * @param int $maxLength
         * @return string
         */
        public function getNativeFieldLength($mysqlType, $maxLength) {
index c6df432..adb69cd 100644 (file)
@@ -494,7 +494,7 @@ class t3lib_object_tests_initializable extends \TYPO3\CMS\Extbase\DomainObject\A
        }
 
        /**
-        * @return boolean
+        * @return bool
         */
        public function isInitialized() {
                return $this->initialized;
index 73e5621..952de13 100644 (file)
@@ -4732,7 +4732,7 @@ class TypoScriptFrontendController {
        /**
         * Fetches the originally requested id, fallsback to $this->id
         *
-        * @return integer the originally requested page uid
+        * @return int the originally requested page uid
         * @see fetch_the_id()
         */
        public function getRequestedId() {
index 8929b11..b8d9890 100644 (file)
@@ -884,7 +884,7 @@ class RichTextElement extends AbstractFormElement {
         * @param string $requiringClass: class requiring at some iteration level from the initial requiring class
         * @param string $initialClass: initial class from which a circular relationship is being searched
         * @param int $recursionLevel: depth of recursive call
-        * @return boolean TRUE, if a circular relationship is found
+        * @return bool TRUE, if a circular relationship is found
         */
        protected function hasCircularDependency(&$classesArray, $requiringClass, $initialClass, $recursionLevel = 0) {
                if (is_array($classesArray['requires'][$requiringClass])) {