Revert documentation of base Exceptions

cakephp · Apr 24, 2018 · c78cb1f · c78cb1f
1 parent c344724
commit c78cb1f
Show file tree

Hide file tree

Showing 27 changed files with 16 additions and 81 deletions.
diff --git a/src/Cache/Cache.php b/src/Cache/Cache.php
@@ -155,7 +155,6 @@ public static function registry(ObjectRegistry $registry = null)
      * @param string $name Name of the config array that needs an engine instance built
      * @return void
      * @throws \InvalidArgumentException When a cache engine cannot be created.
-     * @throws \Exception
      */
     protected static function _buildEngine($name)
     {

diff --git a/src/Console/ConsoleIo.php b/src/Console/ConsoleIo.php
@@ -512,7 +512,6 @@ public function setLoggers($enable)
      * @param string $name The name of the helper to render
      * @param array $settings Configuration data for the helper.
      * @return \Cake\Console\Helper The created helper instance.
-     * @throws \Exception
      */
     public function helper($name, array $settings = [])
     {

diff --git a/src/Console/Shell.php b/src/Console/Shell.php
@@ -603,7 +603,6 @@ public function getOptionParser()
      *
      * @param string $name The task to get.
      * @return \Cake\Console\Shell Object of Task
-     * @throws \Exception
      */
     public function __get($name)
     {

diff --git a/src/Controller/Component.php b/src/Controller/Component.php
@@ -162,7 +162,6 @@ public function initialize(array $config)
      *
      * @param string $name Name of component to get.
      * @return mixed A Component object or null.
-     * @throws \Exception
      */
     public function __get($name)
     {

diff --git a/src/Controller/Component/CsrfComponent.php b/src/Controller/Component/CsrfComponent.php
@@ -127,7 +127,6 @@ public function implementedEvents()
      * @param \Cake\Http\ServerRequest $request The request object.
      * @param \Cake\Http\Response $response The response object.
      * @return array An array of the modified request, response.
-     * @throws \Exception
      */
     protected function _setCookie(ServerRequest $request, Response $response)
     {

diff --git a/src/Core/ObjectRegistry.php b/src/Core/ObjectRegistry.php
@@ -70,7 +70,6 @@ abstract class ObjectRegistry implements Countable, IteratorAggregate
      * @param string $objectName The name/class of the object to load.
      * @param array $config Additional settings to use when loading the object.
      * @return mixed
-     * @throws \Exception
      */
     public function load($objectName, $config = [])
     {
@@ -256,7 +255,6 @@ public function __set($name, $object)
      *
      * @param string $name Name of a property to unset.
      * @return void
-     * @throws \Exception
      */
     public function __unset($name)
     {
@@ -296,7 +294,6 @@ public function normalizeArray($objects)
      * If the registry subclass has an event manager, the objects will be detached from events as well.
      *
      * @return $this
-     * @throws \Exception
      */
     public function reset()
     {
@@ -316,7 +313,6 @@ public function reset()
      * @param string $objectName The name of the object to set in the registry.
      * @param object $object instance to store in the registry
      * @return $this
-     * @throws \Exception
      */
     public function set($objectName, $object)
     {
@@ -341,7 +337,6 @@ public function set($objectName, $object)
      *
      * @param string $objectName The name of the object to remove from the registry.
      * @return $this
-     * @throws \Exception
      */
     public function unload($objectName)
     {

diff --git a/src/Database/Connection.php b/src/Database/Connection.php
@@ -268,7 +268,6 @@ public function isConnected()
      *
      * @param string|\Cake\Database\Query $sql The SQL to convert into a prepared statement.
      * @return \Cake\Database\StatementInterface
-     * @throws \Exception
      */
     public function prepare($sql)
     {
@@ -291,7 +290,6 @@ public function prepare($sql)
      * @param array $params list or associative array of params to be interpolated in $query as values
      * @param array $types list or associative array of types to be used for casting values in query
      * @return \Cake\Database\StatementInterface executed statement
-     * @throws \Exception
      */
     public function execute($query, array $params = [], array $types = [])
     {
@@ -327,7 +325,6 @@ public function compileQuery(Query $query, ValueBinder $generator)
      *
      * @param \Cake\Database\Query $query The query to be executed
      * @return \Cake\Database\StatementInterface executed statement
-     * @throws \Exception
      */
     public function run(Query $query)
     {
@@ -345,7 +342,6 @@ public function run(Query $query)
      *
      * @param string $sql The SQL query to execute.
      * @return \Cake\Database\StatementInterface
-     * @throws \Exception
      */
     public function query($sql)
     {
@@ -425,7 +421,6 @@ public function schemaCollection(SchemaCollection $collection = null)
      * @param array $data values to be inserted
      * @param array $types list of associative array containing the types to be used for casting
      * @return \Cake\Database\StatementInterface
-     * @throws \Exception
      */
     public function insert($table, array $data, array $types = [])
     {
@@ -447,7 +442,6 @@ public function insert($table, array $data, array $types = [])
      * @param array $conditions conditions to be set for update statement
      * @param array $types list of associative array containing the types to be used for casting
      * @return \Cake\Database\StatementInterface
-     * @throws \Exception
      */
     public function update($table, array $data, array $conditions = [], $types = [])
     {
@@ -466,7 +460,6 @@ public function update($table, array $data, array $conditions = [], $types = [])
      * @param array $conditions conditions to be set for delete statement
      * @param array $types list of associative array containing the types to be used for casting
      * @return \Cake\Database\StatementInterface
-     * @throws \Exception
      */
     public function delete($table, $conditions = [], $types = [])
     {
@@ -481,7 +474,6 @@ public function delete($table, $conditions = [], $types = [])
      * Starts a new transaction.
      *
      * @return void
-     * @throws \Exception
      */
     public function begin()
     {
@@ -511,7 +503,6 @@ public function begin()
      * Commits current transaction.
      *
      * @return bool true on success, false otherwise
-     * @throws \Exception
      */
     public function commit()
     {
@@ -549,7 +540,6 @@ public function commit()
      * @param bool|null $toBeginning Whether or not the transaction should be rolled back to the
      * beginning of it. Defaults to false if using savepoints, or true if not.
      * @return bool
-     * @throws \Exception
      */
     public function rollback($toBeginning = null)
     {
@@ -654,7 +644,6 @@ public function useSavePoints($enable = null)
      *
      * @param string $name The save point name.
      * @return void
-     * @throws \Exception
      */
     public function createSavePoint($name)
     {
@@ -666,7 +655,6 @@ public function createSavePoint($name)
      *
      * @param string $name The save point name.
      * @return void
-     * @throws \Exception
      */
     public function releaseSavePoint($name)
     {
@@ -678,7 +666,6 @@ public function releaseSavePoint($name)
      *
      * @param string $name The save point name.
      * @return void
-     * @throws \Exception
      */
     public function rollbackSavepoint($name)
     {
@@ -689,7 +676,6 @@ public function rollbackSavepoint($name)
      * Run driver specific SQL to disable foreign key checks.
      *
      * @return void
-     * @throws \Exception
      */
     public function disableForeignKeys()
     {
@@ -702,7 +688,6 @@ public function disableForeignKeys()
      * Run driver specific SQL to enable foreign key checks.
      *
      * @return void
-     * @throws \Exception
      */
     public function enableForeignKeys()
     {

diff --git a/src/Database/Query.php b/src/Database/Query.php
@@ -213,7 +213,6 @@ public function connection($connection = null)
      * around query execution.
      *
      * @return \Cake\Database\StatementInterface
-     * @throws \Exception
      */
     public function execute()
     {

diff --git a/src/Database/Schema/Collection.php b/src/Database/Schema/Collection.php
@@ -56,7 +56,6 @@ public function __construct(Connection $connection)
      * Get the list of tables available in the current connection.
      *
      * @return array The list of tables in the connected database/schema.
-     * @throws \Exception
      */
     public function listTables()
     {
@@ -86,7 +85,6 @@ public function listTables()
      * @param array $options The options to use, see above.
      * @return \Cake\Database\Schema\TableSchema Object with column metadata.
      * @throws \Cake\Database\Exception when table cannot be described.
-     * @throws \Exception
      */
     public function describe($name, array $options = [])
     {
@@ -117,7 +115,6 @@ public function describe($name, array $options = [])
      * @param \Cake\Database\Schema\TableSchema $schema The table instance
      * @return void
      * @throws \Cake\Database\Exception on query failure.
-     * @throws \Exception
      */
     protected function _reflect($stage, $name, $config, $schema)
     {

diff --git a/src/Datasource/ConnectionManager.php b/src/Datasource/ConnectionManager.php
@@ -184,8 +184,8 @@ public static function dropAlias($name)
      * @param string $name The connection name.
      * @param bool $useAliases Set to false to not use aliased connections.
      * @return \Cake\Datasource\ConnectionInterface A connection object.
-     * @throws \Cake\Datasource\Exception\MissingDatasourceConfigException When config data is missing.
-     * @throws \Exception
+     * @throws \Cake\Datasource\Exception\MissingDatasourceConfigException When config
+     * data is missing.
      */
     public static function get($name, $useAliases = true)
     {

diff --git a/src/Error/BaseErrorHandler.php b/src/Error/BaseErrorHandler.php
@@ -122,7 +122,6 @@ public function register()
      * @param int|null $line Line that triggered the error
      * @param array|null $context Context
      * @return bool True if error was handled
-     * @throws \Exception
      */
     public function handleError($code, $description, $file = null, $line = null, $context = null)
     {
@@ -163,7 +162,6 @@ public function handleError($code, $description, $file = null, $line = null, $co
      *
      * @param \Exception|\Error $exception The exception to handle
      * @return void
-     * @throws \Exception
      */
     public function wrapAndHandleException($exception)
     {
@@ -212,7 +210,6 @@ protected function _stop($code)
      * @param string $file File on which error occurred
      * @param int $line Line that triggered the error
      * @return bool
-     * @throws \Exception
      */
     public function handleFatalError($code, $description, $file, $line)
     {

diff --git a/src/Error/Middleware/ErrorHandlerMiddleware.php b/src/Error/Middleware/ErrorHandlerMiddleware.php
@@ -91,7 +91,6 @@ public function __construct($exceptionRenderer = null, array $config = [])
      * @param \Psr\Http\Message\ResponseInterface $response The response.
      * @param callable $next Callback to invoke the next middleware.
      * @return \Psr\Http\Message\ResponseInterface A response
-     * @throws \Exception
      */
     public function __invoke($request, $response, $next)
     {
@@ -111,7 +110,6 @@ public function __invoke($request, $response, $next)
      * @param \Psr\Http\Message\ServerRequestInterface $request The request.
      * @param \Psr\Http\Message\ResponseInterface $response The response.
      * @return \Psr\Http\Message\ResponseInterface A response
-     * @throws \Exception
      */
     public function handleException($exception, $request, $response)
     {

diff --git a/src/Http/Client/Auth/Oauth.php b/src/Http/Client/Auth/Oauth.php
@@ -164,7 +164,7 @@ protected function _hmacSha1($request, $credentials)
      * @param array $credentials Authentication credentials.
      * @return string
      *
-     * @throws \Exception
+     * @throws \RuntimeException
      */
     protected function _rsaSha1($request, $credentials)
     {

diff --git a/src/Http/Client/CookieCollection.php b/src/Http/Client/CookieCollection.php
@@ -46,7 +46,6 @@ public function __construct(array $cookies = [])
      * @param Response $response The response to read cookies from
      * @param string $url The request URL used for default host/path values.
      * @return void
-     * @throws \Exception
      */
     public function store(Response $response, $url)
     {
@@ -71,7 +70,6 @@ public function store(Response $response, $url)
      *
      * @param string $url The URL to find cookies for.
      * @return array
-     * @throws \Exception
      */
     public function get($url)
     {

diff --git a/src/Http/Cookie/CookieCollection.php b/src/Http/Cookie/CookieCollection.php
@@ -57,7 +57,6 @@ public function __construct(array $cookies = [])
      *
      * @param array $header The array of set-cookie header values.
      * @return static
-     * @throws \Exception
      */
     public static function createFromHeader(array $header)
     {
@@ -212,7 +211,6 @@ public function getIterator()
      * @param array $extraCookies Associative array of additional cookies to add into the request. This
      *   is useful when you have cookie data from outside the collection you want to send.
      * @return \Psr\Http\Message\RequestInterface An updated request.
-     * @throws \Exception
      */
     public function addToRequest(RequestInterface $request, array $extraCookies = [])
     {
@@ -250,7 +248,6 @@ public function addToRequest(RequestInterface $request, array $extraCookies = []
      * @param string $host The host to match.
      * @param string $path The path to match
      * @return array An array of cookie name/value pairs
-     * @throws \Exception
      */
     protected function findMatchingCookies($scheme, $host, $path)
     {
@@ -290,7 +287,6 @@ protected function findMatchingCookies($scheme, $host, $path)
      * @param \Psr\Http\Message\ResponseInterface $response Response to extract cookies from.
      * @param \Psr\Http\Message\RequestInterface $request Request to get cookie context from.
      * @return static
-     * @throws \Exception
      */
     public function addFromResponse(ResponseInterface $response, RequestInterface $request)
     {
@@ -338,7 +334,6 @@ protected function setRequestDefaults(array $cookies, $host, $path)
      *
      * @param array $values List of Set-Cookie Header values.
      * @return \Cake\Http\Cookie\Cookie[] An array of cookie objects
-     * @throws \Exception
      */
     protected static function parseSetCookieHeader($values)
     {
@@ -401,7 +396,6 @@ protected static function parseSetCookieHeader($values)
      * @param string $host The host to check for expired cookies on.
      * @param string $path The path to check for expired cookies on.
      * @return void
-     * @throws \Exception
      */
     protected function removeExpiredCookies($host, $path)
     {

diff --git a/src/Http/Middleware/CsrfProtectionMiddleware.php b/src/Http/Middleware/CsrfProtectionMiddleware.php
@@ -130,7 +130,6 @@ protected function _validateAndUnsetTokenField(ServerRequest $request)
      * Create a new token to be used for CSRF protection
      *
      * @return string
-     * @throws \Exception
      */
     protected function _createToken()
     {

diff --git a/src/Log/Log.php b/src/Log/Log.php
@@ -187,7 +187,6 @@ protected static function _init()
      * adapters.
      *
      * @return void
-     * @throws \Exception
      */
     protected static function _loadConfig()
     {

diff --git a/src/Mailer/Email.php b/src/Mailer/Email.php
@@ -2514,7 +2514,6 @@ protected function _wrap($message, $wrapLength = Email::LINE_LENGTH_MUST)
      * Create unique boundary identifier
      *
      * @return void
-     * @throws \Exception
      */
     protected function _createBoundary()
     {
@@ -2896,7 +2895,6 @@ public function createFromArray($config)
      * Serializes the Email object.
      *
      * @return string
-     * @throws \Exception
      */
     public function serialize()
     {