backup.config.inc

<?php
/**
 * @file Contains the Backup base class.
 */

/**
 * Base class for creating backups.
 *
 * @ingroup backup_restore
 */
class BackupConfig extends Backup {
  /**
   * {@inheritdoc}
   */
  public function backup(BackupFile $file) {
    $config_type = $this->getConfigType();
    if (!$config_type) {
      return FALSE;
    }

    $file->pushExtension('tar');
    $file->pushExtension('gz');
    $file_path = $file->filePath();
    $config_storage = config_get_config_storage($config_type);
    try {
      $config_storage->exportArchive($file_path);
    }
    catch (ConfigStorageException $e) {
      $this->log($e->getMessage(), array(), 'error');
      return FALSE;
    }

    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function restore(BackupFile $file) {
    $config_type = $this->getConfigType();
    if (!$config_type) {
      return FALSE;
    }

    $config_storage = config_get_config_storage($config_type);
    try {
      $config_storage->importArchive($file->filePath());
    }
    catch (ConfigStorageException $e) {
      $this->log($e->getMessage(), array(), 'error');
      return FALSE;
    }

    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function typeLabel() {
    return t('Configuration');
  }

  /**
   * {@inheritdoc}
   */
  public static function applies($target) {
    list($target_type, $target_name) = explode(':', $target, 2);
    if ($target_type === 'config') {
      $storage = config_get_config_storage($target_name);
      if (is_a($storage, 'ConfigFileStorage')) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Get the type of config being backed-up or restored.
   *
   * @return string|false
   *   Either "active", "staging", or FALSE.
   */
  protected function getConfigType() {
    $target = $this->getTarget();
    if ($target != 'config:active' && $target != 'config:staging') {
      return FALSE;
    }
    list(,$config_type) = explode(':', $target);
    return $config_type;
  }

}