diff --git a/lib/Cake/Console/ConsoleOptionParser.php b/lib/Cake/Console/ConsoleOptionParser.php index 589c27949..34f61b087 100644 --- a/lib/Cake/Console/ConsoleOptionParser.php +++ b/lib/Cake/Console/ConsoleOptionParser.php @@ -218,7 +218,7 @@ class ConsoleOptionParser { * Get or set the command name for shell/task. * * @param string $text The text to set, or null if you want to read - * @return mixed If reading, the value of the command. If setting $this will be returned + * @return string|$this If reading, the value of the command. If setting $this will be returned. */ public function command($text = null) { if ($text !== null) { @@ -233,7 +233,7 @@ class ConsoleOptionParser { * * @param string|array $text The text to set, or null if you want to read. If an array the * text will be imploded with "\n" - * @return mixed If reading, the value of the description. If setting $this will be returned + * @return string|$this If reading, the value of the description. If setting $this will be returned. */ public function description($text = null) { if ($text !== null) { @@ -251,7 +251,7 @@ class ConsoleOptionParser { * the options and arguments listing when help is generated. * * @param string|array $text Text when setting or null when reading. If an array the text will be imploded with "\n" - * @return mixed If reading, the value of the epilog. If setting $this will be returned. + * @return string|$this If reading, the value of the epilog. If setting $this will be returned. */ public function epilog($text = null) { if ($text !== null) { @@ -284,7 +284,7 @@ class ConsoleOptionParser { * @param ConsoleInputOption|string $name The long name you want to the value to be parsed out as when options are parsed. * Will also accept an instance of ConsoleInputOption * @param array $options An array of parameters that define the behavior of the option - * @return ConsoleOptionParser $this. + * @return $this */ public function addOption($name, $options = array()) { if (is_object($name) && $name instanceof ConsoleInputOption) { @@ -324,7 +324,7 @@ class ConsoleOptionParser { * * @param ConsoleInputArgument|string $name The name of the argument. Will also accept an instance of ConsoleInputArgument * @param array $params Parameters for the argument, see above. - * @return ConsoleOptionParser $this. + * @return $this */ public function addArgument($name, $params = array()) { if (is_object($name) && $name instanceof ConsoleInputArgument) { @@ -354,7 +354,7 @@ class ConsoleOptionParser { * * @param array $args Array of arguments to add. * @see ConsoleOptionParser::addArgument() - * @return ConsoleOptionParser $this + * @return $this */ public function addArguments(array $args) { foreach ($args as $name => $params) { @@ -369,7 +369,7 @@ class ConsoleOptionParser { * * @param array $options Array of options to add. * @see ConsoleOptionParser::addOption() - * @return ConsoleOptionParser $this + * @return $this */ public function addOptions(array $options) { foreach ($options as $name => $params) { @@ -391,7 +391,7 @@ class ConsoleOptionParser { * * @param ConsoleInputSubcommand|string $name Name of the subcommand. Will also accept an instance of ConsoleInputSubcommand * @param array $options Array of params, see above. - * @return ConsoleOptionParser $this. + * @return $this */ public function addSubcommand($name, $options = array()) { if (is_object($name) && $name instanceof ConsoleInputSubcommand) { @@ -414,7 +414,7 @@ class ConsoleOptionParser { * Add multiple subcommands at once. * * @param array $commands Array of subcommands. - * @return ConsoleOptionParser $this + * @return $this */ public function addSubcommands(array $commands) { foreach ($commands as $name => $params) { @@ -597,6 +597,7 @@ class ConsoleOptionParser { $params[$name] = $value; return $params; } + return array(); } /** diff --git a/lib/Cake/Model/ModelValidator.php b/lib/Cake/Model/ModelValidator.php index ed6d7632b..cc6caf2cb 100644 --- a/lib/Cake/Model/ModelValidator.php +++ b/lib/Cake/Model/ModelValidator.php @@ -362,7 +362,7 @@ class ModelValidator implements ArrayAccess, IteratorAggregate, Countable { * Sets the I18n domain for validation messages. This method is chainable. * * @param string $validationDomain [optional] The validation domain to be used. - * @return ModelValidator + * @return $this */ public function setValidationDomain($validationDomain = null) { if (empty($validationDomain)) { @@ -547,7 +547,7 @@ class ModelValidator implements ArrayAccess, IteratorAggregate, Countable { * @param string $field The name of the field where the rule is to be added * @param string|array|CakeValidationSet $name name of the rule to be added or list of rules for the field * @param array|CakeValidationRule $rule or list of rules to be added to the field's rule set - * @return ModelValidator this instance + * @return $this */ public function add($field, $name, $rule = null) { $this->_parseRules(); @@ -586,7 +586,7 @@ class ModelValidator implements ArrayAccess, IteratorAggregate, Countable { * * @param string $field The name of the field from which the rule will be removed * @param string $rule the name of the rule to be removed - * @return ModelValidator this instance + * @return $this */ public function remove($field, $rule = null) { $this->_parseRules(); diff --git a/lib/Cake/Model/Validator/CakeValidationSet.php b/lib/Cake/Model/Validator/CakeValidationSet.php index 6daeb8d63..c1a305007 100644 --- a/lib/Cake/Model/Validator/CakeValidationSet.php +++ b/lib/Cake/Model/Validator/CakeValidationSet.php @@ -191,7 +191,7 @@ class CakeValidationSet implements ArrayAccess, IteratorAggregate, Countable { * * @param string $name The name under which the rule should be set * @param CakeValidationRule|array $rule The validation rule to be set - * @return CakeValidationSet this instance + * @return $this */ public function setRule($name, $rule) { if (!($rule instanceof CakeValidationRule)) { @@ -213,7 +213,7 @@ class CakeValidationSet implements ArrayAccess, IteratorAggregate, Countable { * }}} * * @param string $name The name under which the rule should be unset - * @return CakeValidationSet this instance + * @return $this */ public function removeRule($name) { unset($this->_rules[$name]); @@ -234,7 +234,7 @@ class CakeValidationSet implements ArrayAccess, IteratorAggregate, Countable { * * @param array $rules The rules to be set * @param boolean $mergeVars [optional] If true, merges vars instead of replace. Defaults to true. - * @return ModelField + * @return $this */ public function setRules($rules = array(), $mergeVars = true) { if ($mergeVars === false) { diff --git a/lib/Cake/Network/CakeRequest.php b/lib/Cake/Network/CakeRequest.php index 5beca6cc1..41ab65108 100644 --- a/lib/Cake/Network/CakeRequest.php +++ b/lib/Cake/Network/CakeRequest.php @@ -602,7 +602,7 @@ class CakeRequest implements ArrayAccess { * This modifies the parameters available through `$request->params`. * * @param array $params Array of parameters to merge in - * @return The current object, you can chain this method. + * @return $this */ public function addParams($params) { $this->params = array_merge($this->params, (array)$params); @@ -614,7 +614,7 @@ class CakeRequest implements ArrayAccess { * Provides an easy way to modify, here, webroot and base. * * @param array $paths Array of paths to merge in - * @return CakeRequest the current object, you can chain this method. + * @return $this */ public function addPaths($paths) { foreach (array('webroot', 'here', 'base') as $element) { @@ -855,7 +855,7 @@ class CakeRequest implements ArrayAccess { * will be created for you. * * @param string $name Dot separated name of the value to read/write, one or more args. - * @return mixed Either the value being read, or this so you can chain consecutive writes. + * @return mixed|$this Either the value being read, or $this so you can chain consecutive writes. */ public function data($name) { $args = func_get_args(); diff --git a/lib/Cake/Network/Email/CakeEmail.php b/lib/Cake/Network/Email/CakeEmail.php index 32721e7f4..39da66c51 100644 --- a/lib/Cake/Network/Email/CakeEmail.php +++ b/lib/Cake/Network/Email/CakeEmail.php @@ -451,7 +451,7 @@ class CakeEmail { * @param string|array $email Null to get, String with email, * Array with email as key, name as value or email as value (without name) * @param string $name Name - * @return CakeEmail $this + * @return $this */ public function addTo($email, $name = null) { return $this->_addEmail('_to', $email, $name); @@ -478,7 +478,7 @@ class CakeEmail { * @param string|array $email Null to get, String with email, * Array with email as key, name as value or email as value (without name) * @param string $name Name - * @return CakeEmail $this + * @return $this */ public function addCc($email, $name = null) { return $this->_addEmail('_cc', $email, $name); @@ -505,7 +505,7 @@ class CakeEmail { * @param string|array $email Null to get, String with email, * Array with email as key, name as value or email as value (without name) * @param string $name Name - * @return CakeEmail $this + * @return $this */ public function addBcc($email, $name = null) { return $this->_addEmail('_bcc', $email, $name); @@ -545,7 +545,7 @@ class CakeEmail { * EmailPattern setter/getter * * @param string $regex for email address validation - * @return string|CakeEmail + * @return string|$this */ public function emailPattern($regex = null) { if ($regex === null) { @@ -562,7 +562,7 @@ class CakeEmail { * @param string|array $email String with email, * Array with email as key, name as value or email as value (without name) * @param string $name Name - * @return CakeEmail $this + * @return $this */ protected function _setEmail($varName, $email, $name) { if (!is_array($email)) { @@ -610,7 +610,7 @@ class CakeEmail { * Array with email as key, name as value or email as value (without name) * @param string $name Name * @param string $throwMessage Exception message - * @return CakeEmail $this + * @return $this * @throws SocketException */ protected function _setEmailSingle($varName, $email, $name, $throwMessage) { @@ -630,7 +630,7 @@ class CakeEmail { * @param string|array $email String with email, * Array with email as key, name as value or email as value (without name) * @param string $name Name - * @return CakeEmail $this + * @return $this * @throws SocketException */ protected function _addEmail($varName, $email, $name) { @@ -658,7 +658,7 @@ class CakeEmail { * Get/Set Subject. * * @param string $subject Subject string. - * @return string|CakeEmail + * @return string|$this */ public function subject($subject = null) { if ($subject === null) { @@ -672,7 +672,7 @@ class CakeEmail { * Sets headers for the message * * @param array $headers Associative array containing headers to be set. - * @return CakeEmail $this + * @return $this * @throws SocketException */ public function setHeaders($headers) { @@ -687,7 +687,7 @@ class CakeEmail { * Add header for the message * * @param array $headers Headers to set. - * @return object $this + * @return $this * @throws SocketException */ public function addHeaders($headers) { @@ -820,7 +820,7 @@ class CakeEmail { * * @param boolean|string $template Template name or null to not use * @param boolean|string $layout Layout name or null to not use - * @return array|CakeEmail + * @return array|$this */ public function template($template = false, $layout = false) { if ($template === false) { @@ -840,7 +840,7 @@ class CakeEmail { * View class for render * * @param string $viewClass View class name. - * @return string|CakeEmail + * @return string|$this */ public function viewRender($viewClass = null) { if ($viewClass === null) { @@ -854,7 +854,7 @@ class CakeEmail { * Variables to be set on render * * @param array $viewVars Variables to set for view. - * @return array|CakeEmail + * @return array|$this */ public function viewVars($viewVars = null) { if ($viewVars === null) { @@ -868,7 +868,7 @@ class CakeEmail { * Theme to use when rendering * * @param string $theme Theme name. - * @return string|CakeEmail + * @return string|$this */ public function theme($theme = null) { if ($theme === null) { @@ -882,7 +882,7 @@ class CakeEmail { * Helpers to be used in render * * @param array $helpers Helpers list. - * @return array|CakeEmail + * @return array|$this */ public function helpers($helpers = null) { if ($helpers === null) { @@ -896,7 +896,7 @@ class CakeEmail { * Email format * * @param string $format Formatting string. - * @return string|CakeEmail + * @return string|$this * @throws SocketException */ public function emailFormat($format = null) { @@ -914,7 +914,7 @@ class CakeEmail { * Transport name * * @param string $name Transport name. - * @return string|CakeEmail + * @return string|$this */ public function transport($name = null) { if ($name === null) { @@ -928,7 +928,7 @@ class CakeEmail { /** * Return the transport class * - * @return CakeEmail + * @return AbstractTransport * @throws SocketException */ public function transportClass() { @@ -951,7 +951,7 @@ class CakeEmail { * Message-ID * * @param boolean|string $message True to generate a new Message-ID, False to ignore (not send in email), String to set as Message-ID - * @return boolean|string|CakeEmail + * @return boolean|string|$this * @throws SocketException */ public function messageId($message = null) { @@ -973,7 +973,7 @@ class CakeEmail { * Domain as top level (the part after @) * * @param string $domain Manually set the domain for CLI mailing - * @return string|CakeEmail + * @return string|$this */ public function domain($domain = null) { if ($domain === null) { @@ -1027,7 +1027,7 @@ class CakeEmail { * attachment compatibility with outlook email clients. * * @param string|array $attachments String with the filename or array with filenames - * @return array|CakeEmail Either the array of attachments when getting or $this when setting. + * @return array|$this Either the array of attachments when getting or $this when setting. * @throws SocketException */ public function attachments($attachments = null) { @@ -1070,7 +1070,7 @@ class CakeEmail { * Add attachments * * @param string|array $attachments String with the filename or array with filenames - * @return CakeEmail $this + * @return $this * @throws SocketException * @see CakeEmail::attachments() */ @@ -1111,7 +1111,7 @@ class CakeEmail { * `$email->config(array('to' => 'bill@example.com'));` * * @param string|array $config String with configuration name (from email.php), array with config or null to return current config - * @return string|array|CakeEmail + * @return string|array|$this */ public function config($config = null) { if ($config === null) { @@ -1259,7 +1259,7 @@ class CakeEmail { /** * Reset all CakeEmail internal variables to be able to send out a new email. * - * @return CakeEmail $this + * @return $this */ public function reset() { $this->_to = array(); @@ -1696,7 +1696,7 @@ class CakeEmail { /** * Return the Content-Transfer Encoding value based on the set charset * - * @return void + * @return string */ protected function _getContentTransferEncoding() { $charset = strtoupper($this->charset); diff --git a/lib/Cake/View/Helper/HtmlHelper.php b/lib/Cake/View/Helper/HtmlHelper.php index 6a8640bc8..55c7a513c 100644 --- a/lib/Cake/View/Helper/HtmlHelper.php +++ b/lib/Cake/View/Helper/HtmlHelper.php @@ -174,7 +174,7 @@ class HtmlHelper extends AppHelper { * @param string $name Text for link * @param string $link URL for link (if empty it won't be a link) * @param string|array $options Link attributes e.g. array('id' => 'selected') - * @return this HtmlHelper + * @return $this * @see HtmlHelper::link() for details on $options that can be used. * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#creating-breadcrumb-trails-with-htmlhelper */ diff --git a/lib/Cake/View/Helper/JqueryEngineHelper.php b/lib/Cake/View/Helper/JqueryEngineHelper.php index c790e7fc6..d5a667727 100644 --- a/lib/Cake/View/Helper/JqueryEngineHelper.php +++ b/lib/Cake/View/Helper/JqueryEngineHelper.php @@ -145,7 +145,7 @@ class JqueryEngineHelper extends JsBaseEngineHelper { * Create javascript selector for a CSS rule * * @param string $selector The selector that is targeted - * @return JqueryEngineHelper instance of $this. Allows chained methods. + * @return $this */ public function get($selector) { if ($selector === 'window' || $selector === 'document') { diff --git a/lib/Cake/View/Helper/MootoolsEngineHelper.php b/lib/Cake/View/Helper/MootoolsEngineHelper.php index c5b637f97..33665b89d 100644 --- a/lib/Cake/View/Helper/MootoolsEngineHelper.php +++ b/lib/Cake/View/Helper/MootoolsEngineHelper.php @@ -118,7 +118,7 @@ class MootoolsEngineHelper extends JsBaseEngineHelper { * Create javascript selector for a CSS rule * * @param string $selector The selector that is targeted - * @return MootoolsEngineHelper instance of $this. Allows chained methods. + * @return $this */ public function get($selector) { $this->_multipleSelection = false; diff --git a/lib/Cake/View/Helper/PrototypeEngineHelper.php b/lib/Cake/View/Helper/PrototypeEngineHelper.php index f76e179d1..7f6abcdfb 100644 --- a/lib/Cake/View/Helper/PrototypeEngineHelper.php +++ b/lib/Cake/View/Helper/PrototypeEngineHelper.php @@ -114,7 +114,7 @@ class PrototypeEngineHelper extends JsBaseEngineHelper { * Create javascript selector for a CSS rule * * @param string $selector The selector that is targeted - * @return PrototypeEngineHelper instance of $this. Allows chained methods. + * @return $this */ public function get($selector) { $this->_multiple = false;