silverstripe / silverstripe-framework

src/Core/Manifest/ClassManifest.php

Doc Comments +1 added lines, -1 removed lines

@@ -259,7 +259,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)

src/Security/BasicAuth.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      * @param string|array $permissionCode Optional
      * @param boolean $tryUsingSessionLogin If true, then the method with authenticate against the
      *  session log-in if those credentials are disabled.
-     * @return bool|Member
+     * @return null|Member
      * @throws HTTPResponse_Exception
      */
     public static function requireLogin(

src/Control/Email/Email.php

Doc Comments +13 added lines, -13 removed lines

@@ -201,12 +201,12 @@ 
 
     /**
      * Email constructor.
-     * @param string|array|null $from
-     * @param string|array|null $to
+     * @param string $from
+     * @param string $to
      * @param string|null $subject
      * @param string|null $body
-     * @param string|array|null $cc
-     * @param string|array|null $bcc
+     * @param string $cc
+     * @param string $bcc
      * @param string|null $returnPath
      */
     public function __construct(
@@ -292,7 +292,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -369,7 +369,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -401,7 +401,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -433,7 +433,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -450,7 +450,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -462,7 +462,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -568,7 +568,7 @@ 
     }
 
     /**
-     * @param string|array $name The data name to add or array to names => value
+     * @param string $name The data name to add or array to names => value
      * @param string|null $value The value of the data to add
      * @return $this
      */
@@ -739,7 +739,7 @@ 
     }
 
     /**
-     * @return array|bool
+     * @return boolean
      */
     public function sendPlain()
     {
@@ -795,7 +795,7 @@ 
     }
 
     /**
-     * @return Swift_MimePart|false
+     * @return \Swift_Mime_MimeEntity
      */
     public function findPlainPart()
     {

src/Control/HTTPRequestBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
      * Will also populate the $_GET['url'] var safely
      *
      * @param array $variables
-     * @return array Cleaned variables
+     * @return string|null Cleaned variables
      */
     protected static function cleanEnvironment(array $variables)
     {

src/Core/Environment.php

Doc Comments +3 added lines, -3 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)
@@ -85,7 +85,7 @@ 
      * The same result can also be achieved through 'suhosin.memory_limit'
      * if PHP is running with the Suhosin system.
      *
-     * @param string|float $memoryLimit Memory limit string or float value
+     * @param null|double $memoryLimit Memory limit string or float value
      */
     static function setMemoryLimitMax($memoryLimit)
     {
@@ -96,7 +96,7 @@ 
     }
 
     /**
-     * @return int Memory limit in bytes
+     * @return double Memory limit in bytes
      */
     public static function getMemoryLimitMax()
     {

src/Core/Startup/ParameterConfirmationToken.php

Doc Comments +4 added lines, -1 removed lines

@@ -47,6 +47,9 @@ 
      */
     protected $token = null;
 
+    /**
+     * @param string $token
+     */
     protected function pathForToken($token)
     {
         return TEMP_FOLDER.'/token_'.preg_replace('/[^a-z0-9]+/', '', $token);
@@ -222,7 +225,7 @@ 
      * Given a list of token names, suppress all tokens that have not been validated, and
      * return the non-validated token with the highest priority
      *
-     * @param array $keys List of token keys in ascending priority (low to high)
+     * @param string[] $keys List of token keys in ascending priority (low to high)
      * @param HTTPRequest $request
      * @return ParameterConfirmationToken The token container for the unvalidated $key given with the highest priority
      */

src/Dev/BulkLoader.php

Doc Comments +4 added lines

@@ -141,6 +141,10 @@
 	 *
 	 * @return BulkLoader_Result See {@link self::processAll()}
 	 */
+
+    /**
+     * @param string $filepath
+     */
     public function load($filepath)
     {
         Environment::increaseTimeLimitTo(3600);

src/Dev/Install/Installer.php

Doc Comments +3 added lines

@@ -284,6 +284,9 @@
         return $this->errors;
     }
 
+    /**
+     * @param string $filename
+     */
     public function writeToFile($filename, $content)
     {
         $base = $this->getBaseDir();

src/Dev/Install/InstallRequirements.php

Doc Comments +76 added lines, -2 removed lines

@@ -151,7 +151,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()
     {
@@ -447,6 +447,10 @@ 
         return $this->errors;
     }
 
+    /**
+     * @param string $settingName
+     * @param string[] $testDetails
+     */
     public function suggestPHPSetting($settingName, $settingValues, $testDetails)
     {
         $this->testing($testDetails);
@@ -465,6 +469,11 @@ 
         }
     }
 
+    /**
+     * @param string $settingName
+     * @param false[] $settingValues
+     * @param string[] $testDetails
+     */
     public function requirePHPSetting($settingName, $settingValues, $testDetails)
     {
         $this->testing($testDetails);
@@ -475,6 +484,10 @@ 
         }
     }
 
+    /**
+     * @param string $class
+     * @param string[] $testDetails
+     */
     public function suggestClass($class, $testDetails)
     {
         $this->testing($testDetails);
@@ -484,6 +497,10 @@ 
         }
     }
 
+    /**
+     * @param string $class
+     * @param string[] $testDetails
+     */
     public function suggestFunction($class, $testDetails)
     {
         $this->testing($testDetails);
@@ -493,6 +510,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDateTimezone($testDetails)
     {
         $this->testing($testDetails);
@@ -503,6 +523,11 @@ 
         }
     }
 
+    /**
+     * @param integer $min
+     * @param integer $recommended
+     * @param string[] $testDetails
+     */
     public function requireMemory($min, $recommended, $testDetails)
     {
         $_SESSION['forcemem'] = false;
@@ -617,6 +642,10 @@ 
         }
     }
 
+    /**
+     * @param string $funcName
+     * @param string[] $testDetails
+     */
     public function requireFunction($funcName, $testDetails)
     {
         $this->testing($testDetails);
@@ -628,6 +657,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $className
+     * @param string[] $testDetails
+     */
     public function requireClass($className, $testDetails)
     {
         $this->testing($testDetails);
@@ -674,6 +707,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $recommendedVersion
+     * @param string $requiredVersion
+     */
     public function requirePHPVersion($recommendedVersion, $requiredVersion, $testDetails)
     {
         $this->testing($testDetails);
@@ -717,7 +754,7 @@ 
      * to ensure the module directory is intact.
      *
      * @param string $dirname
-     * @param array $testDetails
+     * @param string[] $testDetails
      */
     public function requireModule($dirname, $testDetails)
     {
@@ -733,6 +770,10 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     * @param string[] $testDetails
+     */
     public function requireFile($filename, $testDetails)
     {
         $this->testing($testDetails);
@@ -743,6 +784,9 @@ 
         }
     }
 
+    /**
+     * @param string $filename
+     */
     public function requireWriteable($filename, $testDetails, $absolute = false)
     {
         $this->testing($testDetails);
@@ -851,6 +895,10 @@ 
         }
     }
 
+    /**
+     * @param string $moduleName
+     * @param string[] $testDetails
+     */
     public function requireApacheRewriteModule($moduleName, $testDetails)
     {
         $this->testing($testDetails);
@@ -871,6 +919,10 @@ 
         return ($this->testApacheRewriteExists() || $this->testIISRewriteModuleExists());
     }
 
+    /**
+     * @param string $moduleName
+     * @param string[] $testDetails
+     */
     public function requireIISRewriteModule($moduleName, $testDetails)
     {
         $this->testing($testDetails);
@@ -898,6 +950,9 @@ 
         return DatabaseAdapterRegistry::getDatabaseConfigurationHelper($databaseClass);
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseFunctions($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -915,6 +970,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseConnection($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -929,6 +987,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseVersion($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -961,6 +1022,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseOrCreatePermissions($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -986,6 +1050,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requireDatabaseAlterPermissions($databaseConfig, $testDetails)
     {
         $this->testing($testDetails);
@@ -1001,6 +1068,10 @@ 
         }
     }
 
+    /**
+     * @param string[] $varNames
+     * @param string[] $testDetails
+     */
     public function requireServerVariables($varNames, $testDetails)
     {
         $this->testing($testDetails);
@@ -1022,6 +1093,9 @@ 
     }
 
 
+    /**
+     * @param string[] $testDetails
+     */
     public function requirePostSupport($testDetails)
     {
         $this->testing($testDetails);