@@ -70,6 +70,7 @@ |
||
70 | 70 | /** |
71 | 71 | * Get the DisplayFields |
72 | 72 | * |
73 | + * @param GridField $gridField |
|
73 | 74 | * @return array |
74 | 75 | * @see GridFieldDataColumns::setDisplayFields |
75 | 76 | */ |
@@ -29,6 +29,7 @@ discard block |
||
29 | 29 | * |
30 | 30 | * By default, this is set to true so that it's clearer what's happening, but the predefined |
31 | 31 | * {@link GridFieldConfig} subclasses set this to false for flexibility. |
32 | + * @param boolean $throwExceptionOnBadDataType |
|
32 | 33 | */ |
33 | 34 | public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) { |
34 | 35 | $this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType; |
@@ -44,6 +45,7 @@ discard block |
||
44 | 45 | /** |
45 | 46 | * Check that this dataList is of the right data type. |
46 | 47 | * Returns false if it's a bad data type, and if appropriate, throws an exception. |
48 | + * @param SS_List $dataList |
|
47 | 49 | */ |
48 | 50 | protected function checkDataType($dataList) { |
49 | 51 | if($dataList instanceof SS_Sortable) { |
@@ -39,7 +39,7 @@ discard block |
||
39 | 39 | /** |
40 | 40 | * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match |
41 | 41 | * |
42 | - * @param $str - The TinyMCE pattern |
|
42 | + * @param string|null $str - The TinyMCE pattern |
|
43 | 43 | * @return string - The equivalent regex |
44 | 44 | */ |
45 | 45 | protected function patternToRegex($str) { |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | /** |
182 | 182 | * Given an attribute name, return the rule structure for that attribute |
183 | 183 | * |
184 | - * @param object $elementRule |
|
184 | + * @param stdClass $elementRule |
|
185 | 185 | * @param string $name The attribute name |
186 | 186 | * @return stdClass The attribute rule |
187 | 187 | */ |
@@ -83,7 +83,7 @@ discard block |
||
83 | 83 | * |
84 | 84 | * @param string $name the field name |
85 | 85 | * @param string $title the field label |
86 | - * @param string|array $sourceObject The object-type to list in the tree. This could |
|
86 | + * @param string $sourceObject The object-type to list in the tree. This could |
|
87 | 87 | * be one of the following: |
88 | 88 | * - A DataObject class name with the {@link Hierarchy} extension. |
89 | 89 | * - An array of key/value pairs, like a {@link DropdownField} source. In |
@@ -211,7 +211,7 @@ discard block |
||
211 | 211 | } |
212 | 212 | |
213 | 213 | /** |
214 | - * @return HTMLText |
|
214 | + * @return string |
|
215 | 215 | */ |
216 | 216 | public function Field($properties = array()) { |
217 | 217 | Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/javascript/lang'); |
@@ -446,7 +446,6 @@ discard block |
||
446 | 446 | } |
447 | 447 | |
448 | 448 | /** |
449 | - * @param string $field |
|
450 | 449 | * @return $this |
451 | 450 | */ |
452 | 451 | public function setSourceObject($class) { |
@@ -305,6 +305,7 @@ discard block |
||
305 | 305 | |
306 | 306 | /** |
307 | 307 | * @param String |
308 | + * @param string $name |
|
308 | 309 | */ |
309 | 310 | public function setDisplayFolderName($name) { |
310 | 311 | $this->displayFolderName = $name; |
@@ -1046,7 +1047,7 @@ discard block |
||
1046 | 1047 | |
1047 | 1048 | /** |
1048 | 1049 | * @param SS_HTTPRequest $request |
1049 | - * @return UploadField_ItemHandler |
|
1050 | + * @return UploadField_SelectHandler |
|
1050 | 1051 | */ |
1051 | 1052 | public function handleSelect(SS_HTTPRequest $request) { |
1052 | 1053 | if(!$this->canAttachExisting()) return $this->httpError(403); |
@@ -1404,7 +1405,7 @@ discard block |
||
1404 | 1405 | * Action to handle editing of a single file |
1405 | 1406 | * |
1406 | 1407 | * @param SS_HTTPRequest $request |
1407 | - * @return ViewableData_Customised |
|
1408 | + * @return HTMLText |
|
1408 | 1409 | */ |
1409 | 1410 | public function edit(SS_HTTPRequest $request) { |
1410 | 1411 | // Check form field state |
@@ -162,6 +162,9 @@ discard block |
||
162 | 162 | |
163 | 163 | // -------------------------------------------------------------------------------------------------------------- |
164 | 164 | |
165 | + /** |
|
166 | + * @param DOMElement $node |
|
167 | + */ |
|
165 | 168 | protected function removeNode($node) { |
166 | 169 | $node->parentNode->removeChild($node); |
167 | 170 | } |
@@ -177,6 +180,9 @@ discard block |
||
177 | 180 | } |
178 | 181 | } |
179 | 182 | |
183 | + /** |
|
184 | + * @param DOMElement $after |
|
185 | + */ |
|
180 | 186 | protected function insertListAfter($new, $after) { |
181 | 187 | $doc = $after->ownerDocument; $parent = $after->parentNode; $next = $after->nextSibling; |
182 | 188 |
@@ -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); |
@@ -241,6 +245,7 @@ discard block |
||
241 | 245 | |
242 | 246 | /** |
243 | 247 | * self::$cost param is forced to be two digits with leading zeroes for ints 4-9 |
248 | + * @param string $password |
|
244 | 249 | */ |
245 | 250 | public function salt($password, $member = null) { |
246 | 251 | $generator = new RandomGenerator(); |
@@ -125,8 +125,6 @@ discard block |
||
125 | 125 | * $list = DataList::create('SiteTree'); |
126 | 126 | * $list = SiteTree::get(); |
127 | 127 | * |
128 | - * @param string $class the class name |
|
129 | - * @param mixed $arguments,... arguments to pass to the constructor |
|
130 | 128 | * @return static |
131 | 129 | */ |
132 | 130 | public static function create() { |
@@ -149,7 +147,6 @@ discard block |
||
149 | 147 | * way to access instance methods which don't rely on instance |
150 | 148 | * data (e.g. the custom SilverStripe static handling). |
151 | 149 | * |
152 | - * @param string $className Optional classname (if called on Object directly) |
|
153 | 150 | * @return static The singleton instance |
154 | 151 | */ |
155 | 152 | public static function singleton() { |
@@ -334,8 +331,6 @@ discard block |
||
334 | 331 | * Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to |
335 | 332 | * TRUE when using {@link Object::useCustomClass()} |
336 | 333 | * |
337 | - * @param string $class the class name |
|
338 | - * @param mixed $arguments,... arguments to pass to the constructor |
|
339 | 334 | * @return static |
340 | 335 | */ |
341 | 336 | public static function strong_create() { |
@@ -387,8 +382,8 @@ discard block |
||
387 | 382 | * without any inheritance, merging or parent lookup if it doesn't exist on the given class. |
388 | 383 | * |
389 | 384 | * @static |
390 | - * @param $class - The class to get the static from |
|
391 | - * @param $name - The property to get from the class |
|
385 | + * @param string $class - The class to get the static from |
|
386 | + * @param string $name - The property to get from the class |
|
392 | 387 | * @param null $default - The value to return if property doesn't exist on class |
393 | 388 | * @return any - The value of the static property $name on class $class, or $default if that property is not |
394 | 389 | * defined |
@@ -958,6 +953,7 @@ discard block |
||
958 | 953 | |
959 | 954 | /** |
960 | 955 | * @see SS_Object::get_static() |
956 | + * @param string $name |
|
961 | 957 | */ |
962 | 958 | public function stat($name, $uncached = false) { |
963 | 959 | return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::FIRST_SET); |
@@ -965,6 +961,8 @@ discard block |
||
965 | 961 | |
966 | 962 | /** |
967 | 963 | * @see SS_Object::set_static() |
964 | + * @param string $name |
|
965 | + * @param string $value |
|
968 | 966 | */ |
969 | 967 | public function set_stat($name, $value) { |
970 | 968 | Config::inst()->update(($this->class ? $this->class : get_class($this)), $name, $value); |
@@ -972,6 +970,7 @@ discard block |
||
972 | 970 | |
973 | 971 | /** |
974 | 972 | * @see SS_Object::uninherited_static() |
973 | + * @param string $name |
|
975 | 974 | */ |
976 | 975 | public function uninherited($name) { |
977 | 976 | return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::UNINHERITED); |
@@ -1022,7 +1021,7 @@ discard block |
||
1022 | 1021 | * all results into an array |
1023 | 1022 | * |
1024 | 1023 | * @param string $method the method name to call |
1025 | - * @param mixed $argument a single argument to pass |
|
1024 | + * @param string $argument a single argument to pass |
|
1026 | 1025 | * @return mixed |
1027 | 1026 | * @todo integrate inheritance rules |
1028 | 1027 | */ |
@@ -1048,7 +1047,7 @@ discard block |
||
1048 | 1047 | * @param mixed $a1 |
1049 | 1048 | * @param mixed $a2 |
1050 | 1049 | * @param mixed $a3 |
1051 | - * @param mixed $a4 |
|
1050 | + * @param DataObject $a4 |
|
1052 | 1051 | * @param mixed $a5 |
1053 | 1052 | * @param mixed $a6 |
1054 | 1053 | * @param mixed $a7 |
@@ -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 | $link = Controller::join_links(Director::baseURL(), "CMSSecurity", $action); |
47 | 50 | // Give extensions the chance to modify by reference |
@@ -60,6 +63,9 @@ discard block |
||
60 | 63 | } |
61 | 64 | } |
62 | 65 | |
66 | + /** |
|
67 | + * @param string $title |
|
68 | + */ |
|
63 | 69 | public function getResponseController($title) { |
64 | 70 | // Use $this to prevent use of Page to render underlying templates |
65 | 71 | return $this; |
@@ -175,6 +181,9 @@ discard block |
||
175 | 181 | user_error('Passed invalid authentication method', E_USER_ERROR); |
176 | 182 | } |
177 | 183 | |
184 | + /** |
|
185 | + * @param string $action |
|
186 | + */ |
|
178 | 187 | public function getTemplatesFor($action) { |
179 | 188 | return array("CMSSecurity_{$action}", "CMSSecurity") |
180 | 189 | + parent::getTemplatesFor($action); |