silverstripe / silverstripe-framework

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/CMSSecurity.php

Doc Comments +6 added lines

@@ -42,6 +42,9 @@ 
         Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/client/dist/js/CMSSecurity.js');
     }
 
+    /**
+     * @param string $action
+     */
     public function Link($action = null)
     {
         /** @skipUpgrade */
@@ -61,6 +64,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $title
+     */
     public function getResponseController($title)
     {
         // Use $this to prevent use of Page to render underlying templates

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

Doc Comments +3 added lines, -3 removed lines

@@ -1622,7 +1622,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)
     {
@@ -1653,7 +1653,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -1688,7 +1688,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/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;