Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Make all doc block classes FQCN as per CS.
  • Loading branch information
Mark Scherer committed Feb 2, 2016
1 parent 006c5a3 commit 72f5332
Show file tree
Hide file tree
Showing 69 changed files with 119 additions and 103 deletions.
6 changes: 3 additions & 3 deletions src/Auth/BaseAuthenticate.php
Expand Up @@ -58,14 +58,14 @@ abstract class BaseAuthenticate implements EventListenerInterface
/**
* A Component registry, used to get more components.
*
* @var ComponentRegistry
* @var \Cake\Controller\ComponentRegistry
*/
protected $_registry;

/**
* Password hasher instance.
*
* @var AbstractPasswordHasher
* @var \Cake\Auth\AbstractPasswordHasher
*/
protected $_passwordHasher;

Expand Down Expand Up @@ -152,7 +152,7 @@ protected function _query($username)
/**
* Return password hasher object
*
* @return AbstractPasswordHasher Password hasher instance
* @return \Cake\Auth\AbstractPasswordHasher Password hasher instance
* @throws \RuntimeException If password hasher class not found or
* it does not extend AbstractPasswordHasher
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/BaseAuthorize.php
Expand Up @@ -31,7 +31,7 @@ abstract class BaseAuthorize
/**
* ComponentRegistry instance for getting more components.
*
* @var ComponentRegistry
* @var \Cake\Controller\ComponentRegistry
*/
protected $_registry;

Expand Down
2 changes: 1 addition & 1 deletion src/Cache/Cache.php
Expand Up @@ -125,7 +125,7 @@ public static function registry(ObjectRegistry $registry = null)
if ($registry) {
static::$_registry = $registry;
}

if (empty(static::$_registry)) {
static::$_registry = new CacheRegistry();
}
Expand Down
4 changes: 2 additions & 2 deletions src/Cache/CacheRegistry.php
Expand Up @@ -63,10 +63,10 @@ protected function _throwMissingClassError($class, $plugin)
*
* Part of the template method for Cake\Core\ObjectRegistry::load()
*
* @param string|CacheEngine $class The classname or object to make.
* @param string|\Cake\Cache\CacheEngine $class The classname or object to make.
* @param string $alias The alias of the object.
* @param array $config An array of settings to use for the cache engine.
* @return CacheEngine The constructed CacheEngine class.
* @return \Cake\Cache\CacheEngine The constructed CacheEngine class.
* @throws \RuntimeException when an object doesn't implement the correct interface.
*/
protected function _create($class, $alias, $config)
Expand Down
4 changes: 2 additions & 2 deletions src/Cache/Engine/MemcachedEngine.php
Expand Up @@ -96,7 +96,7 @@ class MemcachedEngine extends CacheEngine
*
* @param array $config array of setting for the engine
* @return bool True if the engine has been successfully initialized, false if not
* @throws InvalidArgumentException When you try use authentication without
* @throws \InvalidArgumentException When you try use authentication without
* Memcached compiled with SASL support
*/
public function init(array $config = [])
Expand Down Expand Up @@ -189,7 +189,7 @@ public function init(array $config = [])
* Settings the memcached instance
*
* @return void
* @throws InvalidArgumentException When the Memcached extension is not built
* @throws \InvalidArgumentException When the Memcached extension is not built
* with the desired serializer engine.
*/
protected function _setOptions()
Expand Down
2 changes: 1 addition & 1 deletion src/Collection/Collection.php
Expand Up @@ -34,7 +34,7 @@ class Collection extends IteratorIterator implements CollectionInterface, Serial
* Constructor. You can provide an array or any traversable object
*
* @param array|\Traversable $items Items.
* @throws InvalidArgumentException If passed incorrect type for items.
* @throws \InvalidArgumentException If passed incorrect type for items.
*/
public function __construct($items)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Collection/Iterator/TreeIterator.php
Expand Up @@ -38,7 +38,7 @@ class TreeIterator extends RecursiveIteratorIterator
/**
* Constructor
*
* @param RecursiveIterator $items The iterator to flatten.
* @param \RecursiveIterator $items The iterator to flatten.
* @param int $mode Iterator mode.
* @param int $flags Iterator flags.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Console/ConsoleErrorHandler.php
Expand Up @@ -28,7 +28,7 @@ class ConsoleErrorHandler extends BaseErrorHandler
/**
* Standard error stream.
*
* @var ConsoleOutput
* @var \Cake\Console\ConsoleOutput
*/
protected $_stderr;

Expand Down
2 changes: 1 addition & 1 deletion src/Console/ConsoleInputSubcommand.php
Expand Up @@ -44,7 +44,7 @@ class ConsoleInputSubcommand
/**
* The ConsoleOptionParser for this subcommand.
*
* @var ConsoleOptionParser
* @var \Cake\Console\ConsoleOptionParser
*/
protected $_parser;

Expand Down
2 changes: 1 addition & 1 deletion src/Console/Shell.php
Expand Up @@ -137,7 +137,7 @@ class Shell
/**
* Task Collection for the command, used to create Tasks.
*
* @var TaskRegistry
* @var \Cake\Console\TaskRegistry
*/
public $Tasks;

Expand Down
2 changes: 1 addition & 1 deletion src/Console/TaskRegistry.php
Expand Up @@ -28,7 +28,7 @@ class TaskRegistry extends ObjectRegistry
/**
* Shell to use to set params to tasks.
*
* @var Shell
* @var \Cake\Console\Shell
*/
protected $_Shell;

Expand Down
2 changes: 1 addition & 1 deletion src/Controller/ComponentRegistry.php
Expand Up @@ -52,7 +52,7 @@ public function __construct(Controller $controller = null)
/**
* Get the controller associated with the collection.
*
* @return Controller Controller instance
* @return \Cake\Controller\Controller Controller instance
*/
public function getController()
{
Expand Down
2 changes: 1 addition & 1 deletion src/Core/Configure.php
Expand Up @@ -346,7 +346,7 @@ public static function dump($key, $config = 'default', $keys = [])
* Will create new PhpConfig for default if not configured yet.
*
* @param string $config The name of the configured adapter
* @return ConfigEngineInterface|false Engine instance or false
* @return \Cake\Core\Configure\ConfigEngineInterface|false Engine instance or false
*/
protected static function _getEngine($config)
{
Expand Down
1 change: 1 addition & 0 deletions src/Core/Configure/FileConfigTrait.php
Expand Up @@ -22,6 +22,7 @@
*/
trait FileConfigTrait
{

/**
* The path this engine finds files on.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Connection.php
Expand Up @@ -80,7 +80,7 @@ class Connection implements ConnectionInterface
/**
* Logger object instance.
*
* @var QueryLogger
* @var \Cake\Database\Log\QueryLogger
*/
protected $_logger = null;

Expand Down
4 changes: 2 additions & 2 deletions src/Database/Dialect/SqlserverDialectTrait.php
Expand Up @@ -136,8 +136,8 @@ protected function _pagingSubquery($original, $limit, $offset)
* Returns the passed query after rewriting the DISTINCT clause, so that drivers
* that do not support the "ON" part can provide the actual way it should be done
*
* @param Query $original The query to be transformed
* @return Query
* @param \Cake\Database\Query $original The query to be transformed
* @return \Cake\Database\Query
*/
protected function _transformDistinct($original)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Driver.php
Expand Up @@ -52,7 +52,7 @@ abstract class Driver
* Constructor
*
* @param array $config The configuration for the driver.
* @throws InvalidArgumentException
* @throws \InvalidArgumentException
*/
public function __construct($config = [])
{
Expand Down
14 changes: 7 additions & 7 deletions src/Database/Expression/CaseExpression.php
Expand Up @@ -44,16 +44,16 @@ class CaseExpression implements ExpressionInterface
/**
* The `ELSE` value for the case statement. If null then no `ELSE` will be included.
*
* @var string|ExpressionInterface|array|null
* @var string|\Cake\Database\ExpressionInterface|array|null
*/
protected $_elseValue = null;

/**
* Constructs the case expression
*
* @param array|ExpressionInterface $conditions The conditions to test. Must be a ExpressionInterface
* @param array|\Cake\Database\ExpressionInterface $conditions The conditions to test. Must be a ExpressionInterface
* instance, or an array of ExpressionInterface instances.
* @param array|ExpressionInterface $values associative array of values to be associated with the conditions
* @param array|\Cake\Database\ExpressionInterface $values associative array of values to be associated with the conditions
* 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
Expand All @@ -76,8 +76,8 @@ public function __construct($conditions = [], $values = [], $types = [])
* Conditions must be a one dimensional array or a QueryExpression.
* The trueValues must be a similar structure, but may contain a string value.
*
* @param array|ExpressionInterface $conditions Must be a ExpressionInterface instance, or an array of ExpressionInterface instances.
* @param array|ExpressionInterface $values associative array of values of each condition
* @param array|\Cake\Database\ExpressionInterface $conditions Must be a ExpressionInterface instance, or an array of ExpressionInterface instances.
* @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 $this
Expand All @@ -103,8 +103,8 @@ public function add($conditions = [], $values = [], $types = [])
* Iterates over the passed in conditions and ensures that there is a matching true value for each.
* If no matching true value, then it is defaulted to '1'.
*
* @param array|ExpressionInterface $conditions Must be a ExpressionInterface instance, or an array of ExpressionInterface instances.
* @param array|ExpressionInterface $values associative array of values of each condition
* @param array|\Cake\Database\ExpressionInterface $conditions Must be a ExpressionInterface instance, or an array of ExpressionInterface instances.
* @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 void
Expand Down
8 changes: 4 additions & 4 deletions src/Database/Expression/QueryExpression.php
Expand Up @@ -54,7 +54,7 @@ class QueryExpression implements ExpressionInterface, Countable
* expression objects. Optionally, you can set the conjunction keyword to be used
* for joining each part of this level of the expression tree.
*
* @param string|array|QueryExpression $conditions tree-like array structure containing all the conditions
* @param string|array|\Cake\Database\Expression\QueryExpression $conditions tree-like array structure containing all the conditions
* to be added or nested inside this expression object.
* @param array|\Cake\Database\TypeMap $types associative array of types to be associated with the values
* passed in $conditions.
Expand Down Expand Up @@ -323,9 +323,9 @@ public function in($field, $values, $type = null)
/**
* Adds a new case expression to the expression object
*
* @param array|ExpressionInterface $conditions The conditions to test. Must be a ExpressionInterface
* @param array|\Cake\Database\ExpressionInterface $conditions The conditions to test. Must be a ExpressionInterface
* instance, or an array of ExpressionInterface instances.
* @param array|ExpressionInterface $values associative array of values to be associated with the conditions
* @param array|\Cake\Database\ExpressionInterface $values associative array of values to be associated with the conditions
* 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
Expand Down Expand Up @@ -416,7 +416,7 @@ public function or_($conditions, $types = [])
* "NOT ( (condition1) AND (conditions2) )" conjunction depends on the one
* currently configured for this object.
*
* @param string|array|QueryExpression $conditions to be added and negated
* @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 $this
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Expression/TupleComparison.php
Expand Up @@ -30,7 +30,7 @@ class TupleComparison extends Comparison
* Constructor
*
* @param string|array $fields the fields to use to form a tuple
* @param array|ExpressionInterface $values the values to use to form a tuple
* @param array|\Cake\Database\ExpressionInterface $values the values to use to form a tuple
* @param array $types the types names to use for casting each of the values, only
* one type per position in the value array in needed
* @param string $conjunction the operator used for comparing field and value
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Expression/ValuesExpression.php
Expand Up @@ -69,7 +69,7 @@ public function __construct(array $columns, $typeMap)
/**
* Add a row of data to be inserted.
*
* @param array|Query $data Array of data to append into the insert, or
* @param array|\Cake\Database\Query $data Array of data to append into the insert, or
* a query for doing INSERT INTO .. SELECT style commands
* @return void
* @throws \Cake\Database\Exception When mixing array + Query data types.
Expand Down
1 change: 1 addition & 0 deletions src/Database/FieldTypeConverter.php
Expand Up @@ -22,6 +22,7 @@
*/
class FieldTypeConverter
{

/**
* An array containing the name of the fields and the Type objects
* each should use when converting them.
Expand Down
20 changes: 10 additions & 10 deletions src/Database/FunctionsBuilder.php
Expand Up @@ -32,7 +32,7 @@ class FunctionsBuilder
* @param array $params list of params to be passed to the function
* @param array $types list of types for each function param
* @param string $return The return type of the function expression
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
protected function _build($name, $params = [], $types = [], $return = 'string')
{
Expand All @@ -47,7 +47,7 @@ protected function _build($name, $params = [], $types = [], $return = 'string')
* @param mixed $expression the function argument
* @param array $types list of types to bind to the arguments
* @param string $return The return type for the function
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
protected function _literalArgumentFunction($name, $expression, $types = [], $return = 'string')
{
Expand All @@ -64,7 +64,7 @@ protected function _literalArgumentFunction($name, $expression, $types = [], $re
*
* @param mixed $expression the function argument
* @param array $types list of types to bind to the arguments
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
public function sum($expression, $types = [])
{
Expand All @@ -80,7 +80,7 @@ public function sum($expression, $types = [])
*
* @param mixed $expression the function argument
* @param array $types list of types to bind to the arguments
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
public function avg($expression, $types = [])
{
Expand All @@ -92,7 +92,7 @@ public function avg($expression, $types = [])
*
* @param mixed $expression the function argument
* @param array $types list of types to bind to the arguments
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
public function max($expression, $types = [])
{
Expand All @@ -104,7 +104,7 @@ public function max($expression, $types = [])
*
* @param mixed $expression the function argument
* @param array $types list of types to bind to the arguments
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
public function min($expression, $types = [])
{
Expand All @@ -116,7 +116,7 @@ public function min($expression, $types = [])
*
* @param mixed $expression the function argument
* @param array $types list of types to bind to the arguments
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
public function count($expression, $types = [])
{
Expand All @@ -128,7 +128,7 @@ public function count($expression, $types = [])
*
* @param array $args List of strings or expressions to concatenate
* @param array $types list of types to bind to the arguments
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
public function concat($args, $types = [])
{
Expand All @@ -140,7 +140,7 @@ public function concat($args, $types = [])
*
* @param array $args List of expressions to evaluate as function parameters
* @param array $types list of types to bind to the arguments
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
public function coalesce($args, $types = [])
{
Expand All @@ -153,7 +153,7 @@ public function coalesce($args, $types = [])
*
* @param array $args List of expressions to obtain the difference in days.
* @param array $types list of types to bind to the arguments
* @return FunctionExpression
* @return \Cake\Database\Expression\FunctionExpression
*/
public function dateDiff($args, $types = [])
{
Expand Down
2 changes: 1 addition & 1 deletion src/Database/IdentifierQuoter.php
Expand Up @@ -191,7 +191,7 @@ protected function _quoteInsert($query)
protected function _quoteUpdate($query)
{
$table = $query->clause('update')[0];

if (is_string($table)) {
$query->update($this->_driver->quoteIdentifier($table));
}
Expand Down
2 changes: 1 addition & 1 deletion src/Database/Log/LoggingStatement.php
Expand Up @@ -28,7 +28,7 @@ class LoggingStatement extends StatementDecorator
/**
* Logger instance responsible for actually doing the logging task
*
* @var QueryLogger
* @var \Cake\Database\Log\QueryLogger
*/
protected $_logger;

Expand Down

0 comments on commit 72f5332

Please sign in to comment.