interface SourceInterface in Backup and Migrate 8.4

Provides an interface defining a backup source.

Hierarchy

• interface \BackupMigrate\Core\Plugin\PluginInterface
  • interface \BackupMigrate\Core\Source\SourceInterface

1 file declares its use of SourceInterface

DrupalSiteArchiveSource.php in src/Source/DrupalSiteArchiveSource.php

File

lib/backup_migrate_core/src/Source/SourceInterface.php, line 11

Namespace

BackupMigrate\Core\Source

interface SourceInterface extends PluginInterface {

  /**
   * Export this source to the given temp file. This should be the main
   * back up function for this source.
   *
   * @return \BackupMigrate\Core\File\BackupFileReadableInterface $file
   *    A backup file with the contents of the source dumped to it..
   */
  public function exportToFile();

  /**
   * Import to this source from the given backup file. This is the main restore
   * function for this source.
   *
   * @param \BackupMigrate\Core\File\BackupFileReadableInterface $file
   *    The file to read the backup from. It will not be opened for reading
   */
  public function importFromFile(BackupFileReadableInterface $file);

}

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
SourceInterface::exportToFile	public	function	Export this source to the given temp file. This should be the main back up function for this source.	2
SourceInterface::importFromFile	public	function	Import to this source from the given backup file. This is the main restore function for this source.	2