Skip to content

Commit

Permalink
remove double spaces in phpdoc (#10243)
Browse files Browse the repository at this point in the history
Remove double spaces in docblocks.
  • Loading branch information
tuffz authored and ADmad committed Feb 16, 2017
1 parent e4585da commit d90a98e
Show file tree
Hide file tree
Showing 31 changed files with 44 additions and 44 deletions.
2 changes: 1 addition & 1 deletion src/Auth/FormAuthenticate.php
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Cache/Cache.php
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/Console/ConsoleOutput.php
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Console/Exception/ConsoleException.php
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Controller/Component/SecurityComponent.php
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Dialect/MysqlDialectTrait.php
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Dialect/PostgresDialectTrait.php
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Dialect/SqliteDialectTrait.php
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Expression/FunctionExpression.php
Expand Up @@ -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')`
*
Expand Down
2 changes: 1 addition & 1 deletion src/Datasource/EntityInterface.php
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/Datasource/EntityTrait.php
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/Error/Debugger.php
Expand Up @@ -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
*
Expand All @@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion src/Error/ErrorHandler.php
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Http/Runner.php
Expand Up @@ -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
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Http/ServerRequest.php
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/I18n/DateFormatTrait.php
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/I18n/MessagesFileLoader.php
Expand Up @@ -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');
Expand Down
2 changes: 1 addition & 1 deletion src/I18n/Middleware/LocaleSelectorMiddleware.php
Expand Up @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions src/Log/Log.php
Expand Up @@ -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.
*
Expand Down Expand Up @@ -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
*
Expand All @@ -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
Expand Down Expand Up @@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Network/Exception/InvalidCsrfTokenException.php
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/ORM/Association/BelongsToMany.php
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ORM/Association/HasMany.php
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion src/ORM/AssociationsNormalizerTrait.php
Expand Up @@ -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
{
Expand Down
6 changes: 3 additions & 3 deletions src/Routing/Route/Route.php
Expand Up @@ -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
Expand All @@ -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
*/
Expand Down Expand Up @@ -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.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Routing/RouteCollection.php
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions src/Routing/Router.php
Expand Up @@ -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()
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/Utility/Exception/XmlException.php
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Utility/Hash.php
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Utility/Xml.php
Expand Up @@ -195,7 +195,7 @@ protected static function _loadXml($input, $options)
* ];
* ```
*
* 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>`
*
Expand Down
2 changes: 1 addition & 1 deletion src/View/Helper/PaginatorHelper.php
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/View/Helper/SessionHelper.php
Expand Up @@ -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.
Expand Down

0 comments on commit d90a98e

Please sign in to comment.