Browse Source

Docblock Absolute Path

Updating docblock to use absolute path for RuntimeException
pirouet 11 years ago
parent
commit
4105c2dc5d

+ 1 - 1
src/Auth/PasswordHasherFactory.php

@@ -30,7 +30,7 @@ class PasswordHasherFactory
      * @param string|array $passwordHasher Name of the password hasher or an array with
      * at least the key `className` set to the name of the class to use
      * @return \Cake\Auth\AbstractPasswordHasher Password hasher instance
-     * @throws RuntimeException If password hasher class not found or
+     * @throws \RuntimeException If password hasher class not found or
      *   it does not extend Cake\Auth\AbstractPasswordHasher
      */
     public static function build($passwordHasher)

+ 1 - 1
src/Cache/Cache.php

@@ -237,7 +237,7 @@ class Cache
      * @param array $data An array of data to be stored in the cache
      * @param string $config Optional string configuration name to write to. Defaults to 'default'
      * @return array of bools for each key provided, indicating true for success or false for fail
-     * @throws RuntimeException
+     * @throws \RuntimeException
      */
     public static function writeMany($data, $config = 'default')
     {

+ 1 - 1
src/Controller/Component/CookieComponent.php

@@ -391,7 +391,7 @@ class CookieComponent extends Component
      *
      * @param string $encrypt The cipher name.
      * @return void
-     * @throws RuntimeException When an invalid cipher is provided.
+     * @throws \RuntimeException When an invalid cipher is provided.
      */
     protected function _checkCipher($encrypt)
     {

+ 1 - 1
src/Controller/Controller.php

@@ -608,7 +608,7 @@ class Controller implements EventListenerInterface
      * (e.g: Table instance, 'TableName' or a Query object)
      * @return \Cake\ORM\ResultSet Query results
      * @link http://book.cakephp.org/3.0/en/controllers.html#Controller::paginate
-     * @throws RuntimeException When no compatible table object can be found.
+     * @throws \RuntimeException When no compatible table object can be found.
      */
     public function paginate($object = null)
     {

+ 1 - 1
src/Database/Query.php

@@ -1204,7 +1204,7 @@ class Query implements ExpressionInterface, IteratorAggregate
      * @param array $columns The columns to insert into.
      * @param array $types A map between columns & their datatypes.
      * @return $this
-     * @throws RuntimeException When there are 0 columns.
+     * @throws \RuntimeException When there are 0 columns.
      */
     public function insert(array $columns, array $types = [])
     {

+ 1 - 1
src/Datasource/QueryCacher.php

@@ -34,7 +34,7 @@ class QueryCacher
      *
      * @param string|\Closure $key The key or function to generate a key.
      * @param string|CacheEngine $config The cache config name or cache engine instance.
-     * @throws RuntimeException
+     * @throws \RuntimeException
      */
     public function __construct($key, $config)
     {

+ 1 - 1
src/I18n/ChainMessagesLoader.php

@@ -48,7 +48,7 @@ class ChainMessagesLoader
      * the chain.
      *
      * @return \Aura\Intl\Package
-     * @throws RuntimeException if any of the loaders in the chain is not a valid callable
+     * @throws \RuntimeException if any of the loaders in the chain is not a valid callable
      */
     public function __invoke()
     {

+ 1 - 1
src/I18n/MessagesFileLoader.php

@@ -102,7 +102,7 @@ class MessagesFileLoader
      * package containing the messages loaded from the file.
      *
      * @return \Aura\Intl\Package
-     * @throws RuntimeException if no file parser class could be found for the specified
+     * @throws \RuntimeException if no file parser class could be found for the specified
      * file extension.
      */
     public function __invoke()

+ 1 - 1
src/I18n/Parser/MoFileParser.php

@@ -55,7 +55,7 @@ class MoFileParser
      * @param resource $resource The file to be parsed.
      *
      * @return array List of messages extracted from the file
-     * @throws RuntimeException If stream content has an invalid format.
+     * @throws \RuntimeException If stream content has an invalid format.
      */
     public function parse($resource)
     {

+ 1 - 1
src/Network/Http/Response.php

@@ -142,7 +142,7 @@ class Response extends Message
      *
      * @param string $body Gzip encoded body.
      * @return string
-     * @throws RuntimeException When attempting to decode gzip content without gzinflate.
+     * @throws \RuntimeException When attempting to decode gzip content without gzinflate.
      */
     protected function _decodeGzipBody($body)
     {

+ 2 - 2
src/Network/Session.php

@@ -276,7 +276,7 @@ class Session
      *
      * @param array $options Ini options to set.
      * @return void
-     * @throws RuntimeException if any directive could not be set
+     * @throws \RuntimeException if any directive could not be set
      */
     public function options(array $options)
     {
@@ -297,7 +297,7 @@ class Session
      * Starts the Session.
      *
      * @return bool True if session was started
-     * @throws RuntimeException if the session was already started
+     * @throws \RuntimeException if the session was already started
      */
     public function start()
     {

+ 3 - 3
src/ORM/Association.php

@@ -471,7 +471,7 @@ abstract class Association
      * @param Query $query the query to be altered to include the target table data
      * @param array $options Any extra options or overrides to be taken in account
      * @return void
-     * @throws RuntimeException if the query builder passed does not return a query
+     * @throws \RuntimeException if the query builder passed does not return a query
      * object
      */
     public function attachTo(Query $query, array $options = [])
@@ -741,7 +741,7 @@ abstract class Association
      *
      * @param array $options list of options passed to attachTo method
      * @return array
-     * @throws RuntimeException if the number of columns in the foreignKey do not
+     * @throws \RuntimeException if the number of columns in the foreignKey do not
      * match the number of columns in the source table primaryKey
      */
     protected function _joinCondition($options)
@@ -804,7 +804,7 @@ abstract class Association
      *
      * @param string $property the property name
      * @return \Cake\ORM\Association
-     * @throws RuntimeException if no association with such name exists
+     * @throws \RuntimeException if no association with such name exists
      */
     public function __get($property)
     {

+ 1 - 1
src/ORM/Association/BelongsTo.php

@@ -155,7 +155,7 @@ class BelongsTo extends Association
      *
      * @param array $options list of options passed to attachTo method
      * @return array
-     * @throws RuntimeException if the number of columns in the foreignKey do not
+     * @throws \RuntimeException if the number of columns in the foreignKey do not
      * match the number of columns in the target table primaryKey
      */
     protected function _joinCondition($options)

+ 1 - 1
src/ORM/Association/BelongsToMany.php

@@ -302,7 +302,7 @@ class BelongsToMany extends Association
      * @param \Cake\ORM\Query $fetchQuery The query to get results from
      * @param array $options The options passed to the eager loader
      * @return array
-     * @throws RuntimeException when the association property is not part of the results set.
+     * @throws \RuntimeException when the association property is not part of the results set.
      */
     protected function _buildResultMap($fetchQuery, $options)
     {

+ 2 - 2
src/ORM/Behavior/TreeBehavior.php

@@ -80,7 +80,7 @@ class TreeBehavior extends Behavior
      * @param \Cake\Event\Event $event The beforeSave event that was fired
      * @param \Cake\ORM\Entity $entity the entity that is going to be saved
      * @return void
-     * @throws RuntimeException if the parent to set for the node is invalid
+     * @throws \RuntimeException if the parent to set for the node is invalid
      */
     public function beforeSave(Event $event, Entity $entity)
     {
@@ -225,7 +225,7 @@ class TreeBehavior extends Behavior
      * @param \Cake\ORM\Entity $entity The entity to re-parent
      * @param mixed $parent the id of the parent to set
      * @return void
-     * @throws RuntimeException if the parent to set to the entity is not valid
+     * @throws \RuntimeException if the parent to set to the entity is not valid
      */
     protected function _setParent($entity, $parent)
     {

+ 2 - 2
src/ORM/Query.php

@@ -571,7 +571,7 @@ class Query extends DatabaseQuery implements JsonSerializable
      * {@inheritDoc}
      *
      * @return $this
-     * @throws RuntimeException When you attempt to cache a non-select query.
+     * @throws \RuntimeException When you attempt to cache a non-select query.
      */
     public function cache($key, $config = 'default')
     {
@@ -584,7 +584,7 @@ class Query extends DatabaseQuery implements JsonSerializable
     /**
      * {@inheritDoc}
      *
-     * @throws RuntimeException if this method is called on a non-select Query.
+     * @throws \RuntimeException if this method is called on a non-select Query.
      */
     public function all()
     {

+ 4 - 4
src/ORM/Table.php

@@ -590,7 +590,7 @@ class Table implements RepositoryInterface, EventListenerInterface
      * @param string $name The name of the behavior. Can be a short class reference.
      * @param array $options The options for the behavior to use.
      * @return void
-     * @throws RuntimeException If a behavior is being reloaded.
+     * @throws \RuntimeException If a behavior is being reloaded.
      * @see \Cake\ORM\Behavior
      */
     public function addBehavior($name, array $options = [])
@@ -1391,7 +1391,7 @@ class Table implements RepositoryInterface, EventListenerInterface
      * @param \Cake\Datasource\EntityInterface $entity the entity to be saved
      * @param \ArrayObject $options the options to use for the save operation
      * @return \Cake\Datasource\EntityInterface|bool
-     * @throws RuntimeException When an entity is missing some of the primary keys.
+     * @throws \RuntimeException When an entity is missing some of the primary keys.
      */
     protected function _processSave($entity, $options)
     {
@@ -1472,7 +1472,7 @@ class Table implements RepositoryInterface, EventListenerInterface
      * @param \Cake\Datasource\EntityInterface $entity the subject entity from were $data was extracted
      * @param array $data The actual data that needs to be saved
      * @return \Cake\Datasource\EntityInterface|bool
-     * @throws RuntimeException if not all the primary keys where supplied or could
+     * @throws \RuntimeException if not all the primary keys where supplied or could
      * be generated when the table has composite primary keys. Or when the table has no primary key.
      */
     protected function _insert($entity, $data)
@@ -1846,7 +1846,7 @@ class Table implements RepositoryInterface, EventListenerInterface
      *
      * @param string $property the association name
      * @return \Cake\ORM\Association
-     * @throws RuntimeException if no association with such name exists
+     * @throws \RuntimeException if no association with such name exists
      */
     public function __get($property)
     {

+ 1 - 1
src/ORM/TableRegistry.php

@@ -97,7 +97,7 @@ class TableRegistry
      * @param string|null $alias Name of the alias
      * @param array|null $options list of options for the alias
      * @return array The config data.
-     * @throws RuntimeException When you attempt to configure an existing table instance.
+     * @throws \RuntimeException When you attempt to configure an existing table instance.
      */
     public static function config($alias = null, $options = null)
     {

+ 1 - 1
src/Utility/Hash.php

@@ -417,7 +417,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#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)
     {

+ 2 - 2
src/View/Form/EntityContext.php

@@ -113,7 +113,7 @@ class EntityContext implements ContextInterface
      * like arrays, Collection objects and ResultSets.
      *
      * @return void
-     * @throws RuntimeException When a table object cannot be located/inferred.
+     * @throws \RuntimeException When a table object cannot be located/inferred.
      */
     protected function _prepare()
     {
@@ -254,7 +254,7 @@ class EntityContext implements ContextInterface
      * @param array|null $path Each one of the parts in a path for a field name
      *  or null to get the entity passed in contructor context.
      * @return \Cake\DataSource\EntityInterface|\Traversable|array|bool
-     * @throws RuntimeException When properties cannot be read.
+     * @throws \RuntimeException When properties cannot be read.
      */
     public function entity($path = null)
     {

+ 1 - 1
src/View/Helper/FormHelper.php

@@ -2460,7 +2460,7 @@ class FormHelper extends Helper
      *
      * @param mixed $data The data to get a context provider for.
      * @return mixed Context provider.
-     * @throws RuntimeException when the context class does not implement the
+     * @throws \RuntimeException when the context class does not implement the
      *   ContextInterface.
      */
     protected function _getContext($data = [])

+ 1 - 1
src/View/Widget/DateTimeWidget.php

@@ -119,7 +119,7 @@ class DateTimeWidget implements WidgetInterface
      * @param array $data Data to render with.
      * @param \Cake\View\Form\ContextInterface $context The current form context.
      * @return string A generated select box.
-     * @throws RuntimeException When option data is invalid.
+     * @throws \RuntimeException When option data is invalid.
      */
     public function render(array $data, ContextInterface $context)
     {

+ 3 - 3
src/View/Widget/WidgetRegistry.php

@@ -111,7 +111,7 @@ class WidgetRegistry
      *
      * @param array $widgets Array of widgets to use.
      * @return void
-     * @throws RuntimeException When class does not implement WidgetInterface.
+     * @throws \RuntimeException When class does not implement WidgetInterface.
      */
     public function add(array $widgets)
     {
@@ -137,7 +137,7 @@ class WidgetRegistry
      *
      * @param string $name The widget name to get.
      * @return WidgetInterface widget interface class.
-     * @throws RuntimeException when widget is undefined.
+     * @throws \RuntimeException when widget is undefined.
      */
     public function get($name)
     {
@@ -166,7 +166,7 @@ class WidgetRegistry
      *
      * @param mixed $widget The widget to get
      * @return WidgetInterface
-     * @throws RuntimeException when class cannot be loaded or does not
+     * @throws \RuntimeException when class cannot be loaded or does not
      *   implement WidgetInterface.
      */
     protected function _resolveWidget($widget)