Completed
Pull Request — master (#6829)
by Simon
19:33
created
src/Security/MemberAuthenticator/LostPasswordHandler.php 1 patch
Doc Comments   +4 added lines, -1 removed lines patch added patch discarded remove patch
@@ -55,6 +55,7 @@  discard block
 block discarded – undo
55 55
     /**
56 56
      * Return a link to this request handler.
57 57
      * The link returned is supplied in the constructor
58
+     * @param string $action
58 59
      * @return string
59 60
      */
60 61
     public function link($action = null)
@@ -115,7 +116,7 @@  discard block
 block discarded – undo
115 116
      * Factory method for the lost password form
116 117
      *
117 118
      * @skipUpgrade
118
-     * @return Form Returns the lost password form
119
+     * @return LoginForm Returns the lost password form
119 120
      */
120 121
     public function lostPasswordForm()
121 122
     {
@@ -247,6 +248,8 @@  discard block
 block discarded – undo
247 248
 
248 249
     /**
249 250
      * @todo copypaste from FormRequestHandler - refactor
251
+     * @param string $link
252
+     * @return string
250 253
      */
251 254
     protected function addBackURLParam($link)
252 255
     {
Please login to merge, or discard this patch.
src/Security/MemberAuthenticator/LoginHandler.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -133,7 +133,6 @@
 block discarded – undo
133 133
      *   [Optional: 'Remember' => 1 ]
134 134
      * )
135 135
      *
136
-     * @param array $data
137 136
      * @return HTTPResponse
138 137
      */
139 138
     protected function redirectAfterSuccessfulLogin()
Please login to merge, or discard this patch.
src/Security/MemberAuthenticator/Authenticator.php 1 patch
Doc Comments   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -51,8 +51,8 @@  discard block
 block discarded – undo
51 51
      * Attempt to find and authenticate member if possible from the given data
52 52
      *
53 53
      * @param array $data
54
-     * @param Form $form
55 54
      * @param bool &$success Success flag
55
+     * @param string $message
56 56
      * @return Member Found member, regardless of successful login
57 57
      */
58 58
     protected function authenticateMember($data, &$message, &$success)
@@ -192,6 +192,7 @@  discard block
 block discarded – undo
192 192
 
193 193
     /**
194 194
      * @inherit
195
+     * @param string $link
195 196
      */
196 197
     public function getLoginHandler($link)
197 198
     {
Please login to merge, or discard this patch.
src/Security/Security.php 1 patch
Doc Comments   +9 added lines, -5 removed lines patch added patch discarded remove patch
@@ -573,8 +573,7 @@  discard block
 block discarded – undo
573 573
     /**
574 574
      * Combine the given forms into a formset with a tabbed interface
575 575
      *
576
-     * @param array $authenticators List of Authenticator instances
577
-     * @return string
576
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
578 577
      */
579 578
     protected function generateLoginFormSet($forms)
580 579
     {
@@ -640,7 +639,7 @@  discard block
 block discarded – undo
640 639
      * For multiple authenticators, Security_MultiAuthenticatorLogin is used.
641 640
      * See getTemplatesFor and getIncludeTemplate for how to override template logic
642 641
      *
643
-     * @param $request
642
+     * @param HTTPRequest $request
644 643
      * @return HTTPResponse|string Returns the "login" page as HTML code.
645 644
      * @throws HTTPResponse_Exception
646 645
      */
@@ -672,6 +671,10 @@  discard block
 block discarded – undo
672 671
         $handlers = $authenticators;
673 672
         array_walk(
674 673
             $handlers,
674
+
675
+            /**
676
+             * @param HTTPRequest $auth
677
+             */
675 678
             function (&$auth, $name) use ($link) {
676 679
                 $auth = $auth->getLoginHandler(Controller::join_links($link, $name));
677 680
             }
@@ -927,7 +930,7 @@  discard block
 block discarded – undo
927 930
      * Factory method for the lost password form
928 931
      *
929 932
      * @skipUpgrade
930
-     * @return ChangePasswordForm Returns the lost password form
933
+     * @return MemberAuthenticator\ChangePasswordForm Returns the lost password form
931 934
      */
932 935
     public function ChangePasswordForm()
933 936
     {
@@ -1212,6 +1215,7 @@  discard block
 block discarded – undo
1212 1215
 
1213 1216
     /**
1214 1217
      * For the database_is_ready call to return a certain value - used for testing
1218
+     * @param boolean $isReady
1215 1219
      */
1216 1220
     public static function force_database_is_ready($isReady)
1217 1221
     {
@@ -1255,7 +1259,7 @@  discard block
 block discarded – undo
1255 1259
     /**
1256 1260
      * Set to true to ignore access to disallowed actions, rather than returning permission failure
1257 1261
      * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
1258
-     * @param $flag True or false
1262
+     * @param boolean $flag True or false
1259 1263
      */
1260 1264
     public static function set_ignore_disallowed_actions($flag)
1261 1265
     {
Please login to merge, or discard this patch.