You are here

Home » API reference » Backup and Migrate 8.3 » sources.inc

class backup_migrate_source in Backup and Migrate 8.3

Same name and namespace in other branches
  1. 6.3 includes/sources.inc \backup_migrate_source
  2. 7.3 includes/sources.inc \backup_migrate_source

A base class for creating sources.

Hierarchy

Expanded class hierarchy of 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
Uninstall backup migrate files if it's installed

File

includes/sources.inc, line 155

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

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

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

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

}

Members

Namesort descending Modifiers Type Description Overrides
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_submit function Submit the edit form for the item. 6
backup_migrate_item::edit_form_validate function Validate the edit form for the item. 5
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_menu_items function Get the menu items for manipulating this type. 2
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. 1
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::$default_values property Overrides backup_migrate_item::$default_values 1
backup_migrate_location::$subtype property
backup_migrate_location::$supported_ops property 3
backup_migrate_location::backup_settings_default function Get the form for the settings for this filter. 3
backup_migrate_location::backup_settings_form function Get the form for the settings for this filter. 3
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::can_read_file function Determine if we can read the given file. 1
backup_migrate_location::create function Create a new location of the correct type. Overrides backup_migrate_item::create
backup_migrate_location::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 1
backup_migrate_location::edit_form function Get the edit form for the item. Overrides backup_migrate_item::edit_form 4
backup_migrate_location::file_types function Retrieve a list of filetypes supported by this source/destination. 3
backup_migrate_location::get_action_links function Get the action links for a location. Overrides backup_migrate_item::get_action_links 1
backup_migrate_location::get_display_location function 4
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_location function 3
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::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::settings_default function Get the form for the settings for this location type. 1
backup_migrate_location::settings_form function Get the form for the settings for this location. 1
backup_migrate_location::settings_form_submit function Submit the settings form. Any values returned will be saved. 1
backup_migrate_location::settings_form_validate function Validate the form for the settings for this location. 1
backup_migrate_location::set_location function 3
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
backup_migrate_source::$db_table property Overrides backup_migrate_location::$db_table
backup_migrate_source::$plural property Overrides backup_migrate_location::$plural
backup_migrate_source::$singular property Overrides backup_migrate_location::$singular
backup_migrate_source::$title_plural property Overrides backup_migrate_location::$title_plural
backup_migrate_source::$title_singular property Overrides backup_migrate_location::$title_singular
backup_migrate_source::$type_name property Overrides backup_migrate_location::$type_name
backup_migrate_source::location_types function Get the available location types. Overrides backup_migrate_location::location_types
backup_migrate_source::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