silverstripe / silverstripe-framework

tests/php/Security/GroupTest/MemberForm.php

Doc Comments +4 added lines

@@ -9,6 +9,10 @@
 class MemberForm extends Form
 {
 
+    /**
+     * @param \SilverStripe\Control\Controller $controller
+     * @param string $name
+     */
     public function __construct($controller, $name)
     {
         $fields = TestMember::singleton()->getCMSFields();

tests/php/Security/SecurityTest.php

Doc Comments +4 added lines

@@ -676,6 +676,8 @@ 
     /**
      * Execute a log-in form using Director::test().
      * Helper method for the tests above
+     * @param string $email
+     * @param string $password
      */
     public function doTestLoginForm($email, $password, $backURL = 'test/link')
     {
@@ -697,6 +699,8 @@ 
 
     /**
      * Helper method to execute a change password form
+     * @param string $oldPassword
+     * @param string $newPassword
      */
     public function doTestChangepasswordForm($oldPassword, $newPassword)
     {

tests/php/View/SSViewerCacheBlockTest/VersionedModel.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
         Versioned::class
     );
 
+    /**
+     * @param string $entropy
+     */
     public function setEntropy($entropy)
     {
         $this->entropy = $entropy;

tests/php/View/SSViewerTest.php

Doc Comments +13 added lines

@@ -173,6 +173,10 @@ 
         );
     }
 
+    /**
+     * @param \SilverStripe\ORM\FieldType\DBHTMLText $result
+     * @param string[] $expected
+     */
     private function assertExpectedStrings($result, $expected)
     {
         foreach ($expected as $expectedStr) {
@@ -1088,6 +1092,10 @@ 
         $this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
     }
 
+    /**
+     * @param string $a
+     * @param string $b
+     */
     public function assertEqualIgnoringWhitespace($a, $b, $message = '')
     {
         $this->assertEquals(preg_replace('/\s+/', '', $a), preg_replace('/\s+/', '', $b), $message);
@@ -1819,6 +1827,11 @@ 
             $this->_renderWithSourceFileComments('SSViewerTestComments/'.$template['name'], $template['expected']);
         }
     }
+
+    /**
+     * @param string $name
+     * @param string $expected
+     */
     private function _renderWithSourceFileComments($name, $expected)
     {
         $viewer = new SSViewer(array($name));

admin/code/ModelAdmin.php

Doc Comments +4 added lines, -1 removed lines

@@ -152,6 +152,9 @@ 
         }
     }
 
+    /**
+     * @param string $action
+     */
     public function Link($action = null)
     {
         if (!$action) {
@@ -403,7 +406,7 @@ 
     /**
      * Generate a CSV import form for a single {@link DataObject} subclass.
      *
-     * @return Form|false
+     * @return Form
      */
     public function ImportForm()
     {

src/Control/Email/Email.php

Doc Comments +14 added lines, -14 removed lines

@@ -135,12 +135,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(
@@ -226,7 +226,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -238,7 +238,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string
      */
     public function getSender()
     {
@@ -303,7 +303,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -335,7 +335,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -367,7 +367,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -384,7 +384,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -396,7 +396,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -502,7 +502,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
      */
@@ -672,7 +672,7 @@ 
     }
 
     /**
-     * @return array|bool
+     * @return boolean
      */
     public function sendPlain()
     {
@@ -728,7 +728,7 @@ 
     }
 
     /**
-     * @return Swift_MimePart|false
+     * @return \Swift_Mime_MimeEntity
      */
     public function findPlainPart()
     {

src/Security/Member.php

Doc Comments +5 added lines, -5 removed lines

@@ -889,9 +889,9 @@ 
      * });
      * </code>
      *
-     * @param Member|null|int $member Member or member ID to log in as.
+     * @param null|Member $member Member or member ID to log in as.
      * Set to null or 0 to act as a logged out user.
-     * @param $callback
+     * @param \Closure $callback
      */
     public static function actAs($member, $callback)
     {
@@ -1661,7 +1661,7 @@ 
      * This is likely to be customized for social sites etc. with a looser permission model.
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -1692,7 +1692,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -1727,7 +1727,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {

src/ORM/DataList.php

Doc Comments +11 added lines, -11 removed lines

@@ -179,7 +179,7 @@ 
      * Returns a new DataList instance with the specified query parameter assigned
      *
      * @param string|array $keyOrArray Either the single key to set, or an array of key value pairs to set
-     * @param mixed $val If $keyOrArray is not an array, this is the value to set
+     * @param string $val If $keyOrArray is not an array, this is the value to set
      * @return static
      */
     public function setDataQueryParam($keyOrArray, $val = null)
@@ -556,7 +556,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)
     {
@@ -669,7 +669,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())
@@ -688,7 +688,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())
@@ -815,7 +815,7 @@ 
      * Returns an Iterator for this DataList.
      * This function allows you to use DataLists in foreach loops
      *
-     * @return Generator
+     * @return \Generator
      */
     public function getIterator()
     {
@@ -838,7 +838,7 @@ 
      * Return the maximum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function max($fieldName)
     {
@@ -849,7 +849,7 @@ 
      * Return the minimum value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function min($fieldName)
     {
@@ -860,7 +860,7 @@ 
      * Return the average value of the given field in this DataList
      *
      * @param string $fieldName
-     * @return mixed
+     * @return string
      */
     public function avg($fieldName)
     {
@@ -871,7 +871,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)
     {
@@ -930,7 +930,7 @@ 
     /**
      * Restrict the columns to fetch into this DataList
      *
-     * @param array $queriedColumns
+     * @param string[] $queriedColumns
      * @return static
      */
     public function setQueriedColumns($queriedColumns)
@@ -1176,7 +1176,7 @@ 
     /**
      * Returns item stored in list with index $key
      *
-     * @param mixed $key
+     * @param integer $key
      * @return DataObject
      */
     public function offsetGet($key)

src/ORM/ArrayList.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
      * Returns an Iterator for this ArrayList.
      * This function allows you to use ArrayList in foreach loops
      *
-     * @return ArrayIterator
+     * @return \Generator
      */
     public function getIterator()
     {
@@ -746,7 +746,7 @@ 
     /**
      * Returns item stored in list with index $key
      *
-     * @param mixed $offset
+     * @param integer $offset
      * @return DataObject
      */
     public function offsetGet($offset)