interface PluginInterface in Backup and Migrate 8.4

An interface to describe a Backup and Migrate plugin.

Plugins take care of all elements of the backup process and can be configured externally.

All of the work is done in plugins. Therefore they may need injected:.

Sources Destinations Other Plugins? Config Application Cache State TempFileManager TempFileAdapter.

Hierarchy

• interface \BackupMigrate\Core\Plugin\PluginInterface

2 files declare their use of PluginInterface

DestinationInterface.php in lib/backup_migrate_core/src/Destination/DestinationInterface.php

SourceInterface.php in lib/backup_migrate_core/src/Source/SourceInterface.php

File

lib/backup_migrate_core/src/Plugin/PluginInterface.php, line 23

Namespace

BackupMigrate\Core\Plugin

interface PluginInterface {

  /**
   * Get a list of supported operations and their weight.
   *
   * An array of operations should take the form:
   *
   * [
   *  'backup' => ['weight' => 100],
   *  'restore' => ['weight' => -100],
   * ];
   *
   * @return array
   */
  public function supportedOps();

  /**
   * Does this plugin implement the given operation.
   *
   * @param $op string The name of the operation
   *
   * @return bool
   */
  public function supportsOp($op);

  /**
   * What is the weight of the given operation for this plugin.
   *    * @param $op string The name of the operation.
   *
   * @return int
   */
  public function opWeight($op);

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInterface::opWeight	public	function	What is the weight of the given operation for this plugin.	1
PluginInterface::supportedOps	public	function	Get a list of supported operations and their weight.	1
PluginInterface::supportsOp	public	function	Does this plugin implement the given operation.	1