silverstripe / silverstripe-framework

src/ORM/Versioning/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -1086,7 +1086,7 @@ 
     /**
      * Find objects in the given relationships, merging them into the given list
      *
-     * @param array $source Config property to extract relationships from
+     * @param string $source Config property to extract relationships from
      * @param bool $recursive True if recursive
      * @param ArrayList $list Optional list to add items to
      * @return ArrayList The list
@@ -1198,7 +1198,7 @@ 
     /**
      * Check if the current user can delete this record from live
      *
-     * @param null $member
+     * @param Member|null $member
      * @return mixed
      */
     public function canUnpublish($member = null)
@@ -1312,7 +1312,7 @@ 
      * Extend permissions to include additional security for objects that are not published to live.
      *
      * @param Member $member
-     * @return bool|null
+     * @return false|null
      */
     public function canView($member = null)
     {
@@ -1390,7 +1390,7 @@ 
      *
      * @param string $stage
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canViewStage($stage = 'Live', $member = null)
     {
@@ -1459,7 +1459,7 @@ 
     /**
      * Determines if the current draft version is the same as live or rather, that there are no outstanding draft changes
      *
-     * @return bool
+     * @return string
      */
     public function latestPublished()
     {
@@ -2554,7 +2554,7 @@ 
     /**
      * Returns an array of possible stages.
      *
-     * @return array
+     * @return string[]
      */
     public function getVersionedStages()
     {

src/Security/Authenticator.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
      * Remove a previously registered authenticator
      *
      * @param string $authenticator Name of the authenticator class to register
-     * @return bool Returns TRUE on success, FALSE otherwise.
+     * @return boolean|null Returns TRUE on success, FALSE otherwise.
      */
     public static function unregister_authenticator($authenticator)
     {

src/Security/Group.php

Doc Comments +1 added lines

@@ -409,6 +409,7 @@
      * Overloaded to ensure the code is always descent.
      *
      * @param string
+     * @param string $val
      */
     public function setCode($val)
     {

src/Security/MemberAuthenticator.php

Doc Comments +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
      * @param Form $form Optional: If passed, better error messages can be
      *                             produced by using
      *                             {@link Form::sessionMessage()}
-     * @return bool|Member Returns FALSE if authentication fails, otherwise
+     * @return Member|null Returns FALSE if authentication fails, otherwise
      *                     the member object
      * @see Security::setDefaultAdmin()
      */

src/Security/PasswordValidator.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
      * Eg: $this->characterStrength(3, array("lowercase", "uppercase", "digits", "punctuation"))
      *
      * @param int $minScore The minimum number of character tests that must pass
-     * @param array $testNames The names of the tests to perform
+     * @param string[] $testNames The names of the tests to perform
      * @return $this
      */
     public function characterStrength($minScore, $testNames)

src/Security/Permission.php

Doc Comments +2 added lines, -2 removed lines

@@ -122,7 +122,7 @@ 
      *  will be checked for the current user
      * @param bool $strict Use "strict" checking (which means a permission
      *  will be granted if the key does not exist at all)?
-     * @return int|bool The ID of the permission record if the permission
+     * @return boolean|string The ID of the permission record if the permission
      *  exists; FALSE otherwise. If "strict" checking is
      *  disabled, TRUE will be returned if the permission does not exist at all.
      */
@@ -162,7 +162,7 @@ 
      * @param string $arg Optional argument (e.g. a permissions for a specific page)
      * @param bool $strict Use "strict" checking (which means a permission
      *  will be granted if the key does not exist at all)?
-     * @return int|bool The ID of the permission record if the permission
+     * @return boolean|string The ID of the permission record if the permission
      *  exists; FALSE otherwise. If "strict" checking is
      *  disabled, TRUE will be returned if the permission does not exist at all.
      */

src/Security/Permission_Group.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
     /**
      * Get permissions
      *
-     * @return array Associative array of permissions in this permission
+     * @return string Associative array of permissions in this permission
      *               group. The array indicies are the permission codes as
      *               used in {@link Permission::check()}. The value is
      *               suitable for using in an interface.

src/Security/RememberLoginHash.php

Doc Comments +3 added lines

@@ -85,6 +85,9 @@
         return $this->token;
     }
 
+    /**
+     * @param string $token
+     */
     public function setToken($token)
     {
         $this->token = $token;

src/Security/Security.php

Doc Comments +2 added lines, -2 removed lines

@@ -532,7 +532,7 @@ 
      * Combine the given forms into a formset with a tabbed interface
      *
      * @param array $forms List of LoginForm instances
-     * @return string
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     protected function generateLoginFormSet($forms)
     {
@@ -1149,7 +1149,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)
     {