sminnee / silverstripe-framework

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/ORM/DataObject.php

Doc Comments +9 added lines, -8 removed lines

@@ -2165,7 +2165,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)
     {
@@ -2447,6 +2447,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $field
      */
     public function castingHelper($field)
     {
@@ -2552,7 +2553,7 @@ 
      * </code>
      *
      * @param string $methodName Method on the same object, e.g. {@link canEdit()}
-     * @param Member|int $member
+     * @param Member|null $member
      * @param array $context Optional context
      * @return boolean|null
      */
@@ -2575,7 +2576,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -2588,7 +2589,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -2601,7 +2602,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {
@@ -2616,7 +2617,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())
     {
@@ -2731,7 +2732,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)
@@ -2809,7 +2810,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.

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/Security/Member.php

Doc Comments +5 added lines, -6 removed lines

@@ -422,7 +422,6 @@ 
     /**
      * @deprecated Use Security::setCurrentUser() or IdentityStore::logIn()
      *
-     * @param bool $remember If set to TRUE, the member will be logged in automatically the next time.
      */
     public function logIn()
     {
@@ -737,9 +736,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)
     {
@@ -1489,7 +1488,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)
     {
@@ -1520,7 +1519,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -1555,7 +1554,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {

Unused Use Statements -4 removed lines

@@ -12,7 +12,6 @@ 
 use SilverStripe\Control\Session;
 use SilverStripe\Core\Convert;
 use SilverStripe\Core\Injector\Injector;
-use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Dev\TestMailer;
 use SilverStripe\Forms\ConfirmedPasswordField;
 use SilverStripe\Forms\DropdownField;
@@ -31,9 +30,6 @@ 
 use SilverStripe\ORM\Map;
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\ORM\ValidationResult;
-use SilverStripe\View\SSViewer;
-use SilverStripe\View\TemplateGlobalProvider;
-use DateTime;
 
 /**
  * The member class which represents the users of the system

src/Security/Security.php

Doc Comments +3 added lines, -2 removed lines

@@ -601,7 +601,7 @@ 
      * Combine the given forms into a formset with a tabbed interface
      *
      * @param $forms
-     * @return string
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     protected function generateLoginFormSet($forms)
     {
@@ -1241,6 +1241,7 @@ 
 
     /**
      * For the database_is_ready call to return a certain value - used for testing
+     * @param boolean $isReady
      */
     public static function force_database_is_ready($isReady)
     {
@@ -1284,7 +1285,7 @@ 
     /**
      * Set to true to ignore access to disallowed actions, rather than returning permission failure
      * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-     * @param $flag True or false
+     * @param boolean $flag True or false
      */
     public static function set_ignore_disallowed_actions($flag)
     {

Unused Use Statements -7 removed lines

@@ -13,16 +13,11 @@ 
 use SilverStripe\Control\Session;
 use SilverStripe\Control\RequestHandler;
 use SilverStripe\Core\ClassInfo;
-use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\Convert;
 use SilverStripe\Dev\Deprecation;
 use SilverStripe\Dev\TestOnly;
-use SilverStripe\Forms\EmailField;
-use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\Form;
-use SilverStripe\Forms\FormAction;
 use SilverStripe\ORM\ArrayList;
-use SilverStripe\ORM\Connect\Database;
 use SilverStripe\ORM\DataModel;
 use SilverStripe\ORM\DB;
 use SilverStripe\ORM\DataObject;
@@ -32,8 +27,6 @@ 
 use SilverStripe\View\ArrayData;
 use SilverStripe\View\SSViewer;
 use SilverStripe\View\TemplateGlobalProvider;
-use Exception;
-use SilverStripe\View\ViewableData_Customised;
 use Subsite;
 use SilverStripe\Core\Injector\Injector;
 

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

Unused Use Statements -1 removed lines

@@ -6,7 +6,6 @@
 use Behat\Mink\Session;
 use Behat\Behat\Context\Context;
 use SilverStripe\BehatExtension\Context\MainContextAwareTrait;
-use SilverStripe\BehatExtension\Context\RetryableContextTrait;
 use SilverStripe\BehatExtension\Utility\StepHelper;
 
 /**

tests/php/Forms/FormFieldTest.php

Unused Use Statements -2 removed lines

@@ -5,7 +5,6 @@ 
 use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Dev\SapphireTest;
-use SilverStripe\Control\Controller;
 use SilverStripe\Forms\FormField;
 use SilverStripe\Forms\Tests\FormFieldTest\TestExtension;
 use SilverStripe\Forms\TextField;
@@ -13,7 +12,6 @@ 
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\Form;
 use ReflectionClass;
-use SilverStripe\ORM\FieldType\DBField;
 
 class FormFieldTest extends SapphireTest
 {

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(