From d90a98ea215e5a47eaa49c67deb7fdb71bad8a8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eric=20B=C3=BCttner?= Date: Thu, 16 Feb 2017 19:33:32 +0100 Subject: [PATCH] remove double spaces in phpdoc (#10243) Remove double spaces in docblocks. --- src/Auth/FormAuthenticate.php | 2 +- src/Cache/Cache.php | 2 +- src/Console/ConsoleOutput.php | 2 +- src/Console/Exception/ConsoleException.php | 2 +- src/Controller/Component/SecurityComponent.php | 2 +- src/Database/Dialect/MysqlDialectTrait.php | 2 +- src/Database/Dialect/PostgresDialectTrait.php | 2 +- src/Database/Dialect/SqliteDialectTrait.php | 2 +- src/Database/Expression/FunctionExpression.php | 2 +- src/Datasource/EntityInterface.php | 2 +- src/Datasource/EntityTrait.php | 4 ++-- src/Error/Debugger.php | 4 ++-- src/Error/ErrorHandler.php | 2 +- src/Http/Runner.php | 2 +- src/Http/ServerRequest.php | 4 ++-- src/I18n/DateFormatTrait.php | 2 +- src/I18n/MessagesFileLoader.php | 2 +- src/I18n/Middleware/LocaleSelectorMiddleware.php | 2 +- src/Log/Log.php | 14 +++++++------- .../Exception/InvalidCsrfTokenException.php | 2 +- src/ORM/Association/BelongsToMany.php | 2 +- src/ORM/Association/HasMany.php | 2 +- src/ORM/AssociationsNormalizerTrait.php | 2 +- src/Routing/Route/Route.php | 6 +++--- src/Routing/RouteCollection.php | 2 +- src/Routing/Router.php | 6 +++--- src/Utility/Exception/XmlException.php | 2 +- src/Utility/Hash.php | 2 +- src/Utility/Xml.php | 2 +- src/View/Helper/PaginatorHelper.php | 2 +- src/View/Helper/SessionHelper.php | 2 +- 31 files changed, 44 insertions(+), 44 deletions(-) diff --git a/src/Auth/FormAuthenticate.php b/src/Auth/FormAuthenticate.php index cbf2ee12b68..f3c05ed1b16 100644 --- a/src/Auth/FormAuthenticate.php +++ b/src/Auth/FormAuthenticate.php @@ -64,7 +64,7 @@ protected function _checkFields(ServerRequest $request, array $fields) * * @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) { diff --git a/src/Cache/Cache.php b/src/Cache/Cache.php index 81a76a7e85c..7ed70568a9e 100644 --- a/src/Cache/Cache.php +++ b/src/Cache/Cache.php @@ -47,7 +47,7 @@ * 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. diff --git a/src/Console/ConsoleOutput.php b/src/Console/ConsoleOutput.php index e31a7f19875..90c2b2a037a 100644 --- a/src/Console/ConsoleOutput.php +++ b/src/Console/ConsoleOutput.php @@ -306,7 +306,7 @@ public function styles($style = null, $definition = null) * 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) { diff --git a/src/Console/Exception/ConsoleException.php b/src/Console/Exception/ConsoleException.php index 3d46167dae4..12124972489 100644 --- a/src/Console/Exception/ConsoleException.php +++ b/src/Console/Exception/ConsoleException.php @@ -16,7 +16,7 @@ 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 diff --git a/src/Controller/Component/SecurityComponent.php b/src/Controller/Component/SecurityComponent.php index c657c32a421..a53be88664d 100644 --- a/src/Controller/Component/SecurityComponent.php +++ b/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 diff --git a/src/Database/Dialect/MysqlDialectTrait.php b/src/Database/Dialect/MysqlDialectTrait.php index 19f2fe720ef..f4560472eeb 100644 --- a/src/Database/Dialect/MysqlDialectTrait.php +++ b/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 */ diff --git a/src/Database/Dialect/PostgresDialectTrait.php b/src/Database/Dialect/PostgresDialectTrait.php index 36d6e1f2f06..a6306dd22e2 100644 --- a/src/Database/Dialect/PostgresDialectTrait.php +++ b/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 */ diff --git a/src/Database/Dialect/SqliteDialectTrait.php b/src/Database/Dialect/SqliteDialectTrait.php index 5387d94275c..fd13db5e38c 100644 --- a/src/Database/Dialect/SqliteDialectTrait.php +++ b/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 */ diff --git a/src/Database/Expression/FunctionExpression.php b/src/Database/Expression/FunctionExpression.php index 3318c9eb451..9a91bdcc372 100644 --- a/src/Database/Expression/FunctionExpression.php +++ b/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')` * diff --git a/src/Datasource/EntityInterface.php b/src/Datasource/EntityInterface.php index c66b916d17a..8fc6ea2283e 100644 --- a/src/Datasource/EntityInterface.php +++ b/src/Datasource/EntityInterface.php @@ -190,7 +190,7 @@ public function errors($field = null, $errors = null, $overwrite = false); * 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. diff --git a/src/Datasource/EntityTrait.php b/src/Datasource/EntityTrait.php index 3163522ae03..46859b7bcf1 100644 --- a/src/Datasource/EntityTrait.php +++ b/src/Datasource/EntityTrait.php @@ -1066,7 +1066,7 @@ public function invalid($field = null, $value = null, $overwrite = false) * 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 @@ public function accessible($property, $set = null) * 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 diff --git a/src/Error/Debugger.php b/src/Error/Debugger.php index c720dd66eef..10f3cb6f025 100644 --- a/src/Error/Debugger.php +++ b/src/Error/Debugger.php @@ -261,7 +261,7 @@ public static function log($var, $level = 'debug', $depth = 3) * - `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 @@ public static function trace(array $options = []) * - `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 * diff --git a/src/Error/ErrorHandler.php b/src/Error/ErrorHandler.php index fd3c386f6f9..36cca1ba241 100644 --- a/src/Error/ErrorHandler.php +++ b/src/Error/ErrorHandler.php @@ -61,7 +61,7 @@ * * 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 diff --git a/src/Http/Runner.php b/src/Http/Runner.php index f5e73a06e54..4fecc51e43d 100644 --- a/src/Http/Runner.php +++ b/src/Http/Runner.php @@ -52,7 +52,7 @@ public function run($middleware, ServerRequestInterface $request, ResponseInterf } /** - * @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 */ diff --git a/src/Http/ServerRequest.php b/src/Http/ServerRequest.php index 8510a376294..0a439abff99 100644 --- a/src/Http/ServerRequest.php +++ b/src/Http/ServerRequest.php @@ -235,8 +235,8 @@ public static function createFromGlobals() /** * 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 diff --git a/src/I18n/DateFormatTrait.php b/src/I18n/DateFormatTrait.php index 44e17437de4..1d66fdd3f5d 100644 --- a/src/I18n/DateFormatTrait.php +++ b/src/I18n/DateFormatTrait.php @@ -147,7 +147,7 @@ public function nice($timezone = null, $locale = null) * ``` * * 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. diff --git a/src/I18n/MessagesFileLoader.php b/src/I18n/MessagesFileLoader.php index a7ec60f4e69..c7be87a5ec7 100644 --- a/src/I18n/MessagesFileLoader.php +++ b/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'); diff --git a/src/I18n/Middleware/LocaleSelectorMiddleware.php b/src/I18n/Middleware/LocaleSelectorMiddleware.php index 0b3805a7b00..834e56bb3dc 100644 --- a/src/I18n/Middleware/LocaleSelectorMiddleware.php +++ b/src/I18n/Middleware/LocaleSelectorMiddleware.php @@ -44,7 +44,7 @@ public function __construct(array $locales = []) } /** - * @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. diff --git a/src/Log/Log.php b/src/Log/Log.php index 9c2c96a848f..06d05f81023 100644 --- a/src/Log/Log.php +++ b/src/Log/Log.php @@ -18,8 +18,8 @@ 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 @@ * * ### 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 @@ * ### 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 @@ protected static function _loadConfig() } /** - * 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. * diff --git a/src/Network/Exception/InvalidCsrfTokenException.php b/src/Network/Exception/InvalidCsrfTokenException.php index 2163f80bf70..423771e88d5 100644 --- a/src/Network/Exception/InvalidCsrfTokenException.php +++ b/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) diff --git a/src/ORM/Association/BelongsToMany.php b/src/ORM/Association/BelongsToMany.php index 32d6e4db474..ed8acddb8eb 100644 --- a/src/ORM/Association/BelongsToMany.php +++ b/src/ORM/Association/BelongsToMany.php @@ -1149,7 +1149,7 @@ protected function _appendJunctionJoin($query, $conditions) * 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 diff --git a/src/ORM/Association/HasMany.php b/src/ORM/Association/HasMany.php index cdeede6484b..5000a9b55db 100644 --- a/src/ORM/Association/HasMany.php +++ b/src/ORM/Association/HasMany.php @@ -381,7 +381,7 @@ function ($assoc) use ($targetEntities) { * * 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, diff --git a/src/ORM/AssociationsNormalizerTrait.php b/src/ORM/AssociationsNormalizerTrait.php index 1c593fdf232..1f0163d7cc4 100644 --- a/src/ORM/AssociationsNormalizerTrait.php +++ b/src/ORM/AssociationsNormalizerTrait.php @@ -16,7 +16,7 @@ /** * Contains methods for parsing the associated tables array that is typically - * passed to a save operation + * passed to a save operation */ trait AssociationsNormalizerTrait { diff --git a/src/Routing/Route/Route.php b/src/Routing/Route/Route.php index bed41d65c69..8326e63dc48 100644 --- a/src/Routing/Route/Route.php +++ b/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 @@ protected function _parseExtension($url) * 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. */ diff --git a/src/Routing/RouteCollection.php b/src/Routing/RouteCollection.php index 3c88197b03d..86dce8b3ca4 100644 --- a/src/Routing/RouteCollection.php +++ b/src/Routing/RouteCollection.php @@ -190,7 +190,7 @@ public function parseRequest(ServerRequestInterface $request) } /** - * 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. diff --git a/src/Routing/Router.php b/src/Routing/Router.php index 54902640bf8..6b5200b82bc 100644 --- a/src/Routing/Router.php +++ b/src/Routing/Router.php @@ -448,7 +448,7 @@ public static function setRequestContext($request) /** - * 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 @@ protected static function _applyUrlFilters($url) * 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 @@ public static function extensions($extensions = null, $merge = true) * * ### 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. diff --git a/src/Utility/Exception/XmlException.php b/src/Utility/Exception/XmlException.php index af4c2051fa7..135c9a9c276 100644 --- a/src/Utility/Exception/XmlException.php +++ b/src/Utility/Exception/XmlException.php @@ -15,7 +15,7 @@ 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 diff --git a/src/Utility/Hash.php b/src/Utility/Hash.php index 2155982fbe0..c7a3ee88fec 100644 --- a/src/Utility/Hash.php +++ b/src/Utility/Hash.php @@ -446,7 +446,7 @@ public static function remove(array $data, $path) * @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) { diff --git a/src/Utility/Xml.php b/src/Utility/Xml.php index 594afb58df2..f81b6c5eddf 100644 --- a/src/Utility/Xml.php +++ b/src/Utility/Xml.php @@ -195,7 +195,7 @@ protected static function _loadXml($input, $options) * ]; * ``` * - * Calling `Xml::fromArray($value, 'tags');` Will generate: + * Calling `Xml::fromArray($value, 'tags');` Will generate: * * `1defectdescription` * diff --git a/src/View/Helper/PaginatorHelper.php b/src/View/Helper/PaginatorHelper.php index ea6ae69fbf4..cc1b0efa873 100644 --- a/src/View/Helper/PaginatorHelper.php +++ b/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. diff --git a/src/View/Helper/SessionHelper.php b/src/View/Helper/SessionHelper.php index a7ea9531cad..6455b8ebc58 100644 --- a/src/View/Helper/SessionHelper.php +++ b/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.