sminnee / silverstripe-framework

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/Forms/DatetimeField.php

Doc Comments +6 added lines, -3 removed lines

@@ -138,7 +138,7 @@ 
     }
 
     /**
-     * @param $bool
+     * @param boolean $bool
      * @return $this
      */
     public function setHTML5($bool)
@@ -151,7 +151,7 @@ 
      * Assign value posted from form submission, based on {@link $datetimeFormat}.
      * When $html5=true, this needs to be normalised ISO format (with "T" separator).
      *
-     * @param mixed $value
+     * @param string $value
      * @param mixed $data
      * @return $this
      */
@@ -317,7 +317,7 @@ 
      * When $html5=true, assign value from ISO 8601 normalised string (with a "T" separator).
      * Falls back to an ISO 8601 string (with a whitespace separator).
      *
-     * @param mixed $value
+     * @param string $value
      * @param mixed $data
      * @return $this
      */
@@ -492,6 +492,9 @@ 
         return $this;
     }
 
+    /**
+     * @param boolean $bool
+     */
     public function setReadonly($bool)
     {
         parent::setReadonly($bool);

src/Security/InheritedPermissions.php

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
     /**
      * Global permissions required to edit
      *
-     * @param array $permissions
+     * @param string[] $permissions
      * @return $this
      */
     public function setGlobalEditPermissions($permissions)

src/View/Parsers/Diff.php

Doc Comments +1 added lines, -1 removed lines

@@ -161,7 +161,7 @@
     }
 
     /**
-     * @param string|bool|array $content If passed as an array, values will be concatenated with a comma.
+     * @param string $content If passed as an array, values will be concatenated with a comma.
      * @return array
      */
     public static function getHTMLChunks($content)

tests/behat/src/CmsUiContext.php

Doc Comments +1 added lines

@@ -479,6 +479,7 @@
      *
      * @When /^(?:|I )fill in the "(?P<field>(?:[^"]|\\")*)" dropdown with "(?P<value>(?:[^"]|\\")*)"$/
      * @When /^(?:|I )fill in "(?P<value>(?:[^"]|\\")*)" for the "(?P<field>(?:[^"]|\\")*)" dropdown$/
+     * @param string $field
      */
     public function theIFillInTheDropdownWith($field, $value)
     {

tests/php/Forms/GridField/GridFieldAddNewButtonTest.php

Doc Comments +3 added lines

@@ -88,6 +88,9 @@
         $this->mockButtonFragments($list, null);
     }
 
+    /**
+     * @param \SilverStripe\ORM\DataObject $parent
+     */
     protected function mockButtonFragments(SS_List $list, $parent = null)
     {
         $form = Form::create(

tests/php/Security/InheritedPermissionsTest/TestPermissionNode.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
         return Injector::inst()->get(PermissionChecker::class.'.testpermissions');
     }
 
+    /**
+     * @param DataObject $member
+     */
     public function canEdit($member = null)
     {
         if (!$member) {

tests/php/View/SSViewerTest.php

Doc Comments +13 added lines

@@ -159,6 +159,10 @@ 
         ]);
     }
 
+    /**
+     * @param \SilverStripe\ORM\FieldType\DBHTMLText $result
+     * @param string[] $expected
+     */
     private function assertExpectedStrings($result, $expected)
     {
         foreach ($expected as $expectedStr) {
@@ -1089,6 +1093,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);
@@ -1817,6 +1825,11 @@ 
             $this->_renderWithSourceFileComments('SSViewerTestComments/'.$template['name'], $template['expected']);
         }
     }
+
+    /**
+     * @param string $name
+     * @param string $expected
+     */
     private function _renderWithSourceFileComments($name, $expected)
     {
         $viewer = new SSViewer(array($name));

src/ORM/DataObject.php

Doc Comments +9 added lines, -8 removed lines

@@ -2176,7 +2176,7 @@ 
      * Called by {@link __get()} and any getFieldName() methods you might create.
      *
      * @param string $field The name of the field
-     * @return mixed The field value
+     * @return string|null The field value
      */
     public function getField($field)
     {
@@ -2458,6 +2458,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $field
      */
     public function castingHelper($field)
     {
@@ -2563,7 +2564,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
      */
@@ -2586,7 +2587,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -2599,7 +2600,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -2612,7 +2613,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {
@@ -2627,7 +2628,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())
     {
@@ -2742,7 +2743,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)
@@ -2820,7 +2821,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.