interface ArchiverInterface in Backup and Migrate 5.0.x

Interface ArchiveWriterInterface.

@package Drupal\backup_migrate\Core\Environment

Hierarchy

• interface \Drupal\backup_migrate\Core\Service\ArchiverInterface

File

src/Core/Service/ArchiverInterface.php, line 12

Namespace

Drupal\backup_migrate\Core\Service

interface ArchiverInterface {

  /**
   * Get the file extension for this archiver.
   *
   * For a tarball writer this would be 'tar'. For a Zip file writer this would
   * be 'zip'.
   *
   * @return string
   */
  public function getFileExt();

  /**
   * @param \Drupal\backup_migrate\Core\File\BackupFileReadableInterface $out
   */
  public function setArchive(BackupFileReadableInterface $out);

  /**
   * Extract all files to the given directory.
   *
   * @param $directory
   *
   * @return mixed
   */
  public function extractTo($directory);

  /**
   * @param string $real_path
   *   The real path to the file. Can be a stream URI.
   * @param string $base_dir
   *   The base directory of the path to be removed when the file is added.
   *
   * @return
   */
  public function addFile($real_path, $base_dir = '');

  /**
   * This will be called when all files have been added.
   *
   * It gives the implementation a chance to clean up and commit the changes if
   * needed.
   *
   * @return mixed
   */
  public function closeArchive();

}

Members

Name	Modifiers	Type	Description	Overrides
ArchiverInterface::addFile	public	function
ArchiverInterface::closeArchive	public	function	This will be called when all files have been added.
ArchiverInterface::extractTo	public	function	Extract all files to the given directory.
ArchiverInterface::getFileExt	public	function	Get the file extension for this archiver.
ArchiverInterface::setArchive	public	function