silverstripe / silverstripe-framework

src/Core/Environment.php

Doc Comments +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
      * Only increases up to the maximum defined in {@link setMemoryLimitMax()},
      * and defaults to the 'memory_limit' setting in the PHP configuration.
      *
-     * @param string|float|int $memoryLimit A memory limit string, such as "64M".  If omitted, unlimited memory will be set.
+     * @param integer $memoryLimit A memory limit string, such as "64M".  If omitted, unlimited memory will be set.
      * @return bool true indicates a successful change, false a denied change.
      */
     public static function increaseMemoryLimitTo($memoryLimit = -1)
@@ -96,7 +96,7 @@ 
     }
 
     /**
-     * @return int Memory limit in bytes
+     * @return double Memory limit in bytes
      */
     public static function getMemoryLimitMax()
     {

tests/php/Forms/DropdownFieldTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -400,7 +400,7 @@
      * string of HTML.
      *
      * @param  string $html HTML to scan for elements
-     * @return SimpleXMLElement
+     * @return \SimpleXMLElement[]
      */
     public function findOptionElements($html)
     {

src/Dev/Install/InstallRequirements.php

Doc Comments +72 added lines, -2 removed lines

@@ -159,7 +159,7 @@ 
 
     /**
      * Find the webserver software running on the PHP host.
-     * @return string|boolean Server software or boolean FALSE
+     * @return false|string Server software or boolean FALSE
      */
     public function findWebserver()
     {
@@ -469,6 +469,10 @@ 
         return ini_get($settingName);
     }
 
+    /**
+     * @param string $settingName
+     * @param string[] $testDetails
+     */
     public function suggestPHPSetting($settingName, $settingValues, $testDetails)
     {
         $this->testing($testDetails);
@@ -482,6 +486,11 @@ 
         }
     }
 
+    /**
+     * @param string $settingName
+     * @param false[] $settingValues
+     * @param string[] $testDetails
+     */
     public function requirePHPSetting($settingName, $settingValues, $testDetails)
     {
         $this->testing($testDetails);
@@ -492,6 +501,10 @@ 
         }
     }
 
+    /**
+     * @param string $class
+     * @param string[] $testDetails
+     */
     public function suggestClass($class, $testDetails)
     {
         $this->testing($testDetails);
@@ -501,6 +514,10 @@ 
         }
     }
 
+    /**
+     * @param string $class
+     * @param string[] $testDetails
+     */
     public function suggestFunction($class, $testDetails)
     {
         $this->testing($testDetails);
@@ -520,6 +537,10 @@ 
         }
     }
 
+    /**
+     * @param integer $min
+     * @param integer $recommended
+     */
     public function requireMemory($min, $recommended, $testDetails)
     {
         $_SESSION['forcemem'] = false;
@@ -635,6 +656,10 @@ 
         }
     }
 
+    /**
+     * @param string $funcName
+     * @param string[] $testDetails
+     */
     public function requireFunction($funcName, $testDetails)
     {
         $this->testing($testDetails);
@@ -646,6 +671,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $className
+     * @param string[] $testDetails
+     */
     public function requireClass($className, $testDetails)
     {
         $this->testing($testDetails);
@@ -692,6 +721,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $recommendedVersion
+     * @param string $requiredVersion
+     */
     public function requirePHPVersion($recommendedVersion, $requiredVersion, $testDetails)
     {
         $this->testing($testDetails);
@@ -735,7 +768,7 @@ 
      * to ensure the module directory is intact.
      *
      * @param string $dirname
-     * @param array $testDetails
+     * @param string[] $testDetails
      */
     public function requireModule($dirname, $testDetails)
     {
@@ -751,6 +784,10 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     * @param string[] $testDetails
+     */
     public function requireFile($filename, $testDetails)
     {
         $this->testing($testDetails);
@@ -761,6 +798,9 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     */
     public function requireWriteable($filename, $testDetails, $absolute = false)
     {
         $this->testing($testDetails);
@@ -869,6 +909,10 @@ 
         }
     }
 
+    /**
+     * @param string $moduleName
+     * @param string[] $testDetails
+     */
     public function requireApacheRewriteModule($moduleName, $testDetails)
     {
         $this->testing($testDetails);
@@ -889,6 +933,10 @@ 
         return ($this->testApacheRewriteExists() || $this->testIISRewriteModuleExists());
     }
 
+    /**
+     * @param string $moduleName
+     * @param string[] $testDetails
+     */
     public function requireIISRewriteModule($moduleName, $testDetails)
     {
         $this->testing($testDetails);
@@ -916,6 +964,9 @@ 
         return DatabaseAdapterRegistry::getDatabaseConfigurationHelper($databaseClass);
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseFunctions($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -933,6 +984,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseConnection($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -947,6 +1001,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseVersion($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -979,6 +1036,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseOrCreatePermissions($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -1004,6 +1064,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseAlterPermissions($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -1019,6 +1082,10 @@ 
         }
     }
 
+    /**
+     * @param string[] $varNames
+     * @param string[] $testDetails
+     */
     public function requireServerVariables($varNames, $testDetails)
     {
         $this->testing($testDetails);
@@ -1040,6 +1107,9 @@ 
     }
 
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requirePostSupport($testDetails)
     {
         $this->testing($testDetails);

src/Core/Manifest/ClassManifest.php

Doc Comments +4 added lines, -1 removed lines

@@ -258,7 +258,7 @@ 
      * Returns an array containing all the descendants (direct and indirect)
      * of a class.
      *
-     * @param  string|object $class
+     * @param  string $class
      * @return array
      */
     public function getDescendantsOf($class)
@@ -390,6 +390,9 @@ 
         }
     }
 
+    /**
+     * @param boolean $includeTests
+     */
     public function handleFile($basename, $pathname, $includeTests)
     {
         $classes    = null;

src/Dev/Deprecation.php

Doc Comments +3 added lines, -3 removed lines

@@ -77,9 +77,9 @@ 
      * greater than or equal to this version, a message will be raised
      *
      * @static
-     * @param $ver string -
+     * @param string $ver string -
      *     A php standard version string, see http://php.net/manual/en/function.version-compare.php for details.
-     * @param null $forModule string -
+     * @param string $forModule string -
      *    The name of a module. The passed version will be used as the check value for
      *    calls directly from this module rather than the global value
      * @return void
@@ -143,7 +143,7 @@ 
     /**
      * Determine if deprecation notices should be displayed
      *
-     * @return bool
+     * @return boolean|string
      */
     public static function get_enabled()
     {

src/ORM/DataList.php

Doc Comments +10 added lines, -10 removed lines

@@ -541,7 +541,7 @@ 
      * Check if the given field specification could be interpreted as an unquoted relation name
      *
      * @param string $field
-     * @return bool
+     * @return integer
      */
     protected function isValidRelationName($field)
     {
@@ -654,7 +654,7 @@ 
      * @param int $order A numerical index to control the order that joins are added to the query; lower order values
      * will cause the query to appear first. The default is 20, and joins created automatically by the
      * ORM have a value of 10.
-     * @param array $parameters Any additional parameters if the join is a parameterised subquery
+     * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
      * @return static
      */
     public function innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = array())
@@ -673,7 +673,7 @@ 
      * @param int $order A numerical index to control the order that joins are added to the query; lower order values
      * will cause the query to appear first. The default is 20, and joins created automatically by the
      * ORM have a value of 10.
-     * @param array $parameters Any additional parameters if the join is a parameterised subquery
+     * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
      * @return static
      */
     public function leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = array())
@@ -799,7 +799,7 @@ 
      * Returns an Iterator for this DataList.
      * This function allows you to use DataLists in foreach loops
      *
-     * @return Generator
+     * @return \Generator
      */
     public function getIterator()
     {
@@ -822,7 +822,7 @@ 
      * Return the maximum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function max($fieldName)
     {
@@ -833,7 +833,7 @@ 
      * Return the minimum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function min($fieldName)
     {
@@ -844,7 +844,7 @@ 
      * Return the average value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function avg($fieldName)
     {
@@ -855,7 +855,7 @@ 
      * Return the sum of the values of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function sum($fieldName)
     {
@@ -914,7 +914,7 @@ 
     /**
      * Restrict the columns to fetch into this DataList
      *
-     * @param array $queriedColumns
+     * @param string[] $queriedColumns
      * @return static
      */
     public function setQueriedColumns($queriedColumns)
@@ -1160,7 +1160,7 @@ 
     /**
      * Returns item stored in list with index $key
      *
-     * @param mixed $key
+     * @param integer $key
      * @return DataObject
      */
     public function offsetGet($key)