Full ELMS Learning Network documentation
class backup_migrate_destination_remote
- cis7 sites/all/modules/ulmus/backup_migrate/includes/destinations.inc backup_migrate_destination_remote
- cle7 sites/all/modules/ulmus/backup_migrate/includes/destinations.inc backup_migrate_destination_remote
- elmsmedia7 sites/all/modules/ulmus/backup_migrate/includes/destinations.inc backup_migrate_destination_remote
- icor7 sites/all/modules/ulmus/backup_migrate/includes/destinations.inc backup_migrate_destination_remote
- meedjum_blog7 sites/all/modules/ulmus/backup_migrate/includes/destinations.inc backup_migrate_destination_remote
- mooc7 sites/all/modules/ulmus/backup_migrate/includes/destinations.inc backup_migrate_destination_remote
A base class for creating destinations.
Hierarchy
Expanded class hierarchy of backup_migrate_destination_remote
Members
Name![]() |
Modifiers | Type | Description |
---|---|---|---|
backup_migrate_destination::backup_settings_default | function | Get the form for the settings for this filter. | |
backup_migrate_destination::backup_settings_form | function | Get the form for the settings for this filter. | |
backup_migrate_destination::backup_settings_form_submit | function | Submit the settings form. Any values returned will be saved. | |
backup_migrate_destination::backup_settings_form_validate | function | Get the form for the settings for this filter. | |
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. | |
backup_migrate_destination::create | function | Create a new destination of the correct type. Overrides backup_migrate_item::create | |
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_item::delete_confirm_message | |
backup_migrate_destination::delete_file | function | Delete the file with the given destination specific id. | |
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::file_types | function | ||
backup_migrate_destination::get_action_links | function | Get the action links for a destination. Overrides backup_migrate_item::get_action_links | |
backup_migrate_destination::get_destination_type_name | function | Get the type name of this destination for display to the user. | |
backup_migrate_destination::get_file_links | function | Get the action links for a file on a given destination. | |
backup_migrate_destination::get_list_column_info | function | Get the columns needed to list the type. Overrides backup_migrate_item::get_list_column_info | |
backup_migrate_destination::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 | |
backup_migrate_destination::get_menu_items | function | Add the menu items specific to the destination type. Overrides backup_migrate_item::get_menu_items | |
backup_migrate_destination::get_name | function | Get the name of the item. Overrides backup_migrate_item::get_name | |
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. | |
backup_migrate_destination::load_files_info | function | Load up the file's metadata from the accompanying .info file if applicable. | |
backup_migrate_destination::op | function | Does this destination support the given operation. | |
backup_migrate_destination::ops | function | ||
backup_migrate_destination::remove_op | function | Remove the given op from the support list. | |
backup_migrate_destination::restore_settings_default | function | Get the form for the settings for this filter. | |
backup_migrate_destination::restore_settings_form | function | Get the form for the settings for this filter. | |
backup_migrate_destination::restore_settings_form_submit | function | Submit the settings form. Any values returned will be saved. | |
backup_migrate_destination::restore_settings_form_validate | function | Get the form for the settings for this filter. | |
backup_migrate_destination::save_file | function | Save the given file to the destination. | |
backup_migrate_destination::save_file_info | function | Save the file metadata | |
backup_migrate_destination::settings | function | ||
backup_migrate_destination::settings_default | function | Get the form for the settings for this destination type. | |
backup_migrate_destination::settings_form | function | Get the form for the settings for this destination. | |
backup_migrate_destination::settings_form_submit | function | Submit the settings form. Any values returned will be saved. | |
backup_migrate_destination::settings_form_validate | function | Validate the form for the settings for this destination. | |
backup_migrate_destination::set_name | function | ||
backup_migrate_destination::set_type | function | ||
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_item::strings | |
backup_migrate_destination::_delete_file | function | Delete the file with the given destination specific id. | |
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. | |
backup_migrate_destination::_save_file | function | Save the given file to the destination. | |
backup_migrate_destination_remote::edit_form | function | Destination configuration callback. Overrides backup_migrate_destination::edit_form | |
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 | |
backup_migrate_destination_remote::get_display_location | function | The location to display is the url without the password. Overrides backup_migrate_destination::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_destination::get_location | |
backup_migrate_destination_remote::glue_url | function | Glue a URLs component parts back into a URL. | |
backup_migrate_destination_remote::set_location | function | Return the location with the password. Overrides backup_migrate_destination::set_location | |
backup_migrate_destination_remote::set_url | function | Break a URL into it's component parts. | |
backup_migrate_destination_remote::url | function | Get a url from the parts. | |
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. | |
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. | |
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. | |
backup_migrate_item::get_list_header | function | Get header for a lost of this type. | |
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::item | function | A particular item. | |
backup_migrate_item::load_row | function | Load an existing item from an database (serialized) array. | |
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::to_array | function | Return as an array of values. | |
backup_migrate_item::__construct | function | Constructor, set the basic info pulled from the db or generated programatically. |
File
- sites/
all/ modules/ ulmus/ backup_migrate/ includes/ destinations.inc, line 1049 - All of the destination handling code needed for Backup and Migrate.
View source
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);
}
/**
* Get a url from the parts.
*/
function url($hide_password = TRUE) {
return $this->glue_url($this->dest_url, $hide_password);
}
/**
* Glue a URLs component parts back into a URL.
*/
function glue_url($parts, $hide_password = TRUE) {
// Obscure the password if we need to.
$parts['pass'] = $hide_password ? "" : $parts['pass'];
// Assemble the URL.
$out = "";
$out .= $parts['scheme'] . '://';
$out .= $parts['user'] ? urlencode($parts['user']) : '';
$out .= ($parts['user'] && $parts['pass']) ? ":" . urlencode($parts['pass']) : '';
$out .= ($parts['user'] || $parts['pass']) ? "@" : "";
$out .= $parts['host'];
$out .= !empty($parts['port']) ? ':' . $parts['port'] : '';
$out .= "/" . $parts['path'];
return $out;
}
/**
* Break a URL into it's component parts.
*/
function set_url($url) {
$parts = (array) parse_url($url);
$parts['user'] = urldecode(@$parts['user']);
$parts['pass'] = urldecode(@$parts['pass']);
$parts['path'] = urldecode(@$parts['path']);
$parts['path'] = ltrim(@$parts['path'], "/");
$this->dest_url = $parts;
}
/**
* Destination configuration callback.
*/
function edit_form() {
$form = parent::edit_form();
$form['scheme'] = array(
"#type" => "value",
"#title" => t("Scheme"),
"#default_value" => @$this->dest_url['scheme'] ? $this->dest_url['scheme'] : 'mysql',
"#required" => TRUE,
// "#options" => array($GLOBALS['db_type'] => $GLOBALS['db_type']),
"#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);
}
}