class Tasks in Drupal 9

Specifies installation tasks for SQLite databases.

Hierarchy

• class \Drupal\Core\Database\Install\Tasks
  • class \Drupal\Core\Database\Driver\sqlite\Install\Tasks

4 files declare their use of Tasks

GenerateThemeTest.php in core/tests/Drupal/Tests/Core/Command/GenerateThemeTest.php

HtRouterTest.php in core/tests/Drupal/BuildTests/Framework/Tests/HtRouterTest.php

QuickStartTest.php in core/tests/Drupal/Tests/Core/Command/QuickStartTest.php

Tasks.php in core/modules/system/tests/modules/database_statement_monitoring_test/src/sqlite/Install/Tasks.php

1 string reference to 'Tasks'

system.links.task.yml in core/modules/system/system.links.task.yml

core/modules/system/system.links.task.yml

File

core/lib/Drupal/Core/Database/Driver/sqlite/Install/Tasks.php, line 13

Namespace

Drupal\Core\Database\Driver\sqlite\Install

class Tasks extends InstallTasks {

  /**
   * Minimum required SQLite version.
   *
   * Use to build sqlite library with json1 option for JSON datatype support.
   * @see https://www.sqlite.org/json1.html
   */
  const SQLITE_MINIMUM_VERSION = '3.26';

  /**
   * {@inheritdoc}
   */
  protected $pdoDriver = 'sqlite';

  /**
   * {@inheritdoc}
   */
  public function name() {
    return t('SQLite');
  }

  /**
   * {@inheritdoc}
   */
  public function minimumVersion() {
    return static::SQLITE_MINIMUM_VERSION;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormOptions(array $database) {
    $form = parent::getFormOptions($database);

    // Remove the options that only apply to client/server style databases.
    unset($form['username'], $form['password'], $form['advanced_options']['host'], $form['advanced_options']['port']);

    // Make the text more accurate for SQLite.
    $form['database']['#title'] = t('Database file');
    $form['database']['#description'] = t('The absolute path to the file where @drupal data will be stored. This must be writable by the web server and should exist outside of the web root.', [
      '@drupal' => drupal_install_profile_distribution_name(),
    ]);
    $default_database = \Drupal::getContainer()
      ->getParameter('site.path') . '/files/.ht.sqlite';
    $form['database']['#default_value'] = empty($database['database']) ? $default_database : $database['database'];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Tasks::$pdoDriver	protected	property	The name of the PDO driver this database type requires. Overrides Tasks::$pdoDriver
Tasks::$results	protected	property	Results from tasks.
Tasks::$tasks	protected	property	Structure that describes each task to run.
Tasks::checkEngineVersion	protected	function	Check the engine version.	1
Tasks::connect	protected	function	Check if we can connect to the database. Overrides Tasks::connect
Tasks::engineVersionRequirementsCheck	final public	function	Checks engine version requirements for the status report.
Tasks::fail	protected	function	Assert test as failed.
Tasks::getConnection	protected	function	Returns the database connection.
Tasks::getFormOptions	public	function	Return driver specific configuration options. Overrides Tasks::getFormOptions
Tasks::hasPdoDriver	protected	function	Ensure the PDO driver is supported by the version of PHP in use.
Tasks::installable	public	function	Check whether Drupal is installable on the database.
Tasks::isConnectionActive	protected	function	Determines if there is an active connection.
Tasks::minimumVersion	public	function	Return the minimum required version of the engine. Overrides Tasks::minimumVersion
Tasks::name	public	function	Return the human-readable name of the driver. Overrides Tasks::name
Tasks::pass	protected	function	Assert test as a pass.
Tasks::runTasks	public	function	Run database tasks and tests to see if Drupal can run on the database.
Tasks::runTestQuery	protected	function	Run SQL tests to ensure the database can execute commands with the current user.
Tasks::SQLITE_MINIMUM_VERSION		constant	Minimum required SQLite version.
Tasks::t	protected	function	Translates a string to the current language or to a given language.
Tasks::validateDatabaseSettings	public	function	Validates driver specific configuration settings.