Merge pull request #3964 from greg0ire/moar-immutable-exceptions

Mark every exception as immutable
doctrine · Apr 18, 2020 · 50e2321 · 50e2321
2 parents 0686b53 + fedac50
commit 50e2321
Show file tree

Hide file tree

Showing 27 changed files with 60 additions and 0 deletions.
diff --git a/lib/Doctrine/DBAL/Cache/CacheException.php b/lib/Doctrine/DBAL/Cache/CacheException.php
@@ -4,6 +4,9 @@
 
 use Doctrine\DBAL\DBALException;
 
+/**
+ * @psalm-immutable
+ */
 class CacheException extends DBALException
 {
     /**

diff --git a/lib/Doctrine/DBAL/ConnectionException.php b/lib/Doctrine/DBAL/ConnectionException.php
@@ -2,6 +2,9 @@
 
 namespace Doctrine\DBAL;
 
+/**
+ * @psalm-immutable
+ */
 class ConnectionException extends DBALException
 {
     /**

diff --git a/lib/Doctrine/DBAL/DBALException.php b/lib/Doctrine/DBAL/DBALException.php
@@ -22,6 +22,9 @@
 use function spl_object_hash;
 use function sprintf;
 
+/**
+ * @psalm-immutable
+ */
 class DBALException extends Exception
 {
     /**

diff --git a/lib/Doctrine/DBAL/Driver/IBMDB2/DB2Exception.php b/lib/Doctrine/DBAL/Driver/IBMDB2/DB2Exception.php
@@ -4,6 +4,9 @@
 
 use Exception;
 
+/**
+ * @psalm-immutable
+ */
 class DB2Exception extends Exception
 {
 }
diff --git a/lib/Doctrine/DBAL/Exception/ConnectionException.php b/lib/Doctrine/DBAL/Exception/ConnectionException.php
@@ -4,6 +4,8 @@
 
 /**
  * Base class for all connection related errors detected in the driver.
+ *
+ * @psalm-immutable
  */
 class ConnectionException extends DriverException
 {

diff --git a/lib/Doctrine/DBAL/Exception/ConstraintViolationException.php b/lib/Doctrine/DBAL/Exception/ConstraintViolationException.php
@@ -4,6 +4,8 @@
 
 /**
  * Base class for all constraint violation related errors detected in the driver.
+ *
+ * @psalm-immutable
  */
 class ConstraintViolationException extends ServerException
 {

diff --git a/lib/Doctrine/DBAL/Exception/DatabaseObjectExistsException.php b/lib/Doctrine/DBAL/Exception/DatabaseObjectExistsException.php
@@ -8,6 +8,8 @@
  * A database object is considered any asset that can be created in a database
  * such as schemas, tables, views, sequences, triggers,  constraints, indexes,
  * functions, stored procedures etc.
+ *
+ * @psalm-immutable
  */
 class DatabaseObjectExistsException extends ServerException
 {

diff --git a/lib/Doctrine/DBAL/Exception/DatabaseObjectNotFoundException.php b/lib/Doctrine/DBAL/Exception/DatabaseObjectNotFoundException.php
@@ -8,6 +8,8 @@
  * A database object is considered any asset that can be created in a database
  * such as schemas, tables, views, sequences, triggers,  constraints, indexes,
  * functions, stored procedures etc.
+ *
+ * @psalm-immutable
  */
 class DatabaseObjectNotFoundException extends ServerException
 {

diff --git a/lib/Doctrine/DBAL/Exception/DeadlockException.php b/lib/Doctrine/DBAL/Exception/DeadlockException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for a deadlock error of a transaction detected in the driver.
+ *
+ * @psalm-immutable
  */
 class DeadlockException extends ServerException implements RetryableException
 {

diff --git a/lib/Doctrine/DBAL/Exception/DriverException.php b/lib/Doctrine/DBAL/Exception/DriverException.php
@@ -7,6 +7,8 @@
 
 /**
  * Base class for all errors detected in the driver.
+ *
+ * @psalm-immutable
  */
 class DriverException extends DBALException
 {

diff --git a/lib/Doctrine/DBAL/Exception/ForeignKeyConstraintViolationException.php b/lib/Doctrine/DBAL/Exception/ForeignKeyConstraintViolationException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for a foreign key constraint violation detected in the driver.
+ *
+ * @psalm-immutable
  */
 class ForeignKeyConstraintViolationException extends ConstraintViolationException
 {

diff --git a/lib/Doctrine/DBAL/Exception/InvalidArgumentException.php b/lib/Doctrine/DBAL/Exception/InvalidArgumentException.php
@@ -6,6 +6,8 @@
 
 /**
  * Exception to be thrown when invalid arguments are passed to any DBAL API
+ *
+ * @psalm-immutable
  */
 class InvalidArgumentException extends DBALException
 {

diff --git a/lib/Doctrine/DBAL/Exception/InvalidFieldNameException.php b/lib/Doctrine/DBAL/Exception/InvalidFieldNameException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for an invalid specified field name in a statement detected in the driver.
+ *
+ * @psalm-immutable
  */
 class InvalidFieldNameException extends ServerException
 {

diff --git a/lib/Doctrine/DBAL/Exception/LockWaitTimeoutException.php b/lib/Doctrine/DBAL/Exception/LockWaitTimeoutException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for a lock wait timeout error of a transaction detected in the driver.
+ *
+ * @psalm-immutable
  */
 class LockWaitTimeoutException extends ServerException implements RetryableException
 {

diff --git a/lib/Doctrine/DBAL/Exception/NonUniqueFieldNameException.php b/lib/Doctrine/DBAL/Exception/NonUniqueFieldNameException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for a non-unique/ambiguous specified field name in a statement detected in the driver.
+ *
+ * @psalm-immutable
  */
 class NonUniqueFieldNameException extends ServerException
 {

diff --git a/lib/Doctrine/DBAL/Exception/NotNullConstraintViolationException.php b/lib/Doctrine/DBAL/Exception/NotNullConstraintViolationException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for a NOT NULL constraint violation detected in the driver.
+ *
+ * @psalm-immutable
  */
 class NotNullConstraintViolationException extends ConstraintViolationException
 {

diff --git a/lib/Doctrine/DBAL/Exception/ReadOnlyException.php b/lib/Doctrine/DBAL/Exception/ReadOnlyException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for a write operation attempt on a read-only database element detected in the driver.
+ *
+ * @psalm-immutable
  */
 class ReadOnlyException extends ServerException
 {

diff --git a/lib/Doctrine/DBAL/Exception/ServerException.php b/lib/Doctrine/DBAL/Exception/ServerException.php
@@ -4,6 +4,8 @@
 
 /**
  * Base class for all server related errors detected in the driver.
+ *
+ * @psalm-immutable
  */
 class ServerException extends DriverException
 {

diff --git a/lib/Doctrine/DBAL/Exception/SyntaxErrorException.php b/lib/Doctrine/DBAL/Exception/SyntaxErrorException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for a syntax error in a statement detected in the driver.
+ *
+ * @psalm-immutable
  */
 class SyntaxErrorException extends ServerException
 {

diff --git a/lib/Doctrine/DBAL/Exception/TableExistsException.php b/lib/Doctrine/DBAL/Exception/TableExistsException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for an already existing table referenced in a statement detected in the driver.
+ *
+ * @psalm-immutable
  */
 class TableExistsException extends DatabaseObjectExistsException
 {

diff --git a/lib/Doctrine/DBAL/Exception/TableNotFoundException.php b/lib/Doctrine/DBAL/Exception/TableNotFoundException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for an unknown table referenced in a statement detected in the driver.
+ *
+ * @psalm-immutable
  */
 class TableNotFoundException extends DatabaseObjectNotFoundException
 {

diff --git a/lib/Doctrine/DBAL/Exception/UniqueConstraintViolationException.php b/lib/Doctrine/DBAL/Exception/UniqueConstraintViolationException.php
@@ -4,6 +4,8 @@
 
 /**
  * Exception for a unique constraint violation detected in the driver.
+ *
+ * @psalm-immutable
  */
 class UniqueConstraintViolationException extends ConstraintViolationException
 {

diff --git a/lib/Doctrine/DBAL/Query/QueryException.php b/lib/Doctrine/DBAL/Query/QueryException.php
@@ -5,6 +5,9 @@
 use Doctrine\DBAL\DBALException;
 use function implode;
 
+/**
+ * @psalm-immutable
+ */
 class QueryException extends DBALException
 {
     /**

diff --git a/lib/Doctrine/DBAL/SQLParserUtilsException.php b/lib/Doctrine/DBAL/SQLParserUtilsException.php
@@ -6,6 +6,8 @@
 
 /**
  * Doctrine\DBAL\ConnectionException
+ *
+ * @psalm-immutable
  */
 class SQLParserUtilsException extends DBALException
 {

diff --git a/lib/Doctrine/DBAL/Schema/SchemaException.php b/lib/Doctrine/DBAL/Schema/SchemaException.php
@@ -6,6 +6,9 @@
 use function implode;
 use function sprintf;
 
+/**
+ * @psalm-immutable
+ */
 class SchemaException extends DBALException
 {
     public const TABLE_DOESNT_EXIST       = 10;

diff --git a/lib/Doctrine/DBAL/Sharding/ShardingException.php b/lib/Doctrine/DBAL/Sharding/ShardingException.php
@@ -6,6 +6,8 @@
 
 /**
  * Sharding related Exceptions
+ *
+ * @psalm-immutable
  */
 class ShardingException extends DBALException
 {

diff --git a/lib/Doctrine/DBAL/Types/ConversionException.php b/lib/Doctrine/DBAL/Types/ConversionException.php
@@ -15,6 +15,8 @@
 
 /**
  * Conversion Exception is thrown when the database to PHP conversion fails.
+ *
+ * @psalm-immutable
  */
 class ConversionException extends DBALException
 {