Skip to content

Commit

Permalink
Make the wannabe fully qualified namespaces in docblock tags actually…
Browse files Browse the repository at this point in the history
… fully qualified by adding leading backslashes.

Resolves #2870
  • Loading branch information
ndm2 committed Feb 22, 2014
1 parent 6cd8408 commit 6c32004
Show file tree
Hide file tree
Showing 212 changed files with 762 additions and 762 deletions.
10 changes: 5 additions & 5 deletions src/Cache/Cache.php
Expand Up @@ -63,7 +63,7 @@
* @param string $name Name of the configuration
* @param array $config Optional associative array of settings passed to the engine
* @return array [engine, settings] on success, false on failure
* @throws Cake\Error\Exception
* @throws \Cake\Error\Exception
*/
class Cache {

Expand Down Expand Up @@ -103,15 +103,15 @@ class Cache {
/**
* Cache Registry used for creating and using cache adapters.
*
* @var Cake\Cache\CacheRegistry
* @var \Cake\Cache\CacheRegistry
*/
protected static $_registry;

/**
* Finds and builds the instance of the required engine class.
*
* @param string $name Name of the config array that needs an engine instance built
* @throws Cake\Error\Exception When a cache engine cannot be created.
* @throws \Cake\Error\Exception When a cache engine cannot be created.
*/
protected static function _buildEngine($name) {
if (empty(static::$_registry)) {
Expand Down Expand Up @@ -140,7 +140,7 @@ protected static function _buildEngine($name) {
* triggered.
*
* @param string $config The configuration name you want an engine for.
* @return Cake\Cache\Engine
* @return \Cake\Cache\Engine
*/
public static function engine($config) {
if (!static::$_enabled) {
Expand Down Expand Up @@ -345,7 +345,7 @@ public static function clearGroup($group, $config = 'default') {
*
* @param string $group group name or null to retrieve all group mappings
* @return array map of group and all configuration that has the same group
* @throws Cake\Error\Exception
* @throws \Cake\Error\Exception
*/
public static function groupConfigs($group = null) {
if ($group === null) {
Expand Down
4 changes: 2 additions & 2 deletions src/Cache/CacheRegistry.php
Expand Up @@ -48,7 +48,7 @@ protected function _resolveClassName($class) {
*
* @param string $class The classname that is missing.
* @param string $plugin The plugin the cache is missing in.
* @throws Cake\Error\Exception
* @throws \Cake\Error\Exception
*/
protected function _throwMissingClassError($class, $plugin) {
throw new Error\Exception(sprintf('Cache engine %s is not available.', $class));
Expand All @@ -62,7 +62,7 @@ protected function _throwMissingClassError($class, $plugin) {
* @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.
* @throws Cake\Error\Exception when an object doesn't implement
* @throws \Cake\Error\Exception 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/FileEngine.php
Expand Up @@ -325,7 +325,7 @@ protected function _clearDirectory($path, $now, $threshold) {
* @param string $key
* @param integer $offset
* @return void
* @throws Cake\Error\Exception
* @throws \Cake\Error\Exception
*/
public function decrement($key, $offset = 1) {
throw new Error\Exception('Files cannot be atomically decremented.');
Expand All @@ -337,7 +337,7 @@ public function decrement($key, $offset = 1) {
* @param string $key
* @param integer $offset
* @return void
* @throws Cake\Error\Exception
* @throws \Cake\Error\Exception
*/
public function increment($key, $offset = 1) {
throw new Error\Exception('Files cannot be atomically incremented.');
Expand Down
8 changes: 4 additions & 4 deletions src/Cache/Engine/MemcachedEngine.php
Expand Up @@ -95,7 +95,7 @@ class MemcachedEngine extends CacheEngine {
*
* @param array $config array of setting for the engine
* @return boolean True if the engine has been successfully initialized, false if not
* @throws Cake\Error\Exception when you try use authentication without Memcached compiled with SASL support
* @throws \Cake\Error\Exception when you try use authentication without Memcached compiled with SASL support
*/
public function init($config = []) {
if (!class_exists('Memcached')) {
Expand Down Expand Up @@ -151,7 +151,7 @@ public function init($config = []) {
/**
* Settings the memcached instance
*
* @throws Cake\Error\Exception when the Memcached extension is not built with the desired serializer engine
* @throws \Cake\Error\Exception when the Memcached extension is not built with the desired serializer engine
*/
protected function _setOptions() {
$this->_Memcached->setOption(\Memcached::OPT_LIBKETAMA_COMPATIBLE, true);
Expand Down Expand Up @@ -246,7 +246,7 @@ public function read($key) {
* @param string $key Identifier for the data
* @param integer $offset How much to increment
* @return New incremented value, false otherwise
* @throws Cake\Error\Exception when you try to increment with compress = true
* @throws \Cake\Error\Exception when you try to increment with compress = true
*/
public function increment($key, $offset = 1) {
$key = $this->_key($key);
Expand All @@ -260,7 +260,7 @@ public function increment($key, $offset = 1) {
* @param string $key Identifier for the data
* @param integer $offset How much to subtract
* @return New decremented value, false otherwise
* @throws Cake\Error\Exception when you try to decrement with compress = true
* @throws \Cake\Error\Exception when you try to decrement with compress = true
*/
public function decrement($key, $offset = 1) {
$key = $this->_key($key);
Expand Down
2 changes: 1 addition & 1 deletion src/Configure/Engine/IniConfig.php
Expand Up @@ -94,7 +94,7 @@ public function __construct($path = null, $section = null) {
* @param string $key The identifier to read from. If the key has a . it will be treated
* as a plugin prefix. The chosen file must be on the engine's path.
* @return array Parsed configuration values.
* @throws Cake\Error\ConfigureException when files don't exist.
* @throws \Cake\Error\ConfigureException when files don't exist.
* Or when files contain '..' as this could lead to abusive reads.
*/
public function read($key) {
Expand Down
2 changes: 1 addition & 1 deletion src/Configure/Engine/PhpConfig.php
Expand Up @@ -57,7 +57,7 @@ public function __construct($path = null) {
* @param string $key The identifier to read from. If the key has a . it will be treated
* as a plugin prefix.
* @return array Parsed configuration values.
* @throws Cake\Error\ConfigureException when files don't exist or they don't contain `$config`.
* @throws \Cake\Error\ConfigureException when files don't exist or they don't contain `$config`.
* Or when files contain '..' as this could lead to abusive reads.
*/
public function read($key) {
Expand Down
2 changes: 1 addition & 1 deletion src/Console/Command/Task/FixtureTask.php
Expand Up @@ -45,7 +45,7 @@ class FixtureTask extends BakeTask {
/**
* Schema instance
*
* @var Cake\Model\Schema
* @var \Cake\Model\Schema
*/
protected $_Schema = null;

Expand Down
4 changes: 2 additions & 2 deletions src/Console/Command/Task/TestTask.php
Expand Up @@ -337,7 +337,7 @@ public function getRealClassName($type, $class, $plugin = null) {
* @param string $type The type of thing having a test generated.
* @param string $plugin The plugin name.
* @return string
* @throws Cake\Error\Exception When invalid object types are requested.
* @throws \Cake\Error\Exception When invalid object types are requested.
*/
public function mapType($type, $plugin) {
$type = ucfirst($type);
Expand All @@ -357,7 +357,7 @@ public function mapType($type, $plugin) {
* @param string $type The type the class having a test
* generated for is in.
* @return array Array of (class, type)
* @throws Cake\Error\Exception on invalid types.
* @throws \Cake\Error\Exception on invalid types.
*/
public function getBaseType($type) {
if (empty($this->baseTypes[$type])) {
Expand Down
2 changes: 1 addition & 1 deletion src/Console/ConsoleInputArgument.php
Expand Up @@ -136,7 +136,7 @@ public function isRequired() {
*
* @param string $value
* @return boolean
* @throws Cake\Error\ConsoleException
* @throws \Cake\Error\ConsoleException
*/
public function validChoice($value) {
if (empty($this->_choices)) {
Expand Down
4 changes: 2 additions & 2 deletions src/Console/ConsoleInputOption.php
Expand Up @@ -77,7 +77,7 @@ class ConsoleInputOption {
* @param boolean $boolean Whether this option is a boolean option. Boolean options don't consume extra tokens
* @param string $default The default value for this option.
* @param array $choices Valid choices for this option.
* @throws Cake\Error\ConsoleException
* @throws \Cake\Error\ConsoleException
*/
public function __construct($name, $short = null, $help = '', $boolean = false, $default = '', $choices = []) {
if (is_array($name) && isset($name['name'])) {
Expand Down Expand Up @@ -181,7 +181,7 @@ public function isBoolean() {
*
* @param string $value
* @return boolean
* @throws Cake\Error\ConsoleException
* @throws \Cake\Error\ConsoleException
*/
public function validChoice($value) {
if (empty($this->_choices)) {
Expand Down
8 changes: 4 additions & 4 deletions src/Console/ConsoleOptionParser.php
Expand Up @@ -453,7 +453,7 @@ public function subcommands() {
* @param string $command The subcommand to use. If this parameter is a subcommand, that has a parser,
* That parser will be used to parse $argv instead.
* @return Array [$params, $args]
* @throws Cake\Error\ConsoleException When an invalid parameter is encountered.
* @throws \Cake\Error\ConsoleException When an invalid parameter is encountered.
*/
public function parse($argv, $command = null) {
if (isset($this->_subcommands[$command]) && $this->_subcommands[$command]->parser()) {
Expand Down Expand Up @@ -545,7 +545,7 @@ protected function _parseLongOption($option, $params) {
* @param string $option The option to parse.
* @param array $params The params to append the parsed value into
* @return array Params with $option added in.
* @throws Cake\Error\ConsoleException When unknown short options are encountered.
* @throws \Cake\Error\ConsoleException When unknown short options are encountered.
*/
protected function _parseShortOption($option, $params) {
$key = substr($option, 1);
Expand All @@ -569,7 +569,7 @@ protected function _parseShortOption($option, $params) {
* @param string $name The name to parse.
* @param array $params The params to append the parsed value into
* @return array Params with $option added in.
* @throws Cake\Error\ConsoleException
* @throws \Cake\Error\ConsoleException
*/
protected function _parseOption($name, $params) {
if (!isset($this->_options[$name])) {
Expand Down Expand Up @@ -616,7 +616,7 @@ protected function _optionExists($name) {
* @param string $argument The argument to append
* @param array $args The array of parsed args to append to.
* @return array Args
* @throws Cake\Error\ConsoleException
* @throws \Cake\Error\ConsoleException
*/
protected function _parseArg($argument, $args) {
if (empty($this->_args)) {
Expand Down
6 changes: 3 additions & 3 deletions src/Console/ShellDispatcher.php
Expand Up @@ -87,7 +87,7 @@ protected function _initConstants() {
* Defines current working environment.
*
* @return void
* @throws Cake\Error\Exception
* @throws \Cake\Error\Exception
*/
protected function _initEnvironment() {
if (!$this->_bootstrap()) {
Expand Down Expand Up @@ -132,7 +132,7 @@ public function dispatch() {
* Dispatch a request.
*
* @return boolean
* @throws Cake\Error\MissingShellMethodException
* @throws \Cake\Error\MissingShellMethodException
*/
protected function _dispatch() {
$shell = $this->shiftArgs();
Expand Down Expand Up @@ -184,7 +184,7 @@ protected function _dispatch() {
*
* @param string $shell Optionally the name of a plugin
* @return mixed An object
* @throws Cake\Error\MissingShellException when errors are encountered.
* @throws \Cake\Error\MissingShellException when errors are encountered.
*/
protected function _getShell($shell) {
list($plugin, $shell) = pluginSplit($shell);
Expand Down
2 changes: 1 addition & 1 deletion src/Console/TaskRegistry.php
Expand Up @@ -59,7 +59,7 @@ protected function _resolveClassName($class) {
*
* @param string $class The classname that is missing.
* @param string $plugin The plugin the task is missing in.
* @throws Cake\Error\MissingTaskException
* @throws \Cake\Error\MissingTaskException
*/
protected function _throwMissingClassError($class, $plugin) {
throw new Error\MissingTaskException([
Expand Down
2 changes: 1 addition & 1 deletion src/Controller/Component/Acl/PhpAcl.php
Expand Up @@ -102,7 +102,7 @@ public function initialize(Component $Component) {
*
* @param array $config configuration array, see docs
* @return void
* @throws Cake\Error\AclException When required keys are missing.
* @throws \Cake\Error\AclException When required keys are missing.
*/
public function build(array $config) {
if (empty($config['roles'])) {
Expand Down
4 changes: 2 additions & 2 deletions src/Controller/Component/AclComponent.php
Expand Up @@ -62,7 +62,7 @@ class AclComponent extends Component {
*
* @param ComponentRegistry $collection
* @param array $settings
* @throws Cake\Error\Exception when Acl.classname could not be loaded.
* @throws \Cake\Error\Exception when Acl.classname could not be loaded.
*/
public function __construct(ComponentRegistry $collection, $settings = array()) {
parent::__construct($collection, $settings);
Expand All @@ -86,7 +86,7 @@ public function __construct(ComponentRegistry $collection, $settings = array())
*
* @param AclInterface|string $adapter Instance of AclInterface or a string name of the class to use. (optional)
* @return AclInterface|void either null, or the adapter implementation.
* @throws Cake\Error\Exception when the given class is not an instance of AclInterface
* @throws \Cake\Error\Exception when the given class is not an instance of AclInterface
*/
public function adapter($adapter = null) {
if ($adapter) {
Expand Down
2 changes: 1 addition & 1 deletion src/Controller/Component/Auth/ActionsAuthorize.php
Expand Up @@ -31,7 +31,7 @@ class ActionsAuthorize extends BaseAuthorize {
* Authorize a user using the AclComponent.
*
* @param array $user The user to authorize
* @param Cake\Network\Request $request The request needing authorization.
* @param \Cake\Network\Request $request The request needing authorization.
* @return boolean
*/
public function authorize($user, Request $request) {
Expand Down
12 changes: 6 additions & 6 deletions src/Controller/Component/Auth/BaseAuthenticate.php
Expand Up @@ -128,7 +128,7 @@ protected function _findUser($username, $password = null) {
* Return password hasher object
*
* @return AbstractPasswordHasher Password hasher instance
* @throws Cake\Error\Exception If password hasher class not found or
* @throws \Cake\Error\Exception If password hasher class not found or
* it does not extend AbstractPasswordHasher
*/
public function passwordHasher() {
Expand Down Expand Up @@ -161,8 +161,8 @@ public function passwordHasher() {
/**
* Authenticate a user based on the request information.
*
* @param Cake\Network\Request $request Request to get authentication information from.
* @param Cake\Network\Response $response A response object that can have headers added.
* @param \Cake\Network\Request $request Request to get authentication information from.
* @param \Cake\Network\Response $response A response object that can have headers added.
* @return mixed Either false on failure, or an array of user data on success.
*/
abstract public function authenticate(Request $request, Response $response);
Expand All @@ -184,7 +184,7 @@ public function logout($user) {
* Get a user based on information in the request. Primarily used by stateless authentication
* systems like basic and digest auth.
*
* @param Cake\Network\Request $request Request object.
* @param \Cake\Network\Request $request Request object.
* @return mixed Either false or an array of user information
*/
public function getUser(Request $request) {
Expand All @@ -196,8 +196,8 @@ public function getUser(Request $request) {
* the unauthenticated request has been dealt with and no more action is required by
* AuthComponent or void (default).
*
* @param Cake\Network\Request $request A request object.
* @param Cake\Network\Response $response A response object.
* @param \Cake\Network\Request $request A request object.
* @param \Cake\Network\Response $response A response object.
* @return void
*/
public function unauthenticated(Request $request, Response $response) {
Expand Down
6 changes: 3 additions & 3 deletions src/Controller/Component/Auth/BaseAuthorize.php
Expand Up @@ -85,7 +85,7 @@ public function __construct(ComponentRegistry $registry, $settings = array()) {
* Checks user authorization.
*
* @param array $user Active user data
* @param Cake\Network\Request $request
* @param \Cake\Network\Request $request
* @return boolean
*/
abstract public function authorize($user, Request $request);
Expand All @@ -95,7 +95,7 @@ abstract public function authorize($user, Request $request);
*
* @param Controller $controller null to get, a controller to set.
* @return mixed
* @throws Cake\Error\Exception
* @throws \Cake\Error\Exception
*/
public function controller(Controller $controller = null) {
if ($controller) {
Expand All @@ -112,7 +112,7 @@ public function controller(Controller $controller = null) {
* Get the action path for a given request. Primarily used by authorize objects
* that need to get information about the plugin, controller, and action being invoked.
*
* @param Cake\Network\Request $request The request a path is needed for.
* @param \Cake\Network\Request $request The request a path is needed for.
* @param string $path
* @return string the action path for the given request.
*/
Expand Down

0 comments on commit 6c32004

Please sign in to comment.