Fix up doc block return types for chaining.

cakephp · Jan 14, 2017 · cd379b2 · cd379b2
1 parent ec7f590
commit cd379b2
Show file tree

Hide file tree

Showing 57 changed files with 326 additions and 328 deletions.
diff --git a/src/Console/ConsoleOptionParser.php b/src/Console/ConsoleOptionParser.php
@@ -169,11 +169,11 @@ public function __construct($command = null, $defaultOptions = true)
      *
      * @param string|null $command The command name this parser is for. The command name is used for generating help.
      * @param bool $defaultOptions Whether you want the verbose and quiet options set.
-     * @return self
+     * @return static
      */
     public static function create($command, $defaultOptions = true)
     {
-        return new ConsoleOptionParser($command, $defaultOptions);
+        return new static($command, $defaultOptions);
     }
 
     /**
@@ -197,11 +197,11 @@ public static function create($command, $defaultOptions = true)
      *
      * @param array $spec The spec to build the OptionParser with.
      * @param bool $defaultOptions Whether you want the verbose and quiet options set.
-     * @return self
+     * @return static
      */
     public static function buildFromArray($spec, $defaultOptions = true)
     {
-        $parser = new ConsoleOptionParser($spec['command'], $defaultOptions);
+        $parser = new static($spec['command'], $defaultOptions);
         if (!empty($spec['arguments'])) {
             $parser->addArguments($spec['arguments']);
         }
@@ -244,7 +244,7 @@ public function toArray()
      * Get or set the command name for shell/task.
      *
      * @param array|\Cake\Console\ConsoleOptionParser $spec ConsoleOptionParser or spec to merge with.
-     * @return self
+     * @return $this
      */
     public function merge($spec)
     {
@@ -274,7 +274,7 @@ public function merge($spec)
      * Sets the command name for shell/task.
      *
      * @param string $text The text to set.
-     * @return self
+     * @return $this
      */
     public function setCommand($text)
     {
@@ -314,7 +314,7 @@ public function command($text = null)
      *
      * @param string|array $text The text to set. If an array the
      *   text will be imploded with "\n".
-     * @return self
+     * @return $this
      */
     public function setDescription($text)
     {
@@ -359,7 +359,7 @@ public function description($text = null)
      *
      * @param string|array $text The text to set. If an array the text will
      *   be imploded with "\n".
-     * @return self
+     * @return $this
      */
     public function setEpilog($text)
     {
@@ -421,7 +421,7 @@ public function epilog($text = null)
      * @param \Cake\Console\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 self
+     * @return $this
      */
     public function addOption($name, array $options = [])
     {
@@ -454,7 +454,7 @@ public function addOption($name, array $options = [])
      * Remove an option from the option parser.
      *
      * @param string $name The option name to remove.
-     * @return self
+     * @return $this
      */
     public function removeOption($name)
     {
@@ -479,7 +479,7 @@ public function removeOption($name)
      * @param \Cake\Console\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 self
+     * @return $this
      */
     public function addArgument($name, array $params = [])
     {
@@ -519,7 +519,7 @@ public function addArgument($name, array $params = [])
      *
      * @param array $args Array of arguments to add.
      * @see \Cake\Console\ConsoleOptionParser::addArgument()
-     * @return self
+     * @return $this
      */
     public function addArguments(array $args)
     {
@@ -540,7 +540,7 @@ public function addArguments(array $args)
      *
      * @param array $options Array of options to add.
      * @see \Cake\Console\ConsoleOptionParser::addOption()
-     * @return self
+     * @return $this
      */
     public function addOptions(array $options)
     {
@@ -568,7 +568,7 @@ public function addOptions(array $options)
      *
      * @param \Cake\Console\ConsoleInputSubcommand|string $name Name of the subcommand. Will also accept an instance of ConsoleInputSubcommand
      * @param array $options Array of params, see above.
-     * @return self
+     * @return $this
      */
     public function addSubcommand($name, array $options = [])
     {
@@ -624,7 +624,7 @@ protected function _mergeSubcommandHelpToParserDescription($options)
      * Remove a subcommand from the option parser.
      *
      * @param string $name The subcommand name to remove.
-     * @return self
+     * @return $this
      */
     public function removeSubcommand($name)
     {
@@ -637,7 +637,7 @@ public function removeSubcommand($name)
      * Add multiple subcommands at once.
      *
      * @param array $commands Array of subcommands.
-     * @return self
+     * @return $this
      */
     public function addSubcommands(array $commands)
     {

diff --git a/src/Core/InstanceConfigTrait.php b/src/Core/InstanceConfigTrait.php
@@ -197,7 +197,7 @@ public function config($key = null, $value = null, $merge = true)
      *
      * @param string|array $key The key to set, or a complete array of configs.
      * @param mixed|null $value The value to set.
-     * @return self The object itself.
+     * @return $this
      */
     public function configShallow($key, $value = null)
     {

diff --git a/src/Database/Connection.php b/src/Database/Connection.php
@@ -149,7 +149,7 @@ public function configName()
      * @param array $config Config for a new driver.
      * @throws \Cake\Database\Exception\MissingDriverException When a driver class is missing.
      * @throws \Cake\Database\Exception\MissingExtensionException When a driver's PHP extension is missing.
-     * @return self
+     * @return $this
      */
     public function setDriver($driver, $config = [])
     {
@@ -334,7 +334,7 @@ public function newQuery()
      * Sets a Schema\Collection object for this connection.
      *
      * @param \Cake\Database\Schema\Collection $collection The schema collection object
-     * @return self
+     * @return $this
      */
     public function setSchemaCollection(SchemaCollection $collection)
     {
@@ -521,7 +521,7 @@ public function rollback()
      * `$connection->enableSavePoints(false)` Disables usage of savepoints and returns false
      *
      * @param bool $enable Whether or not save points should be used.
-     * @return self
+     * @return $this
      */
     public function enableSavePoints($enable)
     {

diff --git a/src/Database/Driver.php b/src/Database/Driver.php
@@ -301,7 +301,7 @@ public function isConnected()
      * in queries.
      *
      * @param bool $enable Whether to enable auto quoting
-     * @return self
+     * @return $this
      */
     public function enableAutoQuoting($enable = true)
     {

diff --git a/src/Database/Expression/CaseExpression.php b/src/Database/Expression/CaseExpression.php
@@ -83,7 +83,7 @@ public function __construct($conditions = [], $values = [], $types = [])
      * @param array|\Cake\Database\ExpressionInterface $values associative array of values of each condition
      * @param array $types associative array of types to be associated with the values
      *
-     * @return self
+     * @return $this
      */
     public function add($conditions = [], $values = [], $types = [])
     {

diff --git a/src/Database/Expression/FunctionExpression.php b/src/Database/Expression/FunctionExpression.php
@@ -77,7 +77,7 @@ public function __construct($name, $params = [], $types = [], $returnType = 'str
      * Sets the name of the SQL function to be invoke in this expression.
      *
      * @param string $name The name of the function
-     * @return self
+     * @return $this
      */
     public function setName($name)
     {
@@ -122,7 +122,7 @@ public function name($name = null)
      * passed arguments
      * @param bool $prepend Whether to prepend or append to the list of arguments
      * @see \Cake\Database\Expression\FunctionExpression::__construct() for more details.
-     * @return self
+     * @return $this
      */
     public function add($params, $types = [], $prepend = false)
     {

diff --git a/src/Database/Expression/QueryExpression.php b/src/Database/Expression/QueryExpression.php
@@ -77,7 +77,7 @@ public function __construct($conditions = [], $types = [], $conjunction = 'AND')
      *
      * @param string $conjunction Value to be used for joining conditions. If null it
      * will not set any value, but return the currently stored one
-     * @return self
+     * @return $this
      */
     public function setConjunction($conjunction)
     {
@@ -145,7 +145,7 @@ public function type($conjunction = null)
      * @param array $types associative array of fields pointing to the type of the
      * values that are being passed. Used for correctly binding values to statements.
      * @see \Cake\Database\Query::where() for examples on conditions
-     * @return self
+     * @return $this
      */
     public function add($conditions, $types = [])
     {
@@ -174,7 +174,7 @@ public function add($conditions, $types = [])
      * @param string|null $type the type name for $value as configured using the Type map.
      * If it is suffixed with "[]" and the value is an array then multiple placeholders
      * will be created, one per each value in the array.
-     * @return self
+     * @return $this
      */
     public function eq($field, $value, $type = null)
     {
@@ -193,7 +193,7 @@ public function eq($field, $value, $type = null)
      * @param string|null $type the type name for $value as configured using the Type map.
      * If it is suffixed with "[]" and the value is an array then multiple placeholders
      * will be created, one per each value in the array.
-     * @return self
+     * @return $this
      */
     public function notEq($field, $value, $type = null)
     {
@@ -210,7 +210,7 @@ public function notEq($field, $value, $type = null)
      * @param string $field Database field to be compared against value
      * @param mixed $value The value to be bound to $field for comparison
      * @param string|null $type the type name for $value as configured using the Type map.
-     * @return self
+     * @return $this
      */
     public function gt($field, $value, $type = null)
     {
@@ -227,7 +227,7 @@ public function gt($field, $value, $type = null)
      * @param string $field Database field to be compared against value
      * @param mixed $value The value to be bound to $field for comparison
      * @param string|null $type the type name for $value as configured using the Type map.
-     * @return self
+     * @return $this
      */
     public function lt($field, $value, $type = null)
     {
@@ -244,7 +244,7 @@ public function lt($field, $value, $type = null)
      * @param string $field Database field to be compared against value
      * @param mixed $value The value to be bound to $field for comparison
      * @param string|null $type the type name for $value as configured using the Type map.
-     * @return self
+     * @return $this
      */
     public function gte($field, $value, $type = null)
     {
@@ -261,7 +261,7 @@ public function gte($field, $value, $type = null)
      * @param string $field Database field to be compared against value
      * @param mixed $value The value to be bound to $field for comparison
      * @param string|null $type the type name for $value as configured using the Type map.
-     * @return self
+     * @return $this
      */
     public function lte($field, $value, $type = null)
     {
@@ -277,7 +277,7 @@ public function lte($field, $value, $type = null)
      *
      * @param string|\Cake\Database\ExpressionInterface $field database field to be
      * tested for null
-     * @return self
+     * @return $this
      */
     public function isNull($field)
     {
@@ -293,7 +293,7 @@ public function isNull($field)
      *
      * @param string|\Cake\Database\ExpressionInterface $field database field to be
      * tested for not null
-     * @return self
+     * @return $this
      */
     public function isNotNull($field)
     {
@@ -310,7 +310,7 @@ public function isNotNull($field)
      * @param string $field Database field to be compared against value
      * @param mixed $value The value to be bound to $field for comparison
      * @param string|null $type the type name for $value as configured using the Type map.
-     * @return self
+     * @return $this
      */
     public function like($field, $value, $type = null)
     {
@@ -327,7 +327,7 @@ public function like($field, $value, $type = null)
      * @param string $field Database field to be compared against value
      * @param mixed $value The value to be bound to $field for comparison
      * @param string|null $type the type name for $value as configured using the Type map.
-     * @return self
+     * @return $this
      */
     public function notLike($field, $value, $type = null)
     {
@@ -345,7 +345,7 @@ public function notLike($field, $value, $type = null)
      * @param string $field Database field to be compared against value
      * @param string|array $values the value to be bound to $field for comparison
      * @param string|null $type the type name for $value as configured using the Type map.
-     * @return self
+     * @return $this
      */
     public function in($field, $values, $type = null)
     {
@@ -368,7 +368,7 @@ public function in($field, $values, $type = null)
      * passed in $conditions. If there are more $values than $conditions, the last $value is used as the `ELSE` value
      * @param array $types associative array of types to be associated with the values
      * passed in $values
-     * @return self
+     * @return $this
      */
     public function addCase($conditions, $values = [], $types = [])
     {
@@ -382,7 +382,7 @@ public function addCase($conditions, $values = [], $types = [])
      * @param string $field Database field to be compared against value
      * @param array $values the value to be bound to $field for comparison
      * @param string|null $type the type name for $value as configured using the Type map.
-     * @return self
+     * @return $this
      */
     public function notIn($field, $values, $type = null)
     {
@@ -400,7 +400,7 @@ public function notIn($field, $values, $type = null)
      * Adds a new condition to the expression object in the form "EXISTS (...)".
      *
      * @param \Cake\Database\ExpressionInterface $query the inner query
-     * @return self
+     * @return $this
      */
     public function exists(ExpressionInterface $query)
     {
@@ -411,7 +411,7 @@ public function exists(ExpressionInterface $query)
      * Adds a new condition to the expression object in the form "NOT EXISTS (...)".
      *
      * @param \Cake\Database\ExpressionInterface $query the inner query
-     * @return self
+     * @return $this
      */
     public function notExists(ExpressionInterface $query)
     {
@@ -426,7 +426,7 @@ public function notExists(ExpressionInterface $query)
      * @param mixed $from The initial value of the range.
      * @param mixed $to The ending value in the comparison range.
      * @param string|null $type the type name for $value as configured using the Type map.
-     * @return self
+     * @return $this
      */
     public function between($field, $from, $to, $type = null)
     {
@@ -484,7 +484,7 @@ public function or_($conditions, $types = [])
      * @param string|array|\Cake\Database\Expression\QueryExpression $conditions to be added and negated
      * @param array $types associative array of fields pointing to the type of the
      * values that are being passed. Used for correctly binding values to statements.
-     * @return self
+     * @return $this
      */
     public function not($conditions, $types = [])
     {
@@ -508,7 +508,7 @@ public function count()
      *
      * @param string $left Left join condition field name.
      * @param string $right Right join condition field name.
-     * @return self
+     * @return $this
      */
     public function equalFields($left, $right)
     {
@@ -589,7 +589,7 @@ public function traverse(callable $callable)
      * modified part is stored.
      *
      * @param callable $callable The callable to apply to each part.
-     * @return self
+     * @return $this
      */
     public function iterateParts(callable $callable)
     {