class backup_migrate_item in Backup and Migrate 6.3

A base class for items which can be stored in the database, listed, edited, deleted etc.

Hierarchy

• class \backup_migrate_item

File

includes/crud.inc, line 396

CRUD functions for backup and migrate types (schedules, profiles etc.).

class backup_migrate_item {
  var $show_in_list = TRUE;
  var $settings_path = '/settings/';
  var $db_table = '';
  var $type_name = '';
  var $storage = FALSE;
  var $default_values = array();
  var $singular = 'item';
  var $plural = 'items';
  var $title_plural = 'Items';
  var $title_singular = 'Item';

  /**
   * 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('item');
    t('items');
    t('Items');
    t('Item');

    // Help the pot extractor find these strings.
    t('List !type');
    t('Create !type');
    t('Delete !type');
    t('Edit !type');
    t('Export !type');
  }

  /**
   * Constructor, set the basic info pulled from the db or generated programatically.
   */
  function __construct($params = array()) {
    $this
      ->from_array($this
      ->_merge_defaults((array) $params, (array) $this
      ->get_default_values()));
  }

  /**
   * Merge parameters with the given defaults.
   *
   * Works like array_merge_recursive, but it doesn't turn scalar values into arrays.
   */
  function _merge_defaults($params, $defaults) {
    foreach ($defaults as $key => $val) {
      if (!isset($params[$key])) {
        $params[$key] = $val;
      }
      else {
        if (is_array($params[$key])) {
          $params[$key] = $this
            ->_merge_defaults($params[$key], $val);
        }
      }
    }
    return $params;
  }

  /**
   * Get the default values for standard parameters.
   */
  function get_default_values() {
    return $this->default_values;
  }

  /**
   * Save the item to the database.
   */
  function save() {
    if (!$this
      ->get_id()) {
      $this
        ->unique_id();
    }
    $table = $this->db_table;
    $data = $this
      ->to_array();
    drupal_write_record($table, $data, !empty($this->storage) ? $this
      ->get_primary_key() : array());
  }

  /**
   * Delete the item from the database.
   */
  function delete() {
    $keys = (array) $this
      ->get_machine_name_field();
    db_query("DELETE FROM {{$this->db_table}} WHERE {$keys[0]} = '%s'", $this
      ->get_id());
  }

  /**
   * Load an existing item from an array.
   */
  function from_array($params) {
    foreach ($params as $key => $value) {
      if (method_exists($this, 'set_' . $key)) {
        $this
          ->{'set_' . $key}($value);
      }
      else {
        $this->{$key} = $value;
      }
    }
  }

  /**
   * Return as an array of values.
   */
  function to_array() {
    $out = array();

    // Return fields as specified in the schema.
    $schema = $this
      ->get_schema();
    if (!empty($schema['fields']) && is_array($schema['fields'])) {
      foreach ($schema['fields'] as $field => $info) {
        $out[$field] = $this
          ->get($field);
      }
    }
    return $out;
  }

  /**
   * Return as an exported array of values.
   */
  function export() {
    $out = $this
      ->to_array();
    $out['type_name'] = $this->type_name;
    ob_start();
    var_export($out);
    $out = ob_get_contents();
    ob_end_clean();
    return $out;
  }

  /**
   * Load an existing item from an database (serialized) array.
   */
  function load_row($data) {
    $params = array();
    $schema = $this
      ->get_schema();

    // Load fields as specified in the schema.
    foreach ($schema['fields'] as $field => $info) {
      $params[$field] = empty($info['serialize']) ? $data[$field] : unserialize(db_decode_blob($data[$field]));
    }
    $this
      ->from_array($params);
  }

  /**
   * Decode a loaded db row (unserialize necessary fields).
   */
  function decode_db_row($data) {
    $params = array();
    $schema = $this
      ->get_schema();

    // Load fields as specified in the schema.
    foreach ($schema['fields'] as $field => $info) {
      $params[$field] = empty($info['serialize']) ? $data[$field] : unserialize(db_decode_blob($data[$field]));
    }
    return $params;
  }

  /**
   * Return the fields which must be serialized before saving to the db.
   */
  function get_serialized_fields() {
    $out = array();
    $schema = $this
      ->get_schema();
    foreach ($schema['fields'] as $field => $info) {
      if (!empty($info['serialize'])) {
        $out[] = $field;
      }
    }
    return $out;
  }

  /**
   * Get the primary key field title from the schema.
   */
  function get_primary_key() {
    $schema = $this
      ->get_schema();
    return @$schema['primary key'];
  }

  /**
   * Get the machine name field name from the schema.
   */
  function get_machine_name_field() {
    $schema = $this
      ->get_schema();
    if (isset($schema['export']['key'])) {
      return $schema['export']['key'];
    }
    return @$schema['primary key'];
  }

  /**
   * Get the schema for the item type.
   */
  function get_schema() {
    return drupal_get_schema($this->db_table);
  }

  /**
   * Get the primary id for this item (if any is set).
   *
   * We only handle single field keys since that's all we need.
   */
  function get_id() {
    $keys = (array) $this
      ->get_machine_name_field();
    return !empty($keys[0]) && !empty($this->{$keys[0]}) ? (string) $this->{$keys[0]} : '';
  }

  /**
   * Set the primary id for this item (if any is set).
   */
  function set_id($id) {
    $keys = (array) $this
      ->get_machine_name_field();
    if (!empty($keys[0])) {
      return $this->{$keys[0]} = $id;
    }
    return NULL;
  }

  /**
   * Return a random (very very likely unique) string id for a new item.
   */
  function generate_id() {
    $id = md5(uniqid(mt_rand(), true));

    // Find the shortest possible unique id from (min 4 chars).
    for ($i = 4; $i < 32; $i++) {
      $new_id = substr($id, 0, $i);
      if (!$this
        ->item($new_id)) {
        return $new_id;
      }
    }

    // If we get here, then all 28 increasingly complex ids were already taken so we'll try again.
    // this could theoretially lead to an infinite loop, but the odds are incredibly low.
    return $this
      ->generate_id();
  }

  /**
   * Make sure this item has a unique id. Should only be called for new items or the item will collide with itself.
   */
  function unique_id() {
    $id = $this
      ->get_id();

    // Unset the autoincrement field so it can be regenerated.
    foreach ((array) $this
      ->get_primary_key() as $key) {
      $this->{$key} = NULL;
    }

    // If the item doesn't have an ID or if it's id is already taken, generate random one.
    if (!$id || $this
      ->item($id)) {
      $this
        ->set_id($this
        ->generate_id());
    }
  }

  /**
   * Get the name of the item.
   */
  function get_name() {
    return @$this->name;
  }

  /**
   * Get the member with the given key.
   */
  function get($key) {
    if (method_exists($this, 'get_' . $key)) {
      return $this
        ->{'get_' . $key}();
    }
    return @$this->{$key};
  }

  /* UI Stuff */

  /**
   * Get the action links for a destination.
   */
  function get_action_links() {
    $out = array();
    $item_id = $this
      ->get_id();
    $path = $this
      ->get_settings_path();
    if (@$this->storage == BACKUP_MIGRATE_STORAGE_DB || @$this->storage == BACKUP_MIGRATE_STORAGE_OVERRIDEN) {
      $out['edit'] = l(t("edit"), $path . "/edit/{$item_id}");
    }
    else {
      if (@$this->storage == BACKUP_MIGRATE_STORAGE_NONE) {
        $out['edit'] = l(t("override"), $path . "/edit/{$item_id}");
      }
    }
    if (@$this->storage == BACKUP_MIGRATE_STORAGE_DB) {
      $out['delete'] = l(t("delete"), $path . "/delete/{$item_id}");
    }
    else {
      if (@$this->storage == BACKUP_MIGRATE_STORAGE_OVERRIDEN) {
        $out['delete'] = l(t("revert"), $path . "/delete/{$item_id}");
      }
    }
    $out['export'] = l(t("export"), $path . "/export/{$item_id}");
    return $out;
  }

  /**
   * Get a table of all items of this type.
   */
  function get_list() {
    $items = $this
      ->all_items();
    $rows = array();
    foreach ($items as $item) {
      if ($item
        ->show_in_list()) {
        if ($row = $item
          ->get_list_row()) {
          $rows[] = $row;
        }
      }
    }
    if (count($rows)) {
      $out = theme('table', $this
        ->get_list_header(), $rows);
    }
    else {
      $out = t('There are no !items to display.', array(
        '!items' => $this->plural,
      ));
    }
    if (user_access('administer backup and migrate')) {
      $out .= ' ' . l(t('Create a new !item', array(
        '!item' => $this->singular,
      )), $this
        ->get_settings_path() . '/add');
    }
    return $out;
  }

  /**
   * Get the columns needed to list the type.
   */
  function show_in_list() {
    return $this->show_in_list;
  }

  /**
   * Get the columns needed to list the type.
   */
  function get_settings_path() {
    return BACKUP_MIGRATE_MENU_PATH . $this->settings_path . $this->type_name;
  }

  /**
   * Get the columns needed to list the type.
   */
  function get_list_column_info() {
    return array(
      'actions' => array(
        'title' => t(''),
        'html' => TRUE,
        'class' => 'backup-migrate-actions',
      ),
    );
  }

  /**
   * Get header for a lost of this type.
   */
  function get_list_header() {
    $out = array();
    foreach ($this
      ->get_list_column_info() as $key => $col) {
      $out[] = $col['title'];
    }
    return $out;
  }

  /**
   * Get a row of data to be used in a list of items of this type.
   */
  function get_list_row() {
    $out = array();
    foreach ($this
      ->get_list_column_info() as $key => $col) {
      $out[$key] = empty($col['html']) ? check_plain($this
        ->get($key)) : $this
        ->get($key);
      if (isset($col['class'])) {
        $out[$key] = array(
          'data' => $out[$key],
          'class' => $col['class'],
        );
      }
    }
    return $out;
  }

  /**
   * Get the rendered action links for a destination.
   */
  function get_actions() {
    $links = $this
      ->get_action_links();
    return implode(" | ", $links);
  }

  /**
   * Get the edit form for the item.
   */
  function edit_form() {
    $form = array();
    $form['item'] = array(
      '#type' => 'value',
      '#value' => $this,
    );
    $name = $this
      ->get('name');
    $form['name'] = array(
      "#type" => "textfield",
      "#title" => t("!type name", array(
        '!type' => $this->title_singular,
      )),
      "#default_value" => empty($name) ? t('Untitled !type', array(
        '!type' => $this->title_singular,
      )) : $name,
      "#required" => TRUE,
    );
    $form['id'] = array(
      '#type' => 'value',
      '#value' => $this
        ->get_id(),
    );
    $form['machine_name'] = array(
      '#type' => 'value',
      '#value' => $this
        ->get_id(),
    );
    $form['actions'] = array(
      '#prefix' => '<div class="container-inline">',
      '#suffix' => '</div>',
      '#weight' => 99,
    );
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Save !type', array(
        '!type' => t($this->singular),
      )),
    );
    $cancel_url = isset($_GET['destination']) ? $_GET['destination'] : $this
      ->get_settings_path();
    $form['actions']['cancel'] = array(
      '#value' => l(t('Cancel'), $cancel_url),
    );
    return $form;
  }

  /**
   * Validate the edit form for the item.
   */
  function edit_form_validate($form, &$form_state) {
  }

  /**
   * Submit the edit form for the item.
   */
  function edit_form_submit($form, &$form_state) {
    $this
      ->from_array($form_state['values']);
    $this
      ->save();
    _backup_migrate_message('Your !type was saved', array(
      '!type' => t($this->singular),
    ));
  }

  /**
   * Get the message to send to the user when confirming the deletion of the item.
   */
  function delete_confirm_message() {
    return t('Are you sure you want to delete the !type %name?', array(
      '!type' => t($this->singular),
      '%name' => $this
        ->get('name'),
    ));
  }

  /**
   * Get the message to send to the user when confirming the deletion of the item.
   */
  function revert_confirm_message() {
    return t('Are you sure you want to revert the !type %name back to the default settings?', array(
      '!type' => t($this->singular),
      '%name' => $this
        ->get('name'),
    ));
  }

  /* Static Functions */

  /**
   * Get the menu items for manipulating this type.
   */
  function get_menu_items() {
    $path = $this
      ->get_settings_path();
    $type = $this->type_name;
    $items[$path] = array(
      'title' => $this->title_plural,
      'page callback' => 'backup_migrate_menu_callback',
      'page arguments' => array(
        'crud',
        'backup_migrate_crud_ui_list',
        TRUE,
        $this->type_name,
      ),
      'access arguments' => array(
        'administer backup and migrate',
      ),
      'weight' => 2,
      'type' => MENU_LOCAL_TASK,
    );
    $items[$path . '/list'] = array(
      'title' => 'List !type',
      'title arguments' => array(
        '!type' => t($this->title_plural),
      ),
      'weight' => 1,
      'type' => MENU_DEFAULT_LOCAL_TASK,
    );
    $items[$path . '/add'] = array(
      'title' => 'Create !type',
      'title arguments' => array(
        '!type' => t($this->title_singular),
      ),
      'page callback' => 'backup_migrate_menu_callback',
      'page arguments' => array(
        'crud',
        'backup_migrate_crud_ui_create',
        TRUE,
        $this->type_name,
      ),
      'access arguments' => array(
        'administer backup and migrate',
      ),
      'weight' => 2,
      'type' => MENU_LOCAL_TASK,
    );
    $items[$path . '/delete'] = array(
      'title' => 'Delete !type',
      'title arguments' => array(
        '!type' => t($this->title_singular),
      ),
      'page callback' => 'backup_migrate_menu_callback',
      'page arguments' => array(
        'crud',
        'backup_migrate_crud_ui_delete',
        TRUE,
        $this->type_name,
      ),
      'access arguments' => array(
        'administer backup and migrate',
      ),
      'type' => MENU_CALLBACK,
    );
    $items[$path . '/edit'] = array(
      'title' => 'Edit !type',
      'title arguments' => array(
        '!type' => t($this->title_singular),
      ),
      'page callback' => 'backup_migrate_menu_callback',
      'page arguments' => array(
        'crud',
        'backup_migrate_crud_ui_edit',
        TRUE,
        $this->type_name,
      ),
      'access arguments' => array(
        'administer backup and migrate',
      ),
      'type' => MENU_LOCAL_TASK,
    );
    $items[$path . '/export'] = array(
      'title' => 'Export !type',
      'title arguments' => array(
        '!type' => t($this->title_singular),
      ),
      'page callback' => 'backup_migrate_menu_callback',
      'page arguments' => array(
        'crud',
        'backup_migrate_crud_ui_export',
        TRUE,
        $this->type_name,
      ),
      'access arguments' => array(
        'administer backup and migrate',
      ),
      'type' => MENU_LOCAL_TASK,
    );
    return $items;
  }

  /**
   * Create a new items with the given input. Doesn't load the parameters, but could use them to determine what type to create.
   */
  function create($params = array()) {
    $type = get_class($this);
    return new $type($params);
  }

  /**
   * Get all of the given items.
   */
  function all_items() {
    static $cache = array();

    // Allow other modules to declare destinations programatically.
    $items = module_invoke_all($this->db_table);

    // Get CTools exported versions.
    if (function_exists('ctools_include')) {
      ctools_include('export');
      $defaults = ctools_export_load_object($this->db_table);
      foreach ($defaults as $info) {
        $info = (array) $info;
        if (!empty($info) && ($item = $this
          ->create($info))) {
          $items[$item
            ->get_id()] = $item;
        }
      }
    }

    // Get any items stored as a variable. This allows destinations to be defined in settings.php
    $defaults = (array) variable_get($this->db_table . '_defaults', array());
    foreach ($defaults as $info) {
      if (is_array($info) && ($item = $this
        ->create($info))) {
        $items[$item
          ->get_id()] = $item;
      }
    }

    // Get the items from the db.
    $result = db_query("SELECT * FROM {{$this->db_table}}");
    while ($info = db_fetch_array($result)) {
      $info = $this
        ->decode_db_row($info);
      if ($item = $this
        ->create($info)) {
        $item->storage = empty($items[$item
          ->get_id()]) ? BACKUP_MIGRATE_STORAGE_DB : BACKUP_MIGRATE_STORAGE_OVERRIDEN;
        $items[$item
          ->get_id()] = $item;
      }
    }

    // Allow other modules to alter the items. This should maybe be before the db override code above
    // but then the filters are not able to set defaults for missing values. Other modules should just
    // be careful not to overwrite the user's UI changes in an unexpected way.
    drupal_alter($this->db_table, $items);
    return $items;
  }

  /**
   * A particular item.
   */
  function item($item_id) {
    $items = $this
      ->all_items();
    return !empty($items[$item_id]) ? $items[$item_id] : NULL;
  }

  /**
   * A particular item.
   */
  function item_exists($item_id) {
    $items = $this
      ->all_items();
    return !empty($items[$item_id]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
backup_migrate_item::$db_table		property		3
backup_migrate_item::$default_values		property		2
backup_migrate_item::$plural		property		3
backup_migrate_item::$settings_path		property
backup_migrate_item::$show_in_list		property
backup_migrate_item::$singular		property		3
backup_migrate_item::$storage		property
backup_migrate_item::$title_plural		property		3
backup_migrate_item::$title_singular		property		3
backup_migrate_item::$type_name		property		3
backup_migrate_item::all_items		function	Get all of the given items.
backup_migrate_item::create		function	Create a new items with the given input. Doesn't load the parameters, but could use them to determine what type to create.	1
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::delete_confirm_message		function	Get the message to send to the user when confirming the deletion of the item.	3
backup_migrate_item::edit_form		function	Get the edit form for the item.	3
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.	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_action_links		function	Get the action links for a destination.	1
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_column_info		function	Get the columns needed to list the type.	3
backup_migrate_item::get_list_header		function	Get header for a lost of this type.
backup_migrate_item::get_list_row		function	Get a row of data to be used in a list of items of this type.	2
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_name		function	Get the name of the item.	1
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::strings		function	This function is not supposed to be called. It is just here to help the po extractor out.	3
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