summaryrefslogtreecommitdiffstatshomepage
path: root/core/modules/pgsql/src/Hook/PgsqlRequirementsHooks.php
blob: 65fa78a5e71cfc048b66d1da0899f3fcb38c931c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<?php

namespace Drupal\pgsql\Hook;

use Drupal\Core\Database\Database;
use Drupal\Core\Extension\Requirement\RequirementSeverity;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\Hook\Attribute\Hook;

/**
 * Hook implementations for pgsql module.
 */
class PgsqlRequirementsHooks {

  use StringTranslationTrait;

  /**
   * Implements hook_update_requirements().
   *
   * Implements hook_runtime_requirements().
   */
  #[Hook('update_requirements')]
  #[Hook('runtime_requirements')]
  public function checkRequirements(): array {
    $requirements = [];
    // Test with PostgreSQL databases for the status of the pg_trgm extension.
    if (Database::isActiveConnection()) {
      $connection = Database::getConnection();

      // Set the requirement just for postgres.
      if ($connection->driver() == 'pgsql') {
        $requirements['pgsql_extension_pg_trgm'] = [
          'severity' => RequirementSeverity::OK,
          'title' => $this->t('PostgreSQL pg_trgm extension'),
          'value' => $this->t('Available'),
          'description' => $this->t('The pg_trgm PostgreSQL extension is present.'),
        ];

        // If the extension is not available, set the requirement error.
        if (!$connection->schema()->extensionExists('pg_trgm')) {
          $requirements['pgsql_extension_pg_trgm']['severity'] = RequirementSeverity::Error;
          $requirements['pgsql_extension_pg_trgm']['value'] = $this->t('Not created');
          $requirements['pgsql_extension_pg_trgm']['description'] = $this->t('The <a href=":pg_trgm">pg_trgm</a> PostgreSQL extension is not present. The extension is required by Drupal to improve performance when using PostgreSQL. See <a href=":requirements">Drupal database server requirements</a> for more information.', [
            ':pg_trgm' => 'https://www.postgresql.org/docs/current/pgtrgm.html',
            ':requirements' => 'https://www.drupal.org/docs/system-requirements/database-server-requirements',
          ]);
        }

      }
    }

    return $requirements;
  }

}