silverstripe / silverstripe-framework

src/Security/MemberAuthenticator/LostPasswordHandler.php

Doc Comments +4 added lines, -1 removed lines

@@ -55,6 +55,7 @@ 
     /**
      * Return a link to this request handler.
      * The link returned is supplied in the constructor
+     * @param string $action
      * @return string
      */
     public function link($action = null)
@@ -115,7 +116,7 @@ 
      * Factory method for the lost password form
      *
      * @skipUpgrade
-     * @return Form Returns the lost password form
+     * @return LoginForm Returns the lost password form
      */
     public function lostPasswordForm()
     {
@@ -247,6 +248,8 @@ 
 
     /**
      * @todo copypaste from FormRequestHandler - refactor
+     * @param string $link
+     * @return string
      */
     protected function addBackURLParam($link)
     {

src/Security/MemberAuthenticator/Authenticator.php

Doc Comments +1 added lines

@@ -53,6 +53,7 @@
      * @param $message
      * @param bool &$success Success flag
      * @param null|Member $member If the parent method already identified the member, it can be passed in
+     * @param null|boolean $success
      * @return Member Found member, regardless of successful login
      */
     protected function authenticateMember($data, &$message, &$success, $member = null)

src/Dev/FunctionalTest.php

Doc Comments +2 added lines, -3 removed lines

@@ -230,7 +230,7 @@ 
      * Find an attribute in a SimpleXMLElement object by name.
      * @param SimpleXMLElement $object
      * @param string $attribute Name of attribute to find
-     * @return SimpleXMLElement object of the attribute
+     * @return boolean object of the attribute
      */
     public function findAttribute($object, $attribute)
     {
@@ -264,7 +264,7 @@ 
      * Note:   characters are stripped from the content; make sure that your assertions take this into account.
      *
      * @param string $selector A basic CSS selector, e.g. 'li.jobs h3'
-     * @param array|string $expectedMatches The content of at least one of the matched tags
+     * @param string[] $expectedMatches The content of at least one of the matched tags
      * @param string $message
      * @throws PHPUnit_Framework_AssertionFailedError
      */
@@ -419,7 +419,6 @@ 
     /**
      * Log in as the given member
      *
-     * @param Member|int|string $member The ID, fixture codename, or Member object of the member that you want to log in
      */
     public function logOut()
     {

src/Security/MemberAuthenticator/CookieAuthenticationHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -36,7 +36,7 @@ 
     /**
      * Set the name of the cookie used to track this device
      *
-     * @param string $cookieName
+     * @param string $deviceCookieName
      * @return null
      */
     public function setDeviceCookieName($deviceCookieName)
@@ -57,7 +57,7 @@ 
     /**
      * Set the name of the cookie used to store an login token
      *
-     * @param string $cookieName
+     * @param string $tokenCookieName
      * @return null
      */
     public function setTokenCookieName($tokenCookieName)

src/Security/MemberAuthenticator/LoginHandler.php

Doc Comments +3 added lines, -1 removed lines

@@ -137,7 +137,6 @@ 
      *   [Optional: 'Remember' => 1 ]
      * )
      *
-     * @param array $data
      * @return HTTPResponse
      */
     protected function redirectAfterSuccessfulLogin()
@@ -219,6 +218,8 @@ 
      * Try to authenticate the user
      *
      * @param array $data Submitted data
+     * @param Member $member
+     * @param \SilverStripe\Control\HTTPRequest $request
      * @return Member Returns the member object on successful authentication
      *                or NULL on failure.
      */
@@ -249,6 +250,7 @@ 
 
     /**
      * @todo copypaste from FormRequestHandler - refactor
+     * @param string $link
      */
     protected function addBackURLParam($link)
     {

src/Security/CMSSecurity.php

Doc Comments +6 added lines

@@ -49,6 +49,9 @@ 
         return parent::login($request, Authenticator::CMS_LOGIN);
     }
 
+    /**
+     * @param string $action
+     */
     public function Link($action = null)
     {
         /** @skipUpgrade */
@@ -79,6 +82,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $title
+     */
     public function getResponseController($title)
     {
         // Use $this to prevent use of Page to render underlying templates

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

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