class backup_migrate_source in Backup and Migrate 7.3

A base class for creating sources.

Hierarchy

• class \backup_migrate_item
  • class \backup_migrate_location
    • class \backup_migrate_source

2 string references to 'backup_migrate_source'

backup_migrate_crud_types in includes/crud.inc

Return a list of CRUD types in the module.

backup_migrate_update_7300 in ./backup_migrate.install

Upgrade from Backup & Migrate 7.x-2.x.

File

includes/sources.inc, line 155

class backup_migrate_source extends backup_migrate_location {
  public $db_table = "backup_migrate_sources";
  public $type_name = 'source';
  public $singular = 'source';
  public $plural = 'sources';
  public $title_plural = 'Sources';
  public $title_singular = 'Source';

  /**
   * This function is not supposed to be called.
   *
   * It is just here to help out the po extractor.
   */
  public function strings() {

    // Help the pot extractor find these strings.
    t('source');
    t('sources');
    t('Sources');
    t('Source');
  }

  /**
   * Get the available location types.
   */
  public function location_types() {
    return backup_migrate_get_source_subtypes();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
backup_migrate_item::$settings_path	public	property
backup_migrate_item::$show_in_list	public	property
backup_migrate_item::$storage	public	property
backup_migrate_item::all_items	public	function	Get all of the given items.
backup_migrate_item::decode_db_row	public	function	Decode a loaded db row (unserialize necessary fields).
backup_migrate_item::delete	public	function	Delete the item from the database.
backup_migrate_item::edit_form_submit	public	function	Submit the edit form for the item.	5
backup_migrate_item::edit_form_validate	public	function	Validate the edit form for the item.	4
backup_migrate_item::export	public	function	Return as an exported array of values.
backup_migrate_item::from_array	public	function	Load an existing item from an array.
backup_migrate_item::generate_id	public	function	Return a random (very very likely unique) string id for a new item.
backup_migrate_item::get	public	function	Get the member with the given key.
backup_migrate_item::get_actions	public	function	Get the rendered action links for a destination.
backup_migrate_item::get_default_values	public	function	Get the default values for standard parameters.	2
backup_migrate_item::get_id	public	function	Get the primary id for this item (if any is set).
backup_migrate_item::get_list	public	function	Get a table of all items of this type.	1
backup_migrate_item::get_list_header	public	function	Get header for a lost of this type.
backup_migrate_item::get_machine_name_field	public	function	Get the machine name field name from the schema.
backup_migrate_item::get_menu_items	public	function	Get the menu items for manipulating this type.	2
backup_migrate_item::get_primary_key	public	function	Get the primary key field title from the schema.
backup_migrate_item::get_schema	public	function	Get the schema for the item type.
backup_migrate_item::get_serialized_fields	public	function	Return the fields which must be serialized before saving to the db.
backup_migrate_item::get_settings_path	public	function	Get the columns needed to list the type.	1
backup_migrate_item::item	public	function	A particular item.
backup_migrate_item::item_exists	public	function	A particular item.
backup_migrate_item::load_row	public	function	Load an existing item from an database (serialized) array.
backup_migrate_item::revert_confirm_message	public	function	The message to send to the user when confirming the deletion of the item.
backup_migrate_item::save	public	function	Save the item to the database.
backup_migrate_item::set_id	public	function	Set the primary id for this item (if any is set).
backup_migrate_item::show_in_list	public	function	Get the columns needed to list the type.
backup_migrate_item::to_array	public	function	Return as an array of values.	1
backup_migrate_item::unique_id	public	function	Make sure this item has a unique id.
backup_migrate_item::_merge_defaults	public	function	Merge parameters with the given defaults.
backup_migrate_item::__construct	public	function	Set the basic info pulled from the db or generated programatically.	5
backup_migrate_location::$default_values	public	property	Overrides backup_migrate_item::$default_values	1
backup_migrate_location::$subtype	public	property
backup_migrate_location::$supported_ops	public	property		3
backup_migrate_location::backup_settings_default	public	function	Get the form for the settings for this filter.	3
backup_migrate_location::backup_settings_form	public	function	Get the form for the settings for this filter.	3
backup_migrate_location::backup_settings_form_submit	public	function	Submit the settings form. Any values returned will be saved.
backup_migrate_location::backup_settings_form_validate	public	function	Get the form for the settings for this filter.
backup_migrate_location::can_read_file	public	function	Determine if we can read the given file.	1
backup_migrate_location::create	public	function	Create a new location of the correct type. Overrides backup_migrate_item::create
backup_migrate_location::delete_confirm_message	public	function	Get the message to send to the user when confirming the deletion of the item. Overrides backup_migrate_item::delete_confirm_message	1
backup_migrate_location::edit_form	public	function	Get the edit form for the item. Overrides backup_migrate_item::edit_form	4
backup_migrate_location::file_types	public	function	Retrieve a list of filetypes supported by this source/destination.	3
backup_migrate_location::get_action_links	public	function	Get the action links for a location. Overrides backup_migrate_item::get_action_links	1
backup_migrate_location::get_display_location	public	function		3
backup_migrate_location::get_list_column_info	public	function	Get the columns needed to list the type. Overrides backup_migrate_item::get_list_column_info
backup_migrate_location::get_list_row	public	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_location	public	function		3
backup_migrate_location::get_name	public	function	Get the name of the item. Overrides backup_migrate_item::get_name
backup_migrate_location::get_subtype_name	public	function	Get the type name of this location for display to the user.
backup_migrate_location::glue_url	public	function	Glue a URLs component parts back into a URL.
backup_migrate_location::op	public	function	Does this location support the given operation.
backup_migrate_location::ops	public	function
backup_migrate_location::remove_op	public	function	Remove the given op from the support list.
backup_migrate_location::restore_settings_default	public	function	Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form	public	function	Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form_submit	public	function	Submit the settings form. Any values returned will be saved.
backup_migrate_location::restore_settings_form_validate	public	function	Get the form for the settings for this filter.
backup_migrate_location::settings	public	function
backup_migrate_location::settings_default	public	function	Get the form for the settings for this location type.	1
backup_migrate_location::settings_form	public	function	Get the form for the settings for this location.	1
backup_migrate_location::settings_form_submit	public	function	Submit the settings form. Any values returned will be saved.	1
backup_migrate_location::settings_form_validate	public	function	Validate the form for the settings for this location.	1
backup_migrate_location::set_location	public	function		3
backup_migrate_location::set_name	public	function
backup_migrate_location::set_url	public	function	Break a URL into it's component parts.
backup_migrate_location::url	public	function	Get a url from the parts.
backup_migrate_source::$db_table	public	property	Overrides backup_migrate_location::$db_table
backup_migrate_source::$plural	public	property	Overrides backup_migrate_location::$plural
backup_migrate_source::$singular	public	property	Overrides backup_migrate_location::$singular
backup_migrate_source::$title_plural	public	property	Overrides backup_migrate_location::$title_plural
backup_migrate_source::$title_singular	public	property	Overrides backup_migrate_location::$title_singular
backup_migrate_source::$type_name	public	property	Overrides backup_migrate_location::$type_name
backup_migrate_source::location_types	public	function	Get the available location types. Overrides backup_migrate_location::location_types
backup_migrate_source::strings	public	function	This function is not supposed to be called. Overrides backup_migrate_location::strings