ListableDestinationInterface.php in Backup and Migrate 8.4

Namespace

BackupMigrate\Core\Destination

File

lib/backup_migrate_core/src/Destination/ListableDestinationInterface.php

<?php

namespace BackupMigrate\Core\Destination;

use BackupMigrate\Core\File\BackupFileInterface;

/**
 * Interface ListableDestinationInterface.
 *
 * @package BackupMigrate\Core\Destination
 */
interface ListableDestinationInterface extends DestinationInterface {

  /**
   * Return a list of files from the destination. This list should be
   * date ordered from newest to oldest.
   *
   * @todo Decide if extended metadata should ALWAYS be loaded here. Is there
   * a use case for getting a list of files WITHOUT metadata?
   *
   * @return BackupFileInterface[]
   *   An array of BackupFileInterface objects representing the files with
   *   the file ids as keys. The file ids are usually file names but that
   *   is up to the implementing destination to decide. The returned files
   *   may not be readable. Use loadFileForReading to get a readable file.
   */
  public function listFiles();

  /**
   * Run a basic query with sort on the list of files.
   *
   * @param array $filters An array of of metadata fields to filter by.
   * @param string $sort A metadata field to sort bby
   * @param int $sort_direction The direction to sort by. SORT_ASC or SORT_DESC
   * @param int $count
   * @param int $start
   *
   * @return mixed
   */
  public function queryFiles($filters = [], $sort = NULL, $sort_direction = NULL, $count = 100, $start = 0);

  /**
   * @return int The number of files in the destination.
   */
  public function countFiles();

  /**
   * @return boolean Whether the file exists in this destination
   */
  public function fileExists($id);

  /**
   * Delete the specified file.
   */
  public function deleteFile($id);

}

Interfaces

Name	Description
ListableDestinationInterface	Interface ListableDestinationInterface.