function Tasks::connect

Same name in this branch
  1. 11.x core/modules/mysql/src/Driver/Database/mysql/Install/Tasks.php \Drupal\mysql\Driver\Database\mysql\Install\Tasks::connect()
  2. 11.x core/modules/pgsql/src/Driver/Database/pgsql/Install/Tasks.php \Drupal\pgsql\Driver\Database\pgsql\Install\Tasks::connect()
  3. 11.x core/lib/Drupal/Core/Database/Install/Tasks.php \Drupal\Core\Database\Install\Tasks::connect()
Same name in other branches
  1. 9 core/modules/sqlite/src/Driver/Database/sqlite/Install/Tasks.php \Drupal\sqlite\Driver\Database\sqlite\Install\Tasks::connect()
  2. 9 core/modules/mysql/src/Driver/Database/mysql/Install/Tasks.php \Drupal\mysql\Driver\Database\mysql\Install\Tasks::connect()
  3. 9 core/modules/pgsql/src/Driver/Database/pgsql/Install/Tasks.php \Drupal\pgsql\Driver\Database\pgsql\Install\Tasks::connect()
  4. 9 core/lib/Drupal/Core/Database/Install/Tasks.php \Drupal\Core\Database\Install\Tasks::connect()
  5. 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Install/Tasks.php \Drupal\Core\Database\Driver\sqlite\Install\Tasks::connect()
  6. 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Install/Tasks.php \Drupal\Core\Database\Driver\mysql\Install\Tasks::connect()
  7. 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Install/Tasks.php \Drupal\Core\Database\Driver\pgsql\Install\Tasks::connect()
  8. 8.9.x core/lib/Drupal/Core/Database/Install/Tasks.php \Drupal\Core\Database\Install\Tasks::connect()
  9. 10 core/modules/sqlite/src/Driver/Database/sqlite/Install/Tasks.php \Drupal\sqlite\Driver\Database\sqlite\Install\Tasks::connect()
  10. 10 core/modules/mysql/src/Driver/Database/mysql/Install/Tasks.php \Drupal\mysql\Driver\Database\mysql\Install\Tasks::connect()
  11. 10 core/modules/pgsql/src/Driver/Database/pgsql/Install/Tasks.php \Drupal\pgsql\Driver\Database\pgsql\Install\Tasks::connect()
  12. 10 core/lib/Drupal/Core/Database/Install/Tasks.php \Drupal\Core\Database\Install\Tasks::connect()

Overrides Tasks::connect

File

core/modules/sqlite/src/Driver/Database/sqlite/Install/Tasks.php, line 62

Class

Tasks
Specifies installation tasks for SQLite databases.

Namespace

Drupal\sqlite\Driver\Database\sqlite\Install

Code

protected function connect() {
    try {
        // This doesn't actually test the connection.
        Database::setActiveConnection();
        // Now actually do a check.
        Database::getConnection();
        $this->pass('Drupal can CONNECT to the database ok.');
    } catch (\Exception $e) {
        // Attempt to create the database if it is not found.
        if ($e->getCode() == Connection::DATABASE_NOT_FOUND) {
            // Remove the database string from connection info.
            $connection_info = Database::getConnectionInfo();
            $database = $connection_info['default']['database'];
            // We cannot use \Drupal::service('file_system')->getTempDirectory()
            // here because we haven't yet successfully connected to the database.
            $connection_info['default']['database'] = \Drupal::service('file_system')->tempnam(sys_get_temp_dir(), 'sqlite');
            // In order to change the Database::$databaseInfo array, need to remove
            // the active connection, then re-add it with the new info.
            Database::removeConnection('default');
            Database::addConnectionInfo('default', 'default', $connection_info['default']);
            try {
                Database::getConnection()->createDatabase($database);
                Database::closeConnection();
                // Now, restore the database config.
                Database::removeConnection('default');
                $connection_info['default']['database'] = $database;
                Database::addConnectionInfo('default', 'default', $connection_info['default']);
                // Check the database connection.
                Database::getConnection();
                $this->pass('Drupal can CONNECT to the database ok.');
            } catch (DatabaseNotFoundException $e) {
                // Still no dice; probably a permission issue. Raise the error to the
                // installer.
                $this->fail(t('Failed to open or create database file %database. The database engine reports the following message when attempting to create the database: %error.', [
                    '%database' => $database,
                    '%error' => $e->getMessage(),
                ]));
            }
        }
        else {
            // Database connection failed for some other reason than a non-existent
            // database.
            $this->fail(t('Failed to connect to database. The database engine reports the following message: %error.<ul><li>Does the database file exist?</li><li>Does web server have permission to write to the database file?</li>Does the web server have permission to write to the directory the database file should be created in?</li></ul>', [
                '%error' => $e->getMessage(),
            ]));
            return FALSE;
        }
    }
    return TRUE;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.