@@ -152,6 +152,9 @@ discard block |
||
152 | 152 | |
153 | 153 | // -------------------------------------------------------------------------------------------------------------- |
154 | 154 | |
155 | + /** |
|
156 | + * @param DOMElement $node |
|
157 | + */ |
|
155 | 158 | protected function removeNode($node) { |
156 | 159 | $node->parentNode->removeChild($node); |
157 | 160 | } |
@@ -167,6 +170,9 @@ discard block |
||
167 | 170 | } |
168 | 171 | } |
169 | 172 | |
173 | + /** |
|
174 | + * @param DOMElement $after |
|
175 | + */ |
|
170 | 176 | protected function insertListAfter($new, $after) { |
171 | 177 | $doc = $after->ownerDocument; $parent = $after->parentNode; $next = $after->nextSibling; |
172 | 178 | |
@@ -347,6 +353,7 @@ discard block |
||
347 | 353 | * |
348 | 354 | * @param string $content - The HTML string with [tag] style shortcodes embedded |
349 | 355 | * @param array $tags - The tags extracted by extractTags |
356 | + * @param Closure $generator |
|
350 | 357 | * @return string - The HTML string with [tag] style shortcodes replaced by markers |
351 | 358 | */ |
352 | 359 | protected function replaceTagsWithText($content, $tags, $generator) { |
@@ -379,7 +386,6 @@ discard block |
||
379 | 386 | * We don't use markers with attributes because there's no point, it's easier to do all the matching |
380 | 387 | * in-DOM after the XML parse |
381 | 388 | * |
382 | - * @param DOMDocument $doc |
|
383 | 389 | */ |
384 | 390 | protected function replaceAttributeTagsWithContent($htmlvalue) { |
385 | 391 | $attributes = $htmlvalue->query('//@*[contains(.,"[")][contains(.,"]")]'); |
@@ -43,7 +43,7 @@ discard block |
||
43 | 43 | /** |
44 | 44 | * Method that creates the login form for this authentication method |
45 | 45 | * |
46 | - * @param Controller The parent controller, necessary to create the |
|
46 | + * @param Controller Controller parent controller, necessary to create the |
|
47 | 47 | * appropriate form action tag |
48 | 48 | * @return Form Returns the login form to use with this authentication |
49 | 49 | * method |
@@ -121,7 +121,7 @@ discard block |
||
121 | 121 | * Remove a previously registered authenticator |
122 | 122 | * |
123 | 123 | * @param string $authenticator Name of the authenticator class to register |
124 | - * @return bool Returns TRUE on success, FALSE otherwise. |
|
124 | + * @return boolean|null Returns TRUE on success, FALSE otherwise. |
|
125 | 125 | */ |
126 | 126 | public static function unregister_authenticator($authenticator) { |
127 | 127 | if(call_user_func(array($authenticator, 'on_unregister')) === true) { |
@@ -164,6 +164,7 @@ discard block |
||
164 | 164 | * Set a default authenticator (shows first in tabs) |
165 | 165 | * |
166 | 166 | * @param string |
167 | + * @param string $authenticator |
|
167 | 168 | */ |
168 | 169 | public static function set_default_authenticator($authenticator) { |
169 | 170 | self::$default_authenticator = $authenticator; |
@@ -42,6 +42,9 @@ discard block |
||
42 | 42 | ); |
43 | 43 | } |
44 | 44 | |
45 | + /** |
|
46 | + * @param string $action |
|
47 | + */ |
|
45 | 48 | public function Link($action = null) { |
46 | 49 | return Controller::join_links(Director::baseURL(), "CMSSecurity", $action); |
47 | 50 | } |
@@ -57,6 +60,9 @@ discard block |
||
57 | 60 | } |
58 | 61 | } |
59 | 62 | |
63 | + /** |
|
64 | + * @param string $title |
|
65 | + */ |
|
60 | 66 | public function getResponseController($title) { |
61 | 67 | // Use $this to prevent use of Page to render underlying templates |
62 | 68 | return $this; |
@@ -172,6 +178,9 @@ discard block |
||
172 | 178 | user_error('Passed invalid authentication method', E_USER_ERROR); |
173 | 179 | } |
174 | 180 | |
181 | + /** |
|
182 | + * @param string $action |
|
183 | + */ |
|
175 | 184 | public function getTemplatesFor($action) { |
176 | 185 | return array("CMSSecurity_{$action}", "CMSSecurity") |
177 | 186 | + parent::getTemplatesFor($action); |
@@ -331,6 +331,7 @@ |
||
331 | 331 | * Overloaded to ensure the code is always descent. |
332 | 332 | * |
333 | 333 | * @param string |
334 | + * @param string $val |
|
334 | 335 | */ |
335 | 336 | public function setCode($val){ |
336 | 337 | $this->setField("Code", Convert::raw2url($val)); |
@@ -585,6 +585,8 @@ discard block |
||
585 | 585 | |
586 | 586 | /** |
587 | 587 | * Utility for generating secure password hashes for this member. |
588 | + * @param string $string |
|
589 | + * @return string |
|
588 | 590 | */ |
589 | 591 | public function encryptWithUserSettings($string) { |
590 | 592 | if (!$string) return null; |
@@ -735,7 +737,7 @@ discard block |
||
735 | 737 | /** |
736 | 738 | * Returns the current logged in user |
737 | 739 | * |
738 | - * @return Member|null |
|
740 | + * @return DataObject|null |
|
739 | 741 | */ |
740 | 742 | public static function currentUser() { |
741 | 743 | $id = Member::currentUserID(); |
@@ -134,7 +134,7 @@ discard block |
||
134 | 134 | * @param Form $form Optional: If passed, better error messages can be |
135 | 135 | * produced by using |
136 | 136 | * {@link Form::sessionMessage()} |
137 | - * @return bool|Member Returns FALSE if authentication fails, otherwise |
|
137 | + * @return Member|null Returns FALSE if authentication fails, otherwise |
|
138 | 138 | * the member object |
139 | 139 | * @see Security::setDefaultAdmin() |
140 | 140 | */ |
@@ -165,7 +165,7 @@ discard block |
||
165 | 165 | /** |
166 | 166 | * Method that creates the login form for this authentication method |
167 | 167 | * |
168 | - * @param Controller The parent controller, necessary to create the |
|
168 | + * @param Controller Controller parent controller, necessary to create the |
|
169 | 169 | * appropriate form action tag |
170 | 170 | * @return Form Returns the login form to use with this authentication |
171 | 171 | * method |
@@ -47,7 +47,6 @@ |
||
47 | 47 | * @param bool $checkCurrentUser If set to TRUE, it will be checked if a |
48 | 48 | * the user is currently logged in, and if |
49 | 49 | * so, only a logout button will be rendered |
50 | - * @param string $authenticatorClassName Name of the authenticator class that this form uses. |
|
51 | 50 | */ |
52 | 51 | public function __construct($controller, $name, $fields = null, $actions = null, |
53 | 52 | $checkCurrentUser = true) { |
@@ -32,6 +32,7 @@ |
||
32 | 32 | /** |
33 | 33 | * Log a password change from the given member. |
34 | 34 | * Call MemberPassword::log($this) from within Member whenever the password is changed. |
35 | + * @param Member $member |
|
35 | 36 | */ |
36 | 37 | public static function log($member) { |
37 | 38 | $record = new MemberPassword(); |
@@ -85,6 +85,10 @@ discard block |
||
85 | 85 | * but is necessary for retain compatibility with password hashed |
86 | 86 | * with flawed algorithms - see {@link PasswordEncryptor_LegacyPHPHash} and |
87 | 87 | * {@link PasswordEncryptor_Blowfish} |
88 | + * @param string $hash |
|
89 | + * @param string $password |
|
90 | + * @param string $salt |
|
91 | + * @param Member $member |
|
88 | 92 | */ |
89 | 93 | public function check($hash, $password, $salt = null, $member = null) { |
90 | 94 | return $hash === $this->encrypt($password, $salt, $member); |
@@ -127,8 +131,7 @@ discard block |
||
127 | 131 | /** |
128 | 132 | * Gets the cost that is set for the blowfish algorithm |
129 | 133 | * |
130 | - * @param int $cost |
|
131 | - * @return null |
|
134 | + * @return integer |
|
132 | 135 | */ |
133 | 136 | public static function get_cost() { |
134 | 137 | return self::$cost; |
@@ -240,6 +243,7 @@ discard block |
||
240 | 243 | |
241 | 244 | /** |
242 | 245 | * self::$cost param is forced to be two digits with leading zeroes for ints 4-9 |
246 | + * @param string $password |
|
243 | 247 | */ |
244 | 248 | public function salt($password, $member = null) { |
245 | 249 | $generator = new RandomGenerator(); |