class backup_migrate_filter_backup_restore in Backup and Migrate 6.3

A filter backup or migrate the specified source.

Hierarchy

• class \backup_migrate_filter
  • class \backup_migrate_filter_backup_restore

1 string reference to 'backup_migrate_filter_backup_restore'

backup_migrate_backup_migrate_filters in includes/filters.inc

Implementation of hook_backup_migrate_filters().

File

includes/filters.backup_restore.inc, line 14

This filter performs tha actual backup or restore operation. Not technically a filter per-se, but it does need to fit in the call chain.

class backup_migrate_filter_backup_restore extends backup_migrate_filter {
  var $op_weights = array(
    'backup' => 0,
    'restore' => 0,
  );

  /**
   * Get the default destinations for this filter.
   */
  function destinations() {
    $out = array();
    foreach ($this
      ->_get_destination_types() as $destination) {
      if (method_exists($destination, 'destinations')) {
        $out += $destination
          ->destinations();
      }
    }
    return $out;
  }

  /**
   * Get the default sources for this filter.
   */
  function sources() {
    $out = array();
    foreach ($this
      ->_get_source_types() as $type) {
      if (method_exists($type, 'sources')) {
        $out += $type
          ->sources();
      }
    }
    return $out;
  }

  /**
   * Get the default backup settings for this filter.
   */
  function backup_settings_default() {
    backup_migrate_include('sources');
    $out = array();
    foreach (backup_migrate_get_sources() as $source) {
      $out['sources'][$source
        ->get_id()] = $source
        ->backup_settings_default();
    }
    return $out;
  }

  /**
   * Get the form for the settings for this filter.
   */
  function backup_settings_form_validate($form, &$form_state) {
    foreach ($this
      ->_get_destination_types() as $destination) {
      $destination
        ->backup_settings_form_validate($form, $form_state);
    }
  }

  /**
   * Submit the settings form. Any values returned will be saved.
   */
  function backup_settings_form_submit($form, $form_state) {
    foreach ($this
      ->_get_destination_types() as $destination) {
      $destination
        ->backup_settings_form_submit($form, $form_state);
    }
  }

  /**
   * Get the default restore settings for this filter.
   */
  function restore_settings_default() {
    $out = array();
    foreach ($this
      ->_get_destination_types() as $destination) {
      $out += $destination
        ->restore_settings_default();
    }
    return $out;
  }

  /**
   * Get the form for the backup settings for this filter.
   */
  function backup_settings_form($settings) {
    backup_migrate_include('sources');
    $out = array(
      'sources' => array(
        '#tree' => TRUE,
      ),
    );
    foreach (backup_migrate_get_sources() as $source) {
      $source_settings = (array) @$settings['sources'][$source
        ->get_id()] + $settings;
      if ($form = $source
        ->backup_settings_form($source_settings)) {
        $out['sources'][$source
          ->get_id()] = array(
          '#type' => 'fieldset',
          '#title' => t('!name Backup Options', array(
            '!name' => $source
              ->get('name'),
          )),
          "#collapsible" => TRUE,
          "#collapsed" => TRUE,
          '#tree' => TRUE,
          '#parents' => array(
            'filters',
            'sources',
            $source
              ->get_id(),
          ),
        ) + $form;
      }
    }
    return $out;
  }

  /**
   * Get the form for the restore settings for this filter.
   */
  function restore_settings_form($settings) {
    $form = array();
    foreach ($this
      ->_get_destination_types() as $destination) {
      $destination
        ->restore_settings_form($form, $settings);
    }
    return $form;
  }

  /**
   * Get the before-backup form for the active sources and destinations.
   */
  function before_action_form($op, $settings) {
    $form = array();
    $method = 'before_' . $op . '_form';
    if ($source = $settings
      ->get_source()) {
      if (method_exists($source, $method)) {
        $form += $source
          ->{$method}($settings);
      }
    }
    foreach ($settings
      ->get_destinations() as $destination) {
      if (method_exists($destination, $method)) {
        $form += $destination
          ->{$method}($settings);
      }
    }
    return $form;
  }

  /**
   * Get the before-backup form for the active sources and destinations.
   */
  function before_action_form_validate($op, $settings, $form, $form_state) {
    $method = 'before_' . $op . '_form_validate';
    foreach ($settings
      ->get_all_locations() as $location) {
      if (method_exists($location, $method)) {
        $location
          ->{$method}($settings, $form, $form_state);
      }
    }
  }

  /**
   * Get the before-backup form for the active sources and destinations.
   */
  function before_action_form_submit($op, $settings, $form, $form_state) {
    $method = 'before_' . $op . '_form_submit';
    foreach ($settings
      ->get_all_locations() as $location) {
      if (method_exists($location, $method)) {
        $location
          ->{$method}($settings, $form, $form_state);
      }
    }
  }

  /**
   * Get the file types supported by this destination.
   */
  function file_types() {
    $types = array();
    foreach ($this
      ->_get_destination_types() as $destination) {
      $types += $destination
        ->file_types();
    }
    foreach ($this
      ->_get_source_types() as $source) {
      $types += $source
        ->file_types();
    }
    return $types;
  }

  /**
   * Backup the data from the source specified in the settings.
   */
  function backup($file, $settings) {
    if ($source = $settings
      ->get_source()) {
      if (!empty($settings->filters['sources'][$source
        ->get_id()])) {
        $settings->filters = (array) $settings->filters['sources'][$source
          ->get_id()] + $settings->filters;
      }
      $file = $source
        ->backup_to_file($file, $settings);
      return $file;
    }
    backup_migrate_backup_fail("Could not run backup because the source '%source' is missing.", array(
      '%source' => $settings->source_id,
    ), $settings);
    return FALSE;
  }

  /**
   * Restore the data from to source specified in the settings.
   */
  function restore($file, $settings) {
    if ($source = $settings
      ->get_source()) {
      if (!empty($settings->filters['sources'][$source
        ->get_id()])) {
        $settings->filters = (array) $settings->filters['sources'][$source
          ->get_id()] + $settings->filters;
      }
      $num = $source
        ->restore_from_file($file, $settings);
      return $num ? $file : FALSE;
    }
    backup_migrate_restore_fail("Could not run restore because the source '%source' is missing.", array(
      '%source' => $settings->source_id,
    ), $settings);
    return FALSE;
  }

  /**
   * Get a list of dummy destinations representing each of the available destination types.
   */
  function _get_destination_types() {
    backup_migrate_include('destinations');
    static $destinations = NULL;
    if (!is_array($destinations)) {
      $destinations = array();
      $types = backup_migrate_get_destination_subtypes();

      // If no (valid) node type has been provided, display a node type overview.
      foreach ($types as $key => $type) {

        // Include the necessary file if specified by the type.
        if (!empty($type['file'])) {
          require_once './' . $type['file'];
        }
        $destinations[] = new $type['class'](array());
      }
    }
    return $destinations;
  }

  /**
   * Get a list of dummy destinations representing each of the available source types.
   */
  function _get_source_types() {
    backup_migrate_include('sources');
    static $sources = NULL;
    if (!is_array($sources)) {
      $sources = array();
      $types = backup_migrate_get_source_subtypes();

      // If no (valid) node type has been provided, display a node type overview.
      foreach ($types as $key => $type) {

        // Include the necessary file if specified by the type.
        if (!empty($type['file'])) {
          require_once './' . $type['file'];
        }
        $sources[] = new $type['class'](array());
      }
    }
    return $sources;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
backup_migrate_filter::$weight		property
backup_migrate_filter::post_backup		function	This function is called immediately post backup.	1
backup_migrate_filter::post_restore		function	This function is called immediately post restore.	1
backup_migrate_filter::pre_backup		function	This function is called immediately prior to backup.	1
backup_migrate_filter::pre_restore		function	This function is called immediately prior to restore.	1
backup_migrate_filter::restore_settings_form_submit		function	Submit the settings form. Any values returned will be saved.
backup_migrate_filter::restore_settings_form_validate		function	Get the form for the settings for this filter.
backup_migrate_filter::weight		function	Get the weight of the filter for the given op.
backup_migrate_filter_backup_restore::$op_weights		property	Overrides backup_migrate_filter::$op_weights
backup_migrate_filter_backup_restore::backup		function	Backup the data from the source specified in the settings. Overrides backup_migrate_filter::backup
backup_migrate_filter_backup_restore::backup_settings_default		function	Get the default backup settings for this filter. Overrides backup_migrate_filter::backup_settings_default
backup_migrate_filter_backup_restore::backup_settings_form		function	Get the form for the backup settings for this filter. Overrides backup_migrate_filter::backup_settings_form
backup_migrate_filter_backup_restore::backup_settings_form_submit		function	Submit the settings form. Any values returned will be saved. Overrides backup_migrate_filter::backup_settings_form_submit
backup_migrate_filter_backup_restore::backup_settings_form_validate		function	Get the form for the settings for this filter. Overrides backup_migrate_filter::backup_settings_form_validate
backup_migrate_filter_backup_restore::before_action_form		function	Get the before-backup form for the active sources and destinations.
backup_migrate_filter_backup_restore::before_action_form_submit		function	Get the before-backup form for the active sources and destinations.
backup_migrate_filter_backup_restore::before_action_form_validate		function	Get the before-backup form for the active sources and destinations.
backup_migrate_filter_backup_restore::destinations		function	Get the default destinations for this filter. Overrides backup_migrate_filter::destinations
backup_migrate_filter_backup_restore::file_types		function	Get the file types supported by this destination. Overrides backup_migrate_filter::file_types
backup_migrate_filter_backup_restore::restore		function	Restore the data from to source specified in the settings. Overrides backup_migrate_filter::restore
backup_migrate_filter_backup_restore::restore_settings_default		function	Get the default restore settings for this filter. Overrides backup_migrate_filter::restore_settings_default
backup_migrate_filter_backup_restore::restore_settings_form		function	Get the form for the restore settings for this filter. Overrides backup_migrate_filter::restore_settings_form
backup_migrate_filter_backup_restore::sources		function	Get the default sources for this filter.
backup_migrate_filter_backup_restore::_get_destination_types		function	Get a list of dummy destinations representing each of the available destination types.
backup_migrate_filter_backup_restore::_get_source_types		function	Get a list of dummy destinations representing each of the available source types.