silverstripe / silverstripe-framework

src/ORM/DataObject.php

Doc Comments +8 added lines, -7 removed lines

@@ -2397,6 +2397,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $field
      */
     public function castingHelper($field)
     {
@@ -2502,7 +2503,7 @@ 
      * </code>
      *
      * @param string $methodName Method on the same object, e.g. {@link canEdit()}
-     * @param Member|int $member
+     * @param null|Member $member
      * @param array $context Optional context
      * @return boolean|null
      */
@@ -2525,7 +2526,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -2538,7 +2539,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -2551,7 +2552,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {
@@ -2566,7 +2567,7 @@ 
      * @param Member $member
      * @param array $context Additional context-specific data which might
      * affect whether (or where) this object could be created.
-     * @return boolean
+     * @return boolean|string
      */
     public function canCreate($member = null, $context = array())
     {
@@ -2683,7 +2684,7 @@ 
      * Traverses to a field referenced by relationships between data objects, returning the value
      * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
      *
-     * @param $fieldName string
+     * @param string $fieldName string
      * @return string | null - will return null on a missing value
      */
     public function relField($fieldName)
@@ -2762,7 +2763,7 @@ 
      * @param string $callerClass The class of objects to be returned
      * @param string|array $filter A filter to be inserted into the WHERE clause.
      * Supports parameterised queries. See SQLSelect::addWhere() for syntax examples.
-     * @param string|array $sort A sort expression to be inserted into the ORDER
+     * @param string $sort A sort expression to be inserted into the ORDER
      * BY clause.  If omitted, self::$default_sort will be used.
      * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
      * @param string|array $limit A limit expression to be inserted into the LIMIT clause.

tests/php/Forms/GridField/GridField_URLHandlerTest/TestComponent_ItemRequest.php

Doc Comments +5 added lines

@@ -20,6 +20,11 @@
 
     protected $id;
 
+    /**
+     * @param \SilverStripe\Forms\GridField\GridField $gridField
+     * @param string $id
+     * @param string $link
+     */
     public function __construct($gridField, $id, $link)
     {
         $this->gridField = $gridField;

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);