class BackupDatabaseClient in Backup Database 8

BackupDatabaseClient class.

Hierarchy

• class \Drupal\backup_db\BackupDatabaseClient implements BackupDatabaseClientInterface

1 string reference to 'BackupDatabaseClient'

backup_db.services.yml in ./backup_db.services.yml

backup_db.services.yml

1 service uses BackupDatabaseClient

backup_db.client in ./backup_db.services.yml

Drupal\backup_db\BackupDatabaseClient

File

src/BackupDatabaseClient.php, line 32

Contains \Drupal\backup_db\BackupDatabaseClient

Namespace

Drupal\backup_db

class BackupDatabaseClient implements BackupDatabaseClientInterface {

  /**
   * @var \Drupal\backup_db\BackupDatabaseFileHandler
   */
  protected $handler;

  /**
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $config;

  /**
   * @param $backup_file \Drupal\backup_db\BackupDatabaseFileHandler
   * @param $connection \Drupal\Core\Database\Connection
   * @param $config \Drupal\Core\Config\ConfigFactoryInterface
   */
  public function __construct(BackupDatabaseFileHandler $handler, Connection $connection, ConfigFactoryInterface $config) {
    $this->handler = $handler;
    $this->connection = $connection;
    $this->config = $config;
  }

  /**
   * Perform the database dump.
   *
   * @return
   *  Mysqldump
   */
  public function dump() {

    // Get configuration for export.
    $config = $this
      ->getSettings();
    $options = $this
      ->getConnectionOptions();

    // Return export to the adapter.
    return new IMysqldump\Mysqldump($options['connection'], $options['username'], $options['password'], [
      'include-tables' => $config
        ->get('settings.include_tables'),
      'exclude-tables' => $config
        ->get('settings.exclude_tables'),
      'compress' => $config
        ->get('settings.compress'),
      'no-data' => $config
        ->get('settings.no_data'),
      'add-drop-table' => $config
        ->get('settings.add_drop_table'),
      'single-transaction' => $config
        ->get('settings.single_transaction'),
      'lock-tables' => $config
        ->get('settings.lock_tables'),
      'add-locks' => $config
        ->get('settings.add_locks'),
      'extended-insert' => $config
        ->get('settings.extended_insert'),
      'complete-insert' => $config
        ->get('settings.complete_insert'),
      'disable-keys' => $config
        ->get('settings.disable_keys'),
      'where' => $config
        ->get('settings.where'),
      'no-create-info' => $config
        ->get('settings.no_create_info'),
      'skip-triggers' => $config
        ->get('settings.skip_triggers'),
      'add-drop-trigger' => $config
        ->get('settings.add_drop_trigger'),
      'routines' => $config
        ->get('settings.routines'),
      'hex-blob' => $config
        ->get('settings.hex_blob'),
      'databases' => $config
        ->get('settings.databases'),
      'add-drop-database' => $config
        ->get('settings.add_drop_database'),
      'skip-tz-utc' => $config
        ->get('settings.skip_tz_utc'),
      'no-autocommit' => $config
        ->get('settings.no_autocommit'),
      'default-character-set' => $config
        ->get('settings.default_character_set'),
      'skip-comments' => $config
        ->get('settings.skip_comments'),
      'skip-dump-date' => $config
        ->get('settings.skip_dump_date'),
    ]);
  }

  /**
   * Return formatted connection options.
   */
  public function getConnectionOptions() {
    $options = $this->connection
      ->getConnectionOptions();

    // Requires formatting as a string.
    $connection = $options['driver'] . ':' . 'host=';
    $connection .= $options['host'] . ';port=';
    $connection .= $options['port'] . ';dbname=';
    $connection .= $options['database'];
    return [
      'connection' => $connection,
      'username' => $options['username'],
      'password' => $options['password'],
    ];
  }

  /**
   * Return the connection.
   */
  public function getConnection() {
    return $this->connection;
  }

  /**
   * Set or update the current database connection.
   *
   * @param $connection \Drupal\Core\Database\Connection
   */
  public function setConnection(Connection $connection) {
    $this->connection = $connection;
  }

  /**
   * Return the file handler.
   */
  public function getFileHandler() {
    return $this->handler;
  }

  /**
   * Return the BackupDatabase settings.
   */
  public function getSettings($name = 'backup_db.settings') {
    return $this->config
      ->get($name);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BackupDatabaseClient::$config	protected	property
BackupDatabaseClient::$connection	protected	property
BackupDatabaseClient::$handler	protected	property
BackupDatabaseClient::dump	public	function	Perform the database dump. Overrides BackupDatabaseClientInterface::dump
BackupDatabaseClient::getConnection	public	function	Return the connection.
BackupDatabaseClient::getConnectionOptions	public	function	Return formatted connection options.
BackupDatabaseClient::getFileHandler	public	function	Return the file handler.
BackupDatabaseClient::getSettings	public	function	Return the BackupDatabase settings.
BackupDatabaseClient::setConnection	public	function	Set or update the current database connection.
BackupDatabaseClient::__construct	public	function