silverstripe / silverstripe-framework

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/Dev/FunctionalTest.php

Doc Comments +5 added lines, -2 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
      */
@@ -424,6 +424,9 @@ 
         Security::setCurrentUser(null);
     }
 
+    /**
+     * @param DataObject|null $member
+     */
     public function logIn($member)
     {
         Security::setCurrentUser($member);

src/Security/MemberAuthenticator/LostPasswordHandler.php

Doc Comments +1 added lines

@@ -58,6 +58,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)

src/Security/BasicAuth.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      * @param string|array $permissionCode Optional
      * @param boolean $tryUsingSessionLogin If true, then the method with authenticate against the
      *  session log-in if those credentials are disabled.
-     * @return bool|Member
+     * @return null|Member
      * @throws HTTPResponse_Exception
      */
     public static function requireLogin(

src/Security/MemberAuthenticator/ChangePasswordHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -169,7 +169,7 @@
     /**
      * Return a link to this request handler.
      * The link returned is supplied in the constructor
-     * @param null $action
+     * @param string $action
      * @return string
      */
     public function link($action = null)

src/Security/Security.php

Doc Comments +5 added lines, -4 removed lines

@@ -226,7 +226,7 @@ 
     protected static $currentUser;
 
     /**
-     * @return array
+     * @return Authenticator[]
      */
     public static function getAuthenticators()
     {
@@ -291,7 +291,7 @@ 
      * Get all registered authenticators
      *
      * @param int $service The type of service that is requested
-     * @return array Return an array of Authenticator objects
+     * @return Authenticator[] Return an array of Authenticator objects
      */
     public function getApplicableAuthenticators($service = Authenticator::LOGIN)
     {
@@ -622,7 +622,7 @@ 
      * Combine the given forms into a formset with a tabbed interface
      *
      * @param $forms
-     * @return string
+     * @return DBHTMLText
      */
     protected function generateLoginFormSet($forms)
     {
@@ -1206,6 +1206,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)
     {
@@ -1226,7 +1227,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)
     {

src/Security/MemberAuthenticator/MemberAuthenticator.php

Doc Comments +1 added lines

@@ -53,6 +53,7 @@
      * @param array $data Form submitted data
      * @param ValidationResult $result
      * @param Member|null This third parameter is used in the CMSAuthenticator(s)
+     * @param Member $member
      * @return Member Found member, regardless of successful login
      */
     protected function authenticateMember($data, &$result = null, $member = null)