interface ArchiveReaderInterface in Backup and Migrate 5.0.x

Interface ArchiveWriterInterface.

@package Drupal\backup_migrate\Core\Environment

Hierarchy

• interface \Drupal\backup_migrate\Core\Service\ArchiveReaderInterface

1 file declares its use of ArchiveReaderInterface

FileDirectorySource.php in src/Core/Source/FileDirectorySource.php

File

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

Namespace

Drupal\backup_migrate\Core\Service

interface ArchiveReaderInterface {

  /**
   * 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);

  // Public function listFiles()
  // public function extractFile($from, $to);.

  /**
   * 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
ArchiveReaderInterface::closeArchive	public	function	This will be called when all files have been added.	1
ArchiveReaderInterface::extractTo	public	function	Extract all files to the given directory.	1
ArchiveReaderInterface::getFileExt	public	function	Get the file extension for this archiver.	1
ArchiveReaderInterface::setArchive	public	function		1