interface ReadableDestinationInterface in Backup and Migrate 8.4

Interface ReadableDestinationInterface.

@package BackupMigrate\Core\Destination

Hierarchy

• interface \BackupMigrate\Core\Plugin\PluginInterface
  • interface \BackupMigrate\Core\Destination\DestinationInterface
    • interface \BackupMigrate\Core\Destination\ReadableDestinationInterface

1 file declares its use of ReadableDestinationInterface

DrupalBrowserUploadDestination.php in src/Destination/DrupalBrowserUploadDestination.php

File

lib/backup_migrate_core/src/Destination/ReadableDestinationInterface.php, line 12

Namespace

BackupMigrate\Core\Destination

interface ReadableDestinationInterface extends DestinationInterface {

  /**
   * Get a file object representing the file with the given ID from the destination.
   * This file item will not necessarily be readable nor will it have extended
   * metadata loaded. Use loadForReading and loadFileMetadata to get those.
   *
   * @TODO: Decide if extended metadata should ALWAYS be loaded here.
   *
   * @param string $id The unique identifier for the file. Usually the filename.
   *
   * @return \BackupMigrate\Core\File\BackupFileInterface
   *    The file if it exists or NULL if it doesn't
   */
  public function getFile($id);

  /**
   * Load the metadata for the given file however it may be stored.
   *
   * @param \BackupMigrate\Core\File\BackupFileInterface $file
   *
   * @return \BackupMigrate\Core\File\BackupFileInterface
   */
  public function loadFileMetadata(BackupFileInterface $file);

  /**
   * Load the file with the given ID from the destination.
   *
   * @param \BackupMigrate\Core\File\BackupFileInterface $file
   *
   * @return \BackupMigrate\Core\File\BackupFileReadableInterface The file if it exists or NULL if it doesn't
   */
  public function loadFileForReading(BackupFileInterface $file);

  /**
   * Does the file with the given id (filename) exist in this destination.
   *
   * @param string $id The id (usually the filename) of the file.
   *
   * @return bool True if the file exists, false if it does not.
   */
  public function fileExists($id);

}

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
ReadableDestinationInterface::fileExists	public	function	Does the file with the given id (filename) exist in this destination.	2
ReadableDestinationInterface::getFile	public	function	Get a file object representing the file with the given ID from the destination. This file item will not necessarily be readable nor will it have extended metadata loaded. Use loadForReading and loadFileMetadata to get those.	2
ReadableDestinationInterface::loadFileForReading	public	function	Load the file with the given ID from the destination.	2
ReadableDestinationInterface::loadFileMetadata	public	function	Load the metadata for the given file however it may be stored.	2