remove double spaces in phpdoc (#10243)

Remove double spaces in docblocks.

src/Auth/FormAuthenticate.php

@@ -64,7 +64,7 @@ class FormAuthenticate extends BaseAuthenticate
      *
      * @param \Cake\Http\ServerRequest $request The request that contains login information.
      * @param \Cake\Network\Response $response Unused response object.
-     * @return mixed False on login failure.  An array of User data on success.
+     * @return mixed False on login failure. An array of User data on success.
      */
     public function authenticate(ServerRequest $request, Response $response)
     {

src/Cache/Cache.php

@@ -47,7 +47,7 @@ use RuntimeException;
  * There are 5 built-in caching engines:
  *
  * - `FileEngine` - Uses simple files to store content. Poor performance, but good for
- *    storing large objects, or things that are not IO sensitive.  Well suited to development
+ *    storing large objects, or things that are not IO sensitive. Well suited to development
  *    as it is an easy cache to inspect and manually flush.
  * - `ApcEngine` - Uses the APC object cache, one of the fastest caching engines.
  * - `MemcacheEngine` - Uses the PECL::Memcache extension and Memcached for storage.

src/Console/ConsoleOutput.php

@@ -306,7 +306,7 @@ class ConsoleOutput
      * Get/Set the output type to use. The output type how formatting tags are treated.
      *
      * @param int|null $type The output type to use. Should be one of the class constants.
-     * @return int|null  Either null or the value if getting.
+     * @return int|null Either null or the value if getting.
      */
     public function outputAs($type = null)
     {

src/Console/Exception/ConsoleException.php

@@ -16,7 +16,7 @@ namespace Cake\Console\Exception;
 use Cake\Core\Exception\Exception;
 
 /**
- * Exception class for Console libraries.  This exception will be thrown from Console library
+ * Exception class for Console libraries. This exception will be thrown from Console library
  * classes when they encounter an error.
  */
 class ConsoleException extends Exception

src/Controller/Component/SecurityComponent.php

@@ -61,7 +61,7 @@ class SecurityComponent extends Component
      *   and hidden unlocked fields do not have their values checked.
      * - `unlockedActions` - Actions to exclude from POST validation checks.
      *   Other checks like requireAuth(), requireSecure() etc. will still be applied.
-     * - `validatePost` -  Whether to validate POST data. Set to false to disable
+     * - `validatePost` - Whether to validate POST data. Set to false to disable
      *   for data coming from 3rd party services, etc.
      *
      * @var array

src/Database/Dialect/MysqlDialectTrait.php

@@ -29,7 +29,7 @@ trait MysqlDialectTrait
     use SqlDialectTrait;
 
     /**
-     *  String used to start a database identifier quoting to make it safe
+     * String used to start a database identifier quoting to make it safe
      *
      * @var string
      */

src/Database/Dialect/PostgresDialectTrait.php

@@ -30,7 +30,7 @@ trait PostgresDialectTrait
     use SqlDialectTrait;
 
     /**
-     *  String used to start a database identifier quoting to make it safe
+     * String used to start a database identifier quoting to make it safe
      *
      * @var string
      */

src/Database/Dialect/SqliteDialectTrait.php

@@ -31,7 +31,7 @@ trait SqliteDialectTrait
     use TupleComparisonTranslatorTrait;
 
     /**
-     *  String used to start a database identifier quoting to make it safe
+     * String used to start a database identifier quoting to make it safe
      *
      * @var string
      */

src/Database/Expression/FunctionExpression.php

@@ -51,7 +51,7 @@ class FunctionExpression extends QueryExpression implements TypedResultInterface
      *
      * ### Examples:
      *
-     *  `$f = new FunctionExpression('CONCAT', ['CakePHP', ' rules']);`
+     * `$f = new FunctionExpression('CONCAT', ['CakePHP', ' rules']);`
      *
      * Previous line will generate `CONCAT('CakePHP', ' rules')`
      *

src/Datasource/EntityInterface.php

@@ -190,7 +190,7 @@ interface EntityInterface extends ArrayAccess, JsonSerializable
      * Stores whether or not a property value can be changed or set in this entity.
      * The special property `*` can also be marked as accessible or protected, meaning
      * that any other property specified before will take its value. For example
-     * `$entity->accessible('*', true)`  means that any property not specified already
+     * `$entity->accessible('*', true)` means that any property not specified already
      * will be accessible by default.
      *
      * @param string|array $property Either a single or list of properties to change its accessibility.

src/Datasource/EntityTrait.php

@@ -1066,7 +1066,7 @@ trait EntityTrait
      * Stores whether or not a property value can be changed or set in this entity.
      * The special property `*` can also be marked as accessible or protected, meaning
      * that any other property specified before will take its value. For example
-     * `$entity->accessible('*', true)`  means that any property not specified already
+     * `$entity->accessible('*', true)` means that any property not specified already
      * will be accessible by default.
      *
      * You can also call this method with an array of properties, in which case they
@@ -1109,7 +1109,7 @@ trait EntityTrait
      * Stores whether or not a property value can be changed or set in this entity.
      * The special property `*` can also be marked as accessible or protected, meaning
      * that any other property specified before will take its value. For example
-     * `$entity->accessible('*', true)`  means that any property not specified already
+     * `$entity->accessible('*', true)` means that any property not specified already
      * will be accessible by default.
      *
      * You can also call this method with an array of properties, in which case they

src/Error/Debugger.php

@@ -261,7 +261,7 @@ class Debugger
      * - `depth` - The number of stack frames to return. Defaults to 999
      * - `format` - The format you want the return. Defaults to the currently selected format. If
      *    format is 'array' or 'points' the return will be an array.
-     * - `args` - Should arguments for functions be shown?  If true, the arguments for each method call
+     * - `args` - Should arguments for functions be shown? If true, the arguments for each method call
      *   will be displayed.
      * - `start` - The stack frame to start generating a trace from. Defaults to 0
      *
@@ -282,7 +282,7 @@ class Debugger
      * - `depth` - The number of stack frames to return. Defaults to 999
      * - `format` - The format you want the return. Defaults to the currently selected format. If
      *    format is 'array' or 'points' the return will be an array.
-     * - `args` - Should arguments for functions be shown?  If true, the arguments for each method call
+     * - `args` - Should arguments for functions be shown? If true, the arguments for each method call
      *   will be displayed.
      * - `start` - The stack frame to start generating a trace from. Defaults to 0
      *

src/Error/ErrorHandler.php

@@ -61,7 +61,7 @@ use Exception;
  *
  * Error handler also provides the built in features for handling php errors (trigger_error).
  * While in debug mode, errors will be output to the screen using debugger. While in production mode,
- * errors will be logged to Log.  You can control which errors are logged by setting
+ * errors will be logged to Log. You can control which errors are logged by setting
  * `errorLevel` option in config/error.php.
  *
  * #### Logging errors

src/Http/Runner.php

@@ -52,7 +52,7 @@ class Runner
     }
 
     /**
-     * @param \Psr\Http\Message\ServerRequestInterface $request  The server request
+     * @param \Psr\Http\Message\ServerRequestInterface $request The server request
      * @param \Psr\Http\Message\ResponseInterface $response The response object
      * @return \Psr\Http\Message\ResponseInterface An updated response
      */

src/Http/ServerRequest.php

@@ -235,8 +235,8 @@ class ServerRequest implements ArrayAccess, ServerRequestInterface
     /**
      * Create a new request object.
      *
-     * You can supply the data as either an array or as a string.  If you use
-     * a string you can only supply the URL for the request.  Using an array will
+     * You can supply the data as either an array or as a string. If you use
+     * a string you can only supply the URL for the request. Using an array will
      * let you provide the following keys:
      *
      * - `post` POST data or non query string data

src/I18n/DateFormatTrait.php

@@ -147,7 +147,7 @@ trait DateFormatTrait
      * ```
      *
      * You can control the default locale to be used by setting the static variable
-     * `Time::$defaultLocale` to a  valid locale string. If empty, the default will be
+     * `Time::$defaultLocale` to a valid locale string. If empty, the default will be
      * taken from the `intl.default_locale` ini config.
      *
      * @param string|int|null $format Format string.

src/I18n/MessagesFileLoader.php

@@ -70,7 +70,7 @@ class MessagesFileLoader
      * $package = $loader();
      * ```
      *
-     * Load and parse  src/Locale/fr_FR/validation.mo
+     * Load and parse src/Locale/fr_FR/validation.mo
      *
      * ```
      * $loader = new MessagesFileLoader('validation', 'fr_FR', 'mo');

src/I18n/Middleware/LocaleSelectorMiddleware.php

@@ -44,7 +44,7 @@ class LocaleSelectorMiddleware
     }
 
     /**
-     * @param ServerRequestInterface $request  The request.
+     * @param ServerRequestInterface $request The request.
      * @param ResponseInterface $response The response.
      * @param callable $next The next middleware to call.
      * @return \Psr\Http\Message\ResponseInterface A response.

src/Log/Log.php

@@ -18,8 +18,8 @@ use Cake\Log\Engine\BaseLog;
 use InvalidArgumentException;
 
 /**
- * Logs messages to configured Log adapters.  One or more adapters
- * can be configured using Cake Logs's methods.  If you don't
+ * Logs messages to configured Log adapters. One or more adapters
+ * can be configured using Cake Logs's methods. If you don't
  * configure any adapters, and write to Log, the messages will be
  * ignored.
  *
@@ -78,7 +78,7 @@ use InvalidArgumentException;
  *
  * ### Writing to the log
  *
- * You write to the logs using Log::write().  See its documentation for more information.
+ * You write to the logs using Log::write(). See its documentation for more information.
  *
  * ### Logging Levels
  *
@@ -94,11 +94,11 @@ use InvalidArgumentException;
  * ### Logging scopes
  *
  * When logging messages and configuring log adapters, you can specify
- * 'scopes' that the logger will handle.  You can think of scopes as subsystems
- * in your application that may require different logging setups.  For
+ * 'scopes' that the logger will handle. You can think of scopes as subsystems
+ * in your application that may require different logging setups. For
  * example in an e-commerce application you may want to handle logged errors
  * in the cart and ordering subsystems differently than the rest of the
- * application.  By using scopes you can control logging for each part
+ * application. By using scopes you can control logging for each part
  * of your application and also use standard log levels.
  */
 class Log
@@ -201,7 +201,7 @@ class Log
     }
 
     /**
-     * Reset all the connected loggers.  This is useful to do when changing the logging
+     * Reset all the connected loggers. This is useful to do when changing the logging
      * configuration or during testing when you want to reset the internal state of the
      * Log class.
      *

src/Network/Exception/InvalidCsrfTokenException.php

@@ -21,7 +21,7 @@ class InvalidCsrfTokenException extends HttpException
     /**
      * Constructor
      *
-     * @param string|null $message If no message is given 'Invalid  CSRF Token' will be the message
+     * @param string|null $message If no message is given 'Invalid CSRF Token' will be the message
      * @param int $code Status code, defaults to 403
      */
     public function __construct($message = null, $code = 403)

src/ORM/Association/BelongsToMany.php

@@ -1149,7 +1149,7 @@ class BelongsToMany extends Association
      * target entity contains the joint property with its primary key and any extra
      * information to be stored.
      *
-     * On success, the passed `$sourceEntity` will contain `$targetEntities` as  value
+     * On success, the passed `$sourceEntity` will contain `$targetEntities` as value
      * in the corresponding property for this association.
      *
      * This method assumes that links between both the source entity and each of the

src/ORM/Association/HasMany.php

@@ -381,7 +381,7 @@ class HasMany extends Association
      *
      * This method does not check link uniqueness.
      *
-     * On success, the passed `$sourceEntity` will contain `$targetEntities` as  value
+     * On success, the passed `$sourceEntity` will contain `$targetEntities` as value
      * in the corresponding property for this association.
      *
      * Additional options for new links to be saved can be passed in the third argument,

src/ORM/AssociationsNormalizerTrait.php

@@ -16,7 +16,7 @@ namespace Cake\ORM;
 
 /**
  * Contains methods for parsing the associated tables array that is typically
- * passed to  a save operation
+ * passed to a save operation
  */
 trait AssociationsNormalizerTrait
 {

src/Routing/Route/Route.php

@@ -58,7 +58,7 @@ class Route
     public $template = null;
 
     /**
-     * Is this route a greedy route?  Greedy routes have a `/*` in their
+     * Is this route a greedy route? Greedy routes have a `/*` in their
      * template
      *
      * @var bool
@@ -73,7 +73,7 @@ class Route
     protected $_compiledRoute = null;
 
     /**
-     * The name for a route.  Fetch with Route::getName();
+     * The name for a route. Fetch with Route::getName();
      *
      * @var string|null
      */
@@ -422,7 +422,7 @@ class Route
      * Return true if a given named $param's $val matches a given $rule depending on $context.
      * Currently implemented rule types are controller, action and match that can be combined with each other.
      *
-     * @param string $args A string with the passed params.  eg. /1/foo
+     * @param string $args A string with the passed params. eg. /1/foo
      * @param string $context The current route context, which should contain controller/action keys.
      * @return array Array of passed args.
      */

src/Routing/RouteCollection.php

@@ -190,7 +190,7 @@ class RouteCollection
     }
 
     /**
-     * Get the set of names from the $url.  Accepts both older style array urls,
+     * Get the set of names from the $url. Accepts both older style array urls,
      * and newer style urls containing '_name'
      *
      * @param array $url The url to match.

src/Routing/Router.php

@@ -448,7 +448,7 @@ class Router
 
 
     /**
-     * Pops a request off of the request stack.  Used when doing requestAction
+     * Pops a request off of the request stack. Used when doing requestAction
      *
      * @return \Cake\Http\ServerRequest The request removed from the stack.
      * @see \Cake\Routing\Router::pushRequest()
@@ -578,7 +578,7 @@ class Router
      *   cake relative URLs are required when using requestAction.
      * - `_scheme` - Set to create links on different schemes like `webcal` or `ftp`. Defaults
      *   to the current scheme.
-     * - `_host` - Set the host to use for the link.  Defaults to the current host.
+     * - `_host` - Set the host to use for the link. Defaults to the current host.
      * - `_port` - Set the port if you need to create links on non-standard ports.
      * - `_full` - If true output of `Router::fullBaseUrl()` will be prepended to generated URLs.
      * - `#` - Allows you to set URL hash fragments.
@@ -856,7 +856,7 @@ class Router
      *
      * ### Options
      *
-     * - `separator` The string to use as a separator.  Defaults to `:`.
+     * - `separator` The string to use as a separator. Defaults to `:`.
      *
      * @param \Cake\Http\ServerRequest $request The request object to modify.
      * @param array $options The array of options.

src/Utility/Exception/XmlException.php

@@ -15,7 +15,7 @@ namespace Cake\Utility\Exception;
 use RuntimeException;
 
 /**
- * Exception class for Xml.  This exception will be thrown from Xml when it
+ * Exception class for Xml. This exception will be thrown from Xml when it
  * encounters an error.
  */
 class XmlException extends RuntimeException

src/Utility/Hash.php

@@ -446,7 +446,7 @@ class Hash
      * @param string|null $groupPath A dot-separated string.
      * @return array Combined array
      * @link http://book.cakephp.org/3.0/en/core-libraries/hash.html#Cake\Utility\Hash::combine
-     * @throws \RuntimeException  When keys and values count is unequal.
+     * @throws \RuntimeException When keys and values count is unequal.
      */
     public static function combine(array $data, $keyPath, $valuePath = null, $groupPath = null)
     {

src/Utility/Xml.php

@@ -195,7 +195,7 @@ class Xml
      * ];
      * ```
      *
-     * Calling `Xml::fromArray($value, 'tags');`  Will generate:
+     * Calling `Xml::fromArray($value, 'tags');` Will generate:
      *
      * `<root><tag><id>1</id><value>defect</value>description</tag></root>`
      *

src/View/Helper/PaginatorHelper.php

@@ -50,7 +50,7 @@ class PaginatorHelper extends Helper
      * The values that may be specified are:
      *
      * - `url` Url of the action. See Router::url()
-     * - `url['sort']`  the key that the recordset is sorted.
+     * - `url['sort']` the key that the recordset is sorted.
      * - `url['direction']` Direction of the sorting (default: 'asc').
      * - `url['page']` Page number to use in links.
      * - `model` The name of the model.

src/View/Helper/SessionHelper.php

@@ -29,7 +29,7 @@ class SessionHelper extends Helper
 {
 
     /**
-     *  Constructor
+     * Constructor
      *
      * @param \Cake\View\View $View The View this helper is being attached to.
      * @param array $config Configuration settings for the helper.