Merge pull request doctrine#3577 from morozov/event-types

Enforced parameter and return value types in event-related classes
morozov · Aug 27, 2019 · 46ddb54 · 46ddb54
2 parents 40ded24 + 792dd90
commit 46ddb54
Show file tree

Hide file tree

Showing 16 changed files with 118 additions and 315 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,11 @@
 # Upgrade to 3.0
 
+## BC BREAK: Changes in the `Doctrine\DBAL\Event` API
+
+- `SchemaAlterTableAddColumnEventArgs::addSql()` and the same method in other `SchemaEventArgs`-based classes no longer accept an array of SQL statements. They accept a variadic string.
+- `ConnectionEventArgs::getDriver()`, `::getDatabasePlatform()` and `::getSchemaManager()` methods have been removed. The connection information can be obtained from the connection which is available via `::getConnection()`.
+- `SchemaColumnDefinitionEventArgs::getDatabasePlatform()` and `SchemaIndexDefinitionEventArgs::getDatabasePlatform()` have been removed for the same reason as above.
+
 ## BC BREAK: Changes in the `Doctrine\DBAL\Connection` API
 
 - The following methods have been removed as leaking internal implementation details: `::getHost()`, `::getPort()`, `::getUsername()`, `::getPassword()`.

diff --git a/lib/Doctrine/DBAL/Event/ConnectionEventArgs.php b/lib/Doctrine/DBAL/Event/ConnectionEventArgs.php
@@ -6,9 +6,6 @@
 
 use Doctrine\Common\EventArgs;
 use Doctrine\DBAL\Connection;
-use Doctrine\DBAL\Driver;
-use Doctrine\DBAL\Platforms\AbstractPlatform;
-use Doctrine\DBAL\Schema\AbstractSchemaManager;
 
 /**
  * Event Arguments used when a Driver connection is established inside Doctrine\DBAL\Connection.
@@ -23,35 +20,8 @@ public function __construct(Connection $connection)
         $this->connection = $connection;
     }
 
-    /**
-     * @return Connection
-     */
-    public function getConnection()
+    public function getConnection() : Connection
     {
         return $this->connection;
     }
-
-    /**
-     * @return Driver
-     */
-    public function getDriver()
-    {
-        return $this->connection->getDriver();
-    }
-
-    /**
-     * @return AbstractPlatform
-     */
-    public function getDatabasePlatform()
-    {
-        return $this->connection->getDatabasePlatform();
-    }
-
-    /**
-     * @return AbstractSchemaManager
-     */
-    public function getSchemaManager()
-    {
-        return $this->connection->getSchemaManager();
-    }
 }
diff --git a/lib/Doctrine/DBAL/Event/Listeners/OracleSessionInit.php b/lib/Doctrine/DBAL/Event/Listeners/OracleSessionInit.php
@@ -25,7 +25,7 @@
  */
 class OracleSessionInit implements EventSubscriber
 {
-    /** @var string[] */
+    /** @var array<string, string> */
     protected $_defaultSessionVars = [
         'NLS_TIME_FORMAT' => 'HH24:MI:SS',
         'NLS_DATE_FORMAT' => 'YYYY-MM-DD HH24:MI:SS',
@@ -35,17 +35,14 @@ class OracleSessionInit implements EventSubscriber
     ];
 
     /**
-     * @param string[] $oracleSessionVars
+     * @param array<string, string> $oracleSessionVars
      */
     public function __construct(array $oracleSessionVars = [])
     {
         $this->_defaultSessionVars = array_merge($this->_defaultSessionVars, $oracleSessionVars);
     }
 
-    /**
-     * @return void
-     */
-    public function postConnect(ConnectionEventArgs $args)
+    public function postConnect(ConnectionEventArgs $args) : void
     {
         if (! count($this->_defaultSessionVars)) {
             return;
@@ -67,7 +64,7 @@ public function postConnect(ConnectionEventArgs $args)
     /**
      * {@inheritdoc}
      */
-    public function getSubscribedEvents()
+    public function getSubscribedEvents() : array
     {
         return [Events::postConnect];
     }

diff --git a/lib/Doctrine/DBAL/Event/Listeners/SQLSessionInit.php b/lib/Doctrine/DBAL/Event/Listeners/SQLSessionInit.php
@@ -16,18 +16,12 @@ class SQLSessionInit implements EventSubscriber
     /** @var string */
     protected $sql;
 
-    /**
-     * @param string $sql
-     */
-    public function __construct($sql)
+    public function __construct(string $sql)
     {
         $this->sql = $sql;
     }
 
-    /**
-     * @return void
-     */
-    public function postConnect(ConnectionEventArgs $args)
+    public function postConnect(ConnectionEventArgs $args) : void
     {
         $conn = $args->getConnection();
         $conn->exec($this->sql);
@@ -36,7 +30,7 @@ public function postConnect(ConnectionEventArgs $args)
     /**
      * {@inheritdoc}
      */
-    public function getSubscribedEvents()
+    public function getSubscribedEvents() : array
     {
         return [Events::postConnect];
     }

diff --git a/lib/Doctrine/DBAL/Event/SchemaAlterTableAddColumnEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaAlterTableAddColumnEventArgs.php
@@ -8,7 +8,6 @@
 use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\TableDiff;
 use function array_merge;
-use function is_array;
 
 /**
  * Event Arguments used when SQL queries for adding table columns are generated inside Doctrine\DBAL\Platform\*Platform.
@@ -24,7 +23,7 @@ class SchemaAlterTableAddColumnEventArgs extends SchemaEventArgs
     /** @var AbstractPlatform */
     private $platform;
 
-    /** @var string[] */
+    /** @var array<int, string> */
     private $sql = [];
 
     public function __construct(Column $column, TableDiff $tableDiff, AbstractPlatform $platform)
@@ -34,50 +33,35 @@ public function __construct(Column $column, TableDiff $tableDiff, AbstractPlatfo
         $this->platform  = $platform;
     }
 
-    /**
-     * @return Column
-     */
-    public function getColumn()
+    public function getColumn() : Column
     {
         return $this->column;
     }
 
-    /**
-     * @return TableDiff
-     */
-    public function getTableDiff()
+    public function getTableDiff() : TableDiff
     {
         return $this->tableDiff;
     }
 
-    /**
-     * @return AbstractPlatform
-     */
-    public function getPlatform()
+    public function getPlatform() : AbstractPlatform
     {
         return $this->platform;
     }
 
     /**
-     * @param string|string[] $sql
-     *
-     * @return \Doctrine\DBAL\Event\SchemaAlterTableAddColumnEventArgs
+     * @return $this
      */
-    public function addSql($sql)
+    public function addSql(string ...$sql) : self
     {
-        if (is_array($sql)) {
-            $this->sql = array_merge($this->sql, $sql);
-        } else {
-            $this->sql[] = $sql;
-        }
+        $this->sql = array_merge($this->sql, $sql);
 
         return $this;
     }
 
     /**
-     * @return string[]
+     * @return array<int, string>
      */
-    public function getSql()
+    public function getSql() : array
     {
         return $this->sql;
     }

diff --git a/lib/Doctrine/DBAL/Event/SchemaAlterTableChangeColumnEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaAlterTableChangeColumnEventArgs.php
@@ -8,7 +8,6 @@
 use Doctrine\DBAL\Schema\ColumnDiff;
 use Doctrine\DBAL\Schema\TableDiff;
 use function array_merge;
-use function is_array;
 
 /**
  * Event Arguments used when SQL queries for changing table columns are generated inside Doctrine\DBAL\Platform\*Platform.
@@ -24,7 +23,7 @@ class SchemaAlterTableChangeColumnEventArgs extends SchemaEventArgs
     /** @var AbstractPlatform */
     private $platform;
 
-    /** @var string[] */
+    /** @var array<int, string> */
     private $sql = [];
 
     public function __construct(ColumnDiff $columnDiff, TableDiff $tableDiff, AbstractPlatform $platform)
@@ -34,50 +33,35 @@ public function __construct(ColumnDiff $columnDiff, TableDiff $tableDiff, Abstra
         $this->platform   = $platform;
     }
 
-    /**
-     * @return ColumnDiff
-     */
-    public function getColumnDiff()
+    public function getColumnDiff() : ColumnDiff
     {
         return $this->columnDiff;
     }
 
-    /**
-     * @return TableDiff
-     */
-    public function getTableDiff()
+    public function getTableDiff() : TableDiff
     {
         return $this->tableDiff;
     }
 
-    /**
-     * @return AbstractPlatform
-     */
-    public function getPlatform()
+    public function getPlatform() : AbstractPlatform
     {
         return $this->platform;
     }
 
     /**
-     * @param string|string[] $sql
-     *
-     * @return \Doctrine\DBAL\Event\SchemaAlterTableChangeColumnEventArgs
+     * @return $this
      */
-    public function addSql($sql)
+    public function addSql(string ...$sql) : self
     {
-        if (is_array($sql)) {
-            $this->sql = array_merge($this->sql, $sql);
-        } else {
-            $this->sql[] = $sql;
-        }
+        $this->sql = array_merge($this->sql, $sql);
 
         return $this;
     }
 
     /**
-     * @return string[]
+     * @return array<int, string>
      */
-    public function getSql()
+    public function getSql() : array
     {
         return $this->sql;
     }

diff --git a/lib/Doctrine/DBAL/Event/SchemaAlterTableEventArgs.php b/lib/Doctrine/DBAL/Event/SchemaAlterTableEventArgs.php
@@ -7,7 +7,6 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\TableDiff;
 use function array_merge;
-use function is_array;
 
 /**
  * Event Arguments used when SQL queries for creating tables are generated inside Doctrine\DBAL\Platform\*Platform.
@@ -20,7 +19,7 @@ class SchemaAlterTableEventArgs extends SchemaEventArgs
     /** @var AbstractPlatform */
     private $platform;
 
-    /** @var string[] */
+    /** @var array<int, string> */
     private $sql = [];
 
     public function __construct(TableDiff $tableDiff, AbstractPlatform $platform)
@@ -29,42 +28,30 @@ public function __construct(TableDiff $tableDiff, AbstractPlatform $platform)
         $this->platform  = $platform;
     }
 
-    /**
-     * @return TableDiff
-     */
-    public function getTableDiff()
+    public function getTableDiff() : TableDiff
     {
         return $this->tableDiff;
     }
 
-    /**
-     * @return AbstractPlatform
-     */
-    public function getPlatform()
+    public function getPlatform() : AbstractPlatform
     {
         return $this->platform;
     }
 
     /**
-     * @param string|string[] $sql
-     *
-     * @return \Doctrine\DBAL\Event\SchemaAlterTableEventArgs
+     * @return $this
      */
-    public function addSql($sql)
+    public function addSql(string ...$sql) : self
     {
-        if (is_array($sql)) {
-            $this->sql = array_merge($this->sql, $sql);
-        } else {
-            $this->sql[] = $sql;
-        }
+        $this->sql = array_merge($this->sql, $sql);
 
         return $this;
     }
 
     /**
-     * @return string[]
+     * @return array<int, string>
      */
-    public function getSql()
+    public function getSql() : array
     {
         return $this->sql;
     }