class backup_migrate_destination_remote in Backup and Migrate 6.3

A base class for creating destinations.

Hierarchy

• class \backup_migrate_item
  • class \backup_migrate_location
    • class \backup_migrate_destination
      • class \backup_migrate_destination_remote

File

includes/destinations.inc, line 1050

class backup_migrate_destination_remote extends backup_migrate_destination {

  /**
   * The location is a URI so parse it and store the parts.
   */
  function get_location() {
    return $this
      ->url(FALSE);
  }

  /**
   * The location to display is the url without the password.
   */
  function get_display_location() {
    return $this
      ->url(TRUE);
  }

  /**
   * Return the location with the password.
   */
  function set_location($location) {
    $this->location = $location;
    $this
      ->set_url($location);
  }

  /**
   * Destination configuration callback.
   */
  function edit_form() {
    $form = parent::edit_form();
    $form['scheme'] = array(
      "#type" => "textfield",
      "#title" => t("Scheme"),
      "#default_value" => @$this->dest_url['scheme'] ? $this->dest_url['scheme'] : '',
      "#required" => TRUE,
      "#weight" => 0,
    );
    $form['host'] = array(
      "#type" => "textfield",
      "#title" => t("Host"),
      "#default_value" => @$this->dest_url['host'] ? $this->dest_url['host'] : 'localhost',
      "#required" => TRUE,
      "#weight" => 10,
    );
    $form['path'] = array(
      "#type" => "textfield",
      "#title" => t("Path"),
      "#default_value" => @$this->dest_url['path'],
      "#required" => TRUE,
      "#weight" => 20,
    );
    $form['user'] = array(
      "#type" => "textfield",
      "#title" => t("Username"),
      "#default_value" => @$this->dest_url['user'],
      "#required" => TRUE,
      "#weight" => 30,
    );
    $form['pass'] = array(
      "#type" => "password",
      "#title" => t("Password"),
      "#default_value" => @$this->dest_url['pass'],
      '#description' => '',
      "#weight" => 40,
    );
    if (@$this->dest_url['pass']) {
      $form['old_password'] = array(
        "#type" => "value",
        "#value" => @$this->dest_url['pass'],
      );
      $form['pass']["#description"] .= t(' You do not need to enter a password unless you wish to change the currently saved password.');
    }
    return $form;
  }

  /**
   * Submit the configuration form. Glue the url together and add the old password back if a new one was not specified.
   */
  function edit_form_submit($form, &$form_state) {
    $form_state['values']['pass'] = $form_state['values']['pass'] ? $form_state['values']['pass'] : $form_state['values']['old_password'];
    $form_state['values']['location'] = $this
      ->glue_url($form_state['values'], FALSE);
    parent::edit_form_submit($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
backup_migrate_destination::$cache_expire		property
backup_migrate_destination::$cache_files		property		2
backup_migrate_destination::$db_table		property	Overrides backup_migrate_location::$db_table
backup_migrate_destination::$default_values		property	Overrides backup_migrate_location::$default_values
backup_migrate_destination::$destination_type		property
backup_migrate_destination::$fetch_time		property
backup_migrate_destination::$plural		property	Overrides backup_migrate_location::$plural
backup_migrate_destination::$singular		property	Overrides backup_migrate_location::$singular
backup_migrate_destination::$supported_ops		property	Overrides backup_migrate_location::$supported_ops	7
backup_migrate_destination::$title_plural		property	Overrides backup_migrate_location::$title_plural
backup_migrate_destination::$title_singular		property	Overrides backup_migrate_location::$title_singular
backup_migrate_destination::$type_name		property	Overrides backup_migrate_location::$type_name
backup_migrate_destination::$weight		property		1
backup_migrate_destination::can_delete_file		function	Determine if we can read the given file.
backup_migrate_destination::can_read_file		function	Determine if we can read the given file. Overrides backup_migrate_location::can_read_file	1
backup_migrate_destination::confirm_destination		function	Check that a destination is valid.	2
backup_migrate_destination::count_files		function	List all the available files in the given destination with their destination specific id.
backup_migrate_destination::create_info_file		function	Create an ini file and write the meta data.
backup_migrate_destination::delete_confirm_message		function	Get the message to send to the user when confirming the deletion of the item. Overrides backup_migrate_location::delete_confirm_message
backup_migrate_destination::delete_file		function	Delete the file with the given destination specific id.	1
backup_migrate_destination::file_cache_clear		function	Retrieve the file list.
backup_migrate_destination::file_cache_get		function	Retrieve the file list.
backup_migrate_destination::file_cache_set		function	Cache the file list.
backup_migrate_destination::file_exists		function	Check if a file exists in the given destination.
backup_migrate_destination::get_action_links		function	Get the action links for a destination. Overrides backup_migrate_location::get_action_links
backup_migrate_destination::get_file_links		function	Get the action links for a file on a given destination.
backup_migrate_destination::get_menu_items		function	Add the menu items specific to the destination type. Overrides backup_migrate_item::get_menu_items	1
backup_migrate_destination::get_remote		function	Get a boolean representing if the destination is remote or local.
backup_migrate_destination::list_files		function	List all the available files in the given destination with their destination specific id.
backup_migrate_destination::load_file		function	Load the file with the given destination specific id and return as a backup_file object.	5
backup_migrate_destination::load_files_info		function	Load up the file's metadata from the accompanying .info file if applicable.
backup_migrate_destination::save_file		function	Save the given file to the destination.	3
backup_migrate_destination::save_file_info		function	Save the file metadata
backup_migrate_destination::settings_default		function	Get the form for the settings for this destination type. Overrides backup_migrate_location::settings_default
backup_migrate_destination::settings_form		function	Get the form for the settings for this destination. Overrides backup_migrate_location::settings_form
backup_migrate_destination::settings_form_submit		function	Submit the settings form. Any values returned will be saved. Overrides backup_migrate_location::settings_form_submit
backup_migrate_destination::settings_form_validate		function	Validate the form for the settings for this destination. Overrides backup_migrate_location::settings_form_validate	1
backup_migrate_destination::strings		function	This function is not supposed to be called. It is just here to help the po extractor out. Overrides backup_migrate_location::strings
backup_migrate_destination::_delete_file		function	Delete the file with the given destination specific id.	3
backup_migrate_destination::_file_info_file		function	Create the info file object.
backup_migrate_destination::_file_info_filename		function	Determine the file name of the info file for a file.
backup_migrate_destination::_list_files		function	List all the available files in the given destination with their destination specific id.	4
backup_migrate_destination::_save_file		function	Save the given file to the destination.	3
backup_migrate_destination_remote::edit_form		function	Destination configuration callback. Overrides backup_migrate_destination::edit_form	2
backup_migrate_destination_remote::edit_form_submit		function	Submit the configuration form. Glue the url together and add the old password back if a new one was not specified. Overrides backup_migrate_item::edit_form_submit	1
backup_migrate_destination_remote::get_display_location		function	The location to display is the url without the password. Overrides backup_migrate_location::get_display_location
backup_migrate_destination_remote::get_location		function	The location is a URI so parse it and store the parts. Overrides backup_migrate_location::get_location
backup_migrate_destination_remote::set_location		function	Return the location with the password. Overrides backup_migrate_location::set_location
backup_migrate_item::$settings_path		property
backup_migrate_item::$show_in_list		property
backup_migrate_item::$storage		property
backup_migrate_item::all_items		function	Get all of the given items.
backup_migrate_item::decode_db_row		function	Decode a loaded db row (unserialize necessary fields).
backup_migrate_item::delete		function	Delete the item from the database.
backup_migrate_item::edit_form_validate		function	Validate the edit form for the item.	4
backup_migrate_item::export		function	Return as an exported array of values.
backup_migrate_item::from_array		function	Load an existing item from an array.
backup_migrate_item::generate_id		function	Return a random (very very likely unique) string id for a new item.
backup_migrate_item::get		function	Get the member with the given key.
backup_migrate_item::get_actions		function	Get the rendered action links for a destination.
backup_migrate_item::get_default_values		function	Get the default values for standard parameters.	2
backup_migrate_item::get_id		function	Get the primary id for this item (if any is set).
backup_migrate_item::get_list		function	Get a table of all items of this type.	1
backup_migrate_item::get_list_header		function	Get header for a lost of this type.
backup_migrate_item::get_machine_name_field		function	Get the machine name field name from the schema.
backup_migrate_item::get_primary_key		function	Get the primary key field title from the schema.
backup_migrate_item::get_schema		function	Get the schema for the item type.
backup_migrate_item::get_serialized_fields		function	Return the fields which must be serialized before saving to the db.
backup_migrate_item::get_settings_path		function	Get the columns needed to list the type.
backup_migrate_item::item		function	A particular item.
backup_migrate_item::item_exists		function	A particular item.
backup_migrate_item::load_row		function	Load an existing item from an database (serialized) array.
backup_migrate_item::revert_confirm_message		function	Get the message to send to the user when confirming the deletion of the item.
backup_migrate_item::save		function	Save the item to the database.
backup_migrate_item::set_id		function	Set the primary id for this item (if any is set).
backup_migrate_item::show_in_list		function	Get the columns needed to list the type.
backup_migrate_item::to_array		function	Return as an array of values.	1
backup_migrate_item::unique_id		function	Make sure this item has a unique id. Should only be called for new items or the item will collide with itself.
backup_migrate_item::_merge_defaults		function	Merge parameters with the given defaults.
backup_migrate_item::__construct		function	Constructor, set the basic info pulled from the db or generated programatically.	4
backup_migrate_location::$subtype		property
backup_migrate_location::backup_settings_default		function	Get the form for the settings for this filter.	2
backup_migrate_location::backup_settings_form		function	Get the form for the settings for this filter.	2
backup_migrate_location::backup_settings_form_submit		function	Submit the settings form. Any values returned will be saved.
backup_migrate_location::backup_settings_form_validate		function	Get the form for the settings for this filter.
backup_migrate_location::create		function	Create a new location of the correct type. Overrides backup_migrate_item::create
backup_migrate_location::file_types		function	Retrieve a list of filetypes supported by this source/destination.	2
backup_migrate_location::get_list_column_info		function	Get the columns needed to list the type. Overrides backup_migrate_item::get_list_column_info
backup_migrate_location::get_list_row		function	Get a row of data to be used in a list of items of this type. Overrides backup_migrate_item::get_list_row	1
backup_migrate_location::get_name		function	Get the name of the item. Overrides backup_migrate_item::get_name	1
backup_migrate_location::get_subtype_name		function	Get the type name of this location for display to the user.
backup_migrate_location::glue_url		function	Glue a URLs component parts back into a URL.	1
backup_migrate_location::location_types		function	Get the available location types.	1
backup_migrate_location::op		function	Does this location support the given operation.
backup_migrate_location::ops		function
backup_migrate_location::remove_op		function	Remove the given op from the support list.
backup_migrate_location::restore_settings_default		function	Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form		function	Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form_submit		function	Submit the settings form. Any values returned will be saved.
backup_migrate_location::restore_settings_form_validate		function	Get the form for the settings for this filter.
backup_migrate_location::settings		function
backup_migrate_location::set_name		function
backup_migrate_location::set_url		function	Break a URL into it's component parts.	1
backup_migrate_location::url		function	Get a url from the parts.	1