Merge pull request #6743 from kenjis/refactor-Database-connect

refactor: Database connect()

Author: paulbalandan

system/BaseModel.php

@@ -64,6 +64,7 @@ abstract class BaseModel
      * should be instantiated.
      *
      * @var string
+     * @phpstan-var non-empty-string
      */
     protected $DBGroup;
 

system/Database/Config.php

@@ -12,6 +12,7 @@
 namespace CodeIgniter\Database;
 
 use CodeIgniter\Config\BaseConfig;
+use Config\Database as DbConfig;
 use InvalidArgumentException;
 
 /**
@@ -38,8 +39,10 @@ class Config extends BaseConfig
     /**
      * Creates the default
      *
-     * @param array|string $group     The name of the connection group to use, or an array of configuration settings.
-     * @param bool         $getShared Whether to return a shared instance of the connection.
+     * @param array|BaseConnection|string|null $group The name of the connection group to use,
+     *                                                or an array of configuration settings.
+     * @phpstan-param array|BaseConnection|non-empty-string|null $group
+     * @param bool $getShared Whether to return a shared instance of the connection.
      *
      * @return BaseConnection
      */
@@ -53,16 +56,21 @@ public static function connect($group = null, bool $getShared = true)
         if (is_array($group)) {
             $config = $group;
             $group  = 'custom-' . md5(json_encode($config));
-        }
+        } else {
+            /** @var DbConfig $dbConfig */
+            $dbConfig = config('Database');
 
-        $config ??= config('Database');
+            if ($group === null) {
+                $group = (ENVIRONMENT === 'testing') ? 'tests' : $dbConfig->defaultGroup;
+            }
 
-        if (empty($group)) {
-            $group = ENVIRONMENT === 'testing' ? 'tests' : $config->defaultGroup;
-        }
+            assert(is_string($group));
+
+            if (! isset($dbConfig->{$group})) {
+                throw new InvalidArgumentException($group . ' is not a valid database connection group.');
+            }
 
-        if (is_string($group) && ! isset($config->{$group}) && strpos($group, 'custom-') !== 0) {
-            throw new InvalidArgumentException($group . ' is not a valid database connection group.');
+            $config = $dbConfig->{$group};
         }
 
         if ($getShared && isset(static::$instances[$group])) {
@@ -71,13 +79,9 @@ public static function connect($group = null, bool $getShared = true)
 
         static::ensureFactory();
 
-        if (isset($config->{$group})) {
-            $config = $config->{$group};
-        }
-
         $connection = static::$factory->load($config, $group);
 
-        static::$instances[$group] = &$connection;
+        static::$instances[$group] = $connection;
 
         return $connection;
     }
@@ -122,6 +126,8 @@ public static function utils($group = null)
     /**
      * Returns a new instance of the Database Seeder.
      *
+     * @phpstan-param null|non-empty-string $group
+     *
      * @return Seeder
      */
     public static function seeder(?string $group = null)

system/Database/Seeder.php

@@ -26,6 +26,7 @@ class Seeder
      * The name of the database group to use.
      *
      * @var string
+     * @phpstan-var non-empty-string
      */
     protected $DBGroup;
 

system/Test/CIUnitTestCase.php

@@ -134,6 +134,7 @@ abstract class CIUnitTestCase extends TestCase
      * If not present, will use the defaultGroup.
      *
      * @var string
+     * @phpstan-var non-empty-string
      */
     protected $DBGroup = 'tests';