@@ -47,7 +47,7 @@ |
||
| 47 | 47 | * Creates the iterator that will generate child iterators from each of the |
| 48 | 48 | * elements it was constructed with. |
| 49 | 49 | * |
| 50 | - * @param array|\Traversable $items The list of values to iterate |
|
| 50 | + * @param \Cake\Collection\CollectionTrait $items The list of values to iterate |
|
| 51 | 51 | * @param callable $unfolder A callable function that will receive the |
| 52 | 52 | * current item and key. It must return an array or Traversable object |
| 53 | 53 | * out of which the nested iterators will be yielded. |
@@ -239,7 +239,7 @@ discard block |
||
| 239 | 239 | * |
| 240 | 240 | * @param string $prompt Prompt text. |
| 241 | 241 | * @param string|null $default Default input value. |
| 242 | - * @return mixed Either the default value, or the user-provided input. |
|
| 242 | + * @return string Either the default value, or the user-provided input. |
|
| 243 | 243 | */ |
| 244 | 244 | public function ask($prompt, $default = null) |
| 245 | 245 | { |
@@ -279,7 +279,7 @@ discard block |
||
| 279 | 279 | * @param string $prompt Prompt text. |
| 280 | 280 | * @param string|array $options Array or string of options. |
| 281 | 281 | * @param string|null $default Default input value. |
| 282 | - * @return mixed Either the default value, or the user-provided input. |
|
| 282 | + * @return string Either the default value, or the user-provided input. |
|
| 283 | 283 | */ |
| 284 | 284 | public function askChoice($prompt, $options, $default = null) |
| 285 | 285 | { |
@@ -241,7 +241,7 @@ |
||
| 241 | 241 | * Writes a message to the output stream. |
| 242 | 242 | * |
| 243 | 243 | * @param string $message Message to write. |
| 244 | - * @return bool success |
|
| 244 | + * @return integer success |
|
| 245 | 245 | */ |
| 246 | 246 | protected function _write($message) |
| 247 | 247 | { |
@@ -301,7 +301,7 @@ discard block |
||
| 301 | 301 | * return $this->dispatchShell('schema', 'create', 'i18n', '--dry'); |
| 302 | 302 | * ``` |
| 303 | 303 | * |
| 304 | - * @return mixed The return of the other shell. |
|
| 304 | + * @return integer The return of the other shell. |
|
| 305 | 305 | * @link http://book.cakephp.org/3.0/en/console-and-shells.html#invoking-other-shells-from-your-shell |
| 306 | 306 | */ |
| 307 | 307 | public function dispatchShell() |
@@ -451,7 +451,7 @@ discard block |
||
| 451 | 451 | * Safely access the values in $this->params. |
| 452 | 452 | * |
| 453 | 453 | * @param string $name The name of the parameter to get. |
| 454 | - * @return string|bool|null Value. Will return null if it doesn't exist. |
|
| 454 | + * @return string Value. Will return null if it doesn't exist. |
|
| 455 | 455 | */ |
| 456 | 456 | public function param($name) |
| 457 | 457 | { |
@@ -467,7 +467,7 @@ discard block |
||
| 467 | 467 | * @param string $prompt Prompt text. |
| 468 | 468 | * @param string|array|null $options Array or string of options. |
| 469 | 469 | * @param string|null $default Default input value. |
| 470 | - * @return mixed Either the default value, or the user-provided input. |
|
| 470 | + * @return string|null Either the default value, or the user-provided input. |
|
| 471 | 471 | * @link http://book.cakephp.org/3.0/en/console-and-shells.html#Shell::in |
| 472 | 472 | */ |
| 473 | 473 | public function in($prompt, $options = null, $default = null) |
@@ -627,7 +627,7 @@ discard block |
||
| 627 | 627 | * |
| 628 | 628 | * @param string $path Where to put the file. |
| 629 | 629 | * @param string $contents Content to put in the file. |
| 630 | - * @return bool Success |
|
| 630 | + * @return null|boolean Success |
|
| 631 | 631 | * @link http://book.cakephp.org/3.0/en/console-and-shells.html#creating-files |
| 632 | 632 | */ |
| 633 | 633 | public function createFile($path, $contents) |
@@ -687,7 +687,7 @@ discard block |
||
| 687 | 687 | * Stop execution of the current script. Wraps exit() making |
| 688 | 688 | * testing easier. |
| 689 | 689 | * |
| 690 | - * @param int|string $status see http://php.net/exit for values |
|
| 690 | + * @param integer $status see http://php.net/exit for values |
|
| 691 | 691 | * @return void |
| 692 | 692 | */ |
| 693 | 693 | protected function _stop($status = 0) |
@@ -308,7 +308,7 @@ |
||
| 308 | 308 | * Check if a shell class exists for the given name. |
| 309 | 309 | * |
| 310 | 310 | * @param string $shell The shell name to look for. |
| 311 | - * @return string|bool Either the classname or false. |
|
| 311 | + * @return string|false Either the classname or false. |
|
| 312 | 312 | */ |
| 313 | 313 | protected function _shellExists($shell) |
| 314 | 314 | { |
@@ -835,7 +835,7 @@ discard block |
||
| 835 | 835 | * authenticated, this function will return the instance of the authentication |
| 836 | 836 | * object that was used for logging the user in. |
| 837 | 837 | * |
| 838 | - * @return \Cake\Auth\BaseAuthenticate|null |
|
| 838 | + * @return \Cake\Auth\BaseAuthenticate |
|
| 839 | 839 | */ |
| 840 | 840 | public function authenticationProvider() |
| 841 | 841 | { |
@@ -847,7 +847,7 @@ discard block |
||
| 847 | 847 | * will return the instance of the Authorization object that granted access to the |
| 848 | 848 | * user to the current address. |
| 849 | 849 | * |
| 850 | - * @return \Cake\Auth\BaseAuthorize|null |
|
| 850 | + * @return \Cake\Auth\BaseAuthorize |
|
| 851 | 851 | */ |
| 852 | 852 | public function authorizationProvider() |
| 853 | 853 | { |
@@ -162,7 +162,7 @@ |
||
| 162 | 162 | * ``` |
| 163 | 163 | * |
| 164 | 164 | * @param string $keyname The top level keyname to configure. |
| 165 | - * @param null|string|array $option Either the option name to set, or an array of options to set, |
|
| 165 | + * @param string $option Either the option name to set, or an array of options to set, |
|
| 166 | 166 | * or null to read config options for a given key. |
| 167 | 167 | * @param string|null $value Either the value to set, or empty when $option is an array. |
| 168 | 168 | * @return array|null |
@@ -305,7 +305,7 @@ discard block |
||
| 305 | 305 | * "304 Not Modified" header. |
| 306 | 306 | * |
| 307 | 307 | * @param Event $event The Controller.beforeRender event. |
| 308 | - * @return bool false if the render process should be aborted |
|
| 308 | + * @return false|null false if the render process should be aborted |
|
| 309 | 309 | */ |
| 310 | 310 | public function beforeRender(Event $event) |
| 311 | 311 | { |
@@ -468,7 +468,7 @@ discard block |
||
| 468 | 468 | * |
| 469 | 469 | * @param string|array $type An optional array of 'friendly' content-type names, i.e. |
| 470 | 470 | * 'html', 'xml', 'js', etc. |
| 471 | - * @return mixed If $type is null or not provided, the first content-type in the |
|
| 471 | + * @return string|null If $type is null or not provided, the first content-type in the |
|
| 472 | 472 | * list, based on preference, is returned. If a single type is provided |
| 473 | 473 | * a boolean will be returned if that type is preferred. |
| 474 | 474 | * If an array of types are provided then the first preferred type is returned. |
@@ -585,7 +585,7 @@ discard block |
||
| 585 | 585 | * Sets the response header based on type map index name. This wraps several methods |
| 586 | 586 | * available on Cake\Network\Response. It also allows you to use Content-Type aliases. |
| 587 | 587 | * |
| 588 | - * @param string|array $type Friendly type name, i.e. 'html' or 'xml', or a full content-type, |
|
| 588 | + * @param string $type Friendly type name, i.e. 'html' or 'xml', or a full content-type, |
|
| 589 | 589 | * like 'application/x-shockwave'. |
| 590 | 590 | * @param array $options If $type is a friendly type name that is associated with |
| 591 | 591 | * more than one type of content, $index is used to select which content-type to use. |
@@ -205,7 +205,7 @@ discard block |
||
| 205 | 205 | * Check if access requires secure connection |
| 206 | 206 | * |
| 207 | 207 | * @param Controller $controller Instantiating controller |
| 208 | - * @return bool true if secure connection required |
|
| 208 | + * @return null|boolean true if secure connection required |
|
| 209 | 209 | */ |
| 210 | 210 | protected function _secureRequired(Controller $controller) |
| 211 | 211 | { |
@@ -391,7 +391,7 @@ discard block |
||
| 391 | 391 | * |
| 392 | 392 | * @param Controller $controller Controller to run callback on |
| 393 | 393 | * @param string $method Method to execute |
| 394 | - * @param array $params Parameters to send to method |
|
| 394 | + * @param string[] $params Parameters to send to method |
|
| 395 | 395 | * @return mixed Controller callback method's response |
| 396 | 396 | * @throws \Cake\Network\Exception\BadRequestException When a the blackholeCallback is not callable. |
| 397 | 397 | */ |