class MysqliHooks

Hook implementations for mysqli.

Hierarchy

Expanded class hierarchy of MysqliHooks

File

core/modules/mysqli/src/Hook/MysqliHooks.php, line 14

Namespace

Drupal\mysqli\Hook
View source
class MysqliHooks {
  use RequirementsTrait;
  use StringTranslationTrait;
  
  /**
   * Implements hook_help().
   */
  public function help($route_name, RouteMatchInterface $route_match) : ?string {
    switch ($route_name) {
      case 'help.page.mysqli':
        $output = '';
        $output .= '<h3>' . $this->t('About') . '</h3>';
        $output .= '<p>' . $this->t('The MySQLi module provides the connection between Drupal and a MySQL, MariaDB or equivalent database using the mysqli PHP extension. For more information, see the <a href=":mysqli">online documentation for the MySQLi module</a>.', [
          ':mysqli' => 'https://www.drupal.org/documentation/modules/mysqli',
        ]) . '</p>';
        return $output;
    }
    return NULL;
  }
  
  /**
   * Implements hook_runtime_requirements().
   */
  public function runtimeRequirements() : array {
    if (!Database::isActiveConnection()) {
      return [];
    }
    $connection = Database::getConnection();
    // Only show requirements when MySQLi is the default database connection.
    if (!($connection->driver() === 'mysqli' && $connection->getProvider() === 'mysqli')) {
      return [];
    }
    return $this->getRuntimeRequirements($connection);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
MysqliHooks::help public function Implements hook_help().
MysqliHooks::runtimeRequirements public function Implements hook_runtime_requirements().
RequirementsTrait::getRuntimeRequirements public function Returns runtime requirements.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language. 1

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