@@ -86,7 +86,7 @@ discard block |
||
86 | 86 | * left. |
87 | 87 | * @param array $attributes an array of attributes to include on the link. |
88 | 88 | * |
89 | - * @return boolean The result of the operation. |
|
89 | + * @return boolean|null The result of the operation. |
|
90 | 90 | */ |
91 | 91 | public static function add_link($code, $menuTitle, $url, $priority = -1, $attributes = null) { |
92 | 92 | return self::add_menu_item($code, $menuTitle, $url, null, $priority, $attributes); |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | * have the rights to access some other part of the admin area. |
107 | 107 | * @param array $attributes an array of attributes to include on the link. |
108 | 108 | * |
109 | - * @return boolean Success |
|
109 | + * @return boolean|null Success |
|
110 | 110 | */ |
111 | 111 | public static function add_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1, |
112 | 112 | $attributes = null) { |
@@ -237,7 +237,7 @@ discard block |
||
237 | 237 | * have the rights to access some other part of the admin area. |
238 | 238 | * @param array $attributes an array of attributes to include on the link. |
239 | 239 | * |
240 | - * @return boolean Success |
|
240 | + * @return boolean|null Success |
|
241 | 241 | */ |
242 | 242 | public static function replace_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1, |
243 | 243 | $attributes = null) { |
@@ -256,6 +256,8 @@ discard block |
||
256 | 256 | |
257 | 257 | /** |
258 | 258 | * Add a previously built menu item object to the menu |
259 | + * @param string $code |
|
260 | + * @param CMSMenuItem $cmsMenuItem |
|
259 | 261 | */ |
260 | 262 | protected static function add_menu_item_obj($code, $cmsMenuItem) { |
261 | 263 | self::$menu_item_changes[] = array( |
@@ -72,7 +72,7 @@ |
||
72 | 72 | /** |
73 | 73 | * @param array |
74 | 74 | * |
75 | - * @return HTML |
|
75 | + * @return string |
|
76 | 76 | */ |
77 | 77 | public function getAttributesHTML($attrs = null) { |
78 | 78 | $exclude = (is_string($attrs)) ? func_get_args() : null; |
@@ -14,6 +14,10 @@ |
||
14 | 14 | */ |
15 | 15 | protected $group; |
16 | 16 | |
17 | + /** |
|
18 | + * @param SecurityAdmin $controller |
|
19 | + * @param string $name |
|
20 | + */ |
|
17 | 21 | public function __construct($controller, $name, $fields = null, $actions = null, $validator = null) { |
18 | 22 | if(!$fields) { |
19 | 23 | $helpHtml = _t( |
@@ -336,8 +336,8 @@ discard block |
||
336 | 336 | /** |
337 | 337 | * Extracts the response body and headers from a full curl response |
338 | 338 | * |
339 | - * @param curl_handle $ch The curl handle for the request |
|
340 | - * @param string $rawResponse The raw response text |
|
339 | + * @param resource $ch The curl handle for the request |
|
340 | + * @param string $rawHeaders |
|
341 | 341 | * |
342 | 342 | * @return RestfulService_Response The response object |
343 | 343 | */ |
@@ -601,7 +601,7 @@ discard block |
||
601 | 601 | * get the cached response object. This allows you to access the cached |
602 | 602 | * eaders, not just the cached body. |
603 | 603 | * |
604 | - * @return RestfulSerivice_Response The cached response object |
|
604 | + * @return boolean The cached response object |
|
605 | 605 | */ |
606 | 606 | public function getCachedResponse() { |
607 | 607 | return $this->cachedResponse; |
@@ -217,6 +217,7 @@ discard block |
||
217 | 217 | * via the standard template inclusion process. |
218 | 218 | * |
219 | 219 | * @param string |
220 | + * @param string $template |
|
220 | 221 | */ |
221 | 222 | public function setTemplate($template) { |
222 | 223 | $this->template = $template; |
@@ -272,6 +273,9 @@ discard block |
||
272 | 273 | |
273 | 274 | /** |
274 | 275 | * Create a new RSSFeed entry. |
276 | + * @param string $titleField |
|
277 | + * @param string $descriptionField |
|
278 | + * @param string $authorField |
|
275 | 279 | */ |
276 | 280 | public function __construct($entry, $titleField, $descriptionField, |
277 | 281 | $authorField) { |
@@ -313,6 +317,7 @@ discard block |
||
313 | 317 | /** |
314 | 318 | * Return the named field as an obj() call from $this->failover. |
315 | 319 | * Default to the given class if there's no casting information. |
320 | + * @param string $fieldName |
|
316 | 321 | */ |
317 | 322 | public function rssField($fieldName, $defaultClass = 'Varchar') { |
318 | 323 | if($fieldName) { |
@@ -109,6 +109,7 @@ |
||
109 | 109 | /** |
110 | 110 | * Returns true if negotiation is enabled for the given response. By default, negotiation is only |
111 | 111 | * enabled for pages that have the xml header. |
112 | + * @param SS_HTTPResponse $response |
|
112 | 113 | */ |
113 | 114 | public static function enabled_for($response) { |
114 | 115 | $contentType = $response->getHeader("Content-Type"); |
@@ -293,7 +293,7 @@ discard block |
||
293 | 293 | * |
294 | 294 | * @param string $action |
295 | 295 | * |
296 | - * @return HTMLText |
|
296 | + * @return DBField |
|
297 | 297 | */ |
298 | 298 | public function defaultAction($action) { |
299 | 299 | return $this->getViewer($action)->process($this); |
@@ -429,7 +429,7 @@ discard block |
||
429 | 429 | * |
430 | 430 | * @param array $params |
431 | 431 | * |
432 | - * @return string |
|
432 | + * @return DBField |
|
433 | 433 | */ |
434 | 434 | public function render($params = null) { |
435 | 435 | $template = $this->getViewer($this->getAction()); |
@@ -594,7 +594,7 @@ discard block |
||
594 | 594 | * Tests whether a redirection has been requested. If redirect() has been called, it will return |
595 | 595 | * the URL redirected to. Otherwise, it will return null. |
596 | 596 | * |
597 | - * @return null|string |
|
597 | + * @return boolean |
|
598 | 598 | */ |
599 | 599 | public function redirectedTo() { |
600 | 600 | return $this->getResponse() && $this->getResponse()->getHeader('Location'); |
@@ -146,13 +146,13 @@ |
||
146 | 146 | * @see http://uk3.php.net/manual/en/function.setcookie.php |
147 | 147 | * |
148 | 148 | * @param string $name The name of the cookie |
149 | - * @param string|array $value The value for the cookie to hold |
|
149 | + * @param false|string $value The value for the cookie to hold |
|
150 | 150 | * @param int $expiry The number of days until expiry |
151 | 151 | * @param string $path The path to save the cookie on (falls back to site base) |
152 | 152 | * @param string $domain The domain to make the cookie available on |
153 | 153 | * @param boolean $secure Can the cookie only be sent over SSL? |
154 | 154 | * @param boolean $httpOnly Prevent the cookie being accessible by JS |
155 | - * @return boolean If the cookie was set or not; doesn't mean it's accepted by the browser |
|
155 | + * @return boolean|null If the cookie was set or not; doesn't mean it's accepted by the browser |
|
156 | 156 | */ |
157 | 157 | protected function outputCookie( |
158 | 158 | $name, $value, $expiry = 90, $path = null, $domain = null, $secure = false, $httpOnly = true |
@@ -534,7 +534,7 @@ discard block |
||
534 | 534 | * Returns the domain part of the URL 'http://www.mysite.com'. Returns FALSE is this environment |
535 | 535 | * variable isn't set. |
536 | 536 | * |
537 | - * @return bool|string |
|
537 | + * @return string|false |
|
538 | 538 | */ |
539 | 539 | public static function protocolAndHost() { |
540 | 540 | $alternate = Config::inst()->get('Director', 'alternate_base_url'); |
@@ -869,7 +869,7 @@ discard block |
||
869 | 869 | /** |
870 | 870 | * Returns true if the given file exists. Filename should be relative to the site root. |
871 | 871 | * |
872 | - * @param $file |
|
872 | + * @param string $file |
|
873 | 873 | * |
874 | 874 | * @return bool |
875 | 875 | */ |
@@ -1087,7 +1087,7 @@ discard block |
||
1087 | 1087 | * Can also be checked with {@link Director::isDev()}, {@link Director::isTest()}, and |
1088 | 1088 | * {@link Director::isLive()}. |
1089 | 1089 | * |
1090 | - * @return bool|string |
|
1090 | + * @return string|false |
|
1091 | 1091 | */ |
1092 | 1092 | public static function get_environment_type() { |
1093 | 1093 | if(Director::isLive()) { |