You are here

interface ArchiverInterface in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface
  2. 10 core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface

Defines the common interface for all Archiver classes.

Hierarchy

Expanded class hierarchy of ArchiverInterface

All classes that implement ArchiverInterface

See also

\Drupal\Core\Archiver\ArchiverManager

\Drupal\Core\Archiver\Annotation\Archiver

Plugin API

1 file declares its use of ArchiverInterface
UpdateTestArchiver.php in core/modules/update/tests/modules/update_test/src/Plugin/Archiver/UpdateTestArchiver.php

File

core/lib/Drupal/Core/Archiver/ArchiverInterface.php, line 12

Namespace

Drupal\Core\Archiver
View source
interface ArchiverInterface {

  /**
   * Adds the specified file or directory to the archive.
   *
   * @param string $file_path
   *   The full system path of the file or directory to add. Only local files
   *   and directories are supported.
   *
   * @return $this
   *   The called object.
   */
  public function add($file_path);

  /**
   * Removes the specified file from the archive.
   *
   * @param string $path
   *   The file name relative to the root of the archive to remove.
   *
   * @return $this
   *   The called object.
   */
  public function remove($path);

  /**
   * Extracts multiple files in the archive to the specified path.
   *
   * @param string $path
   *   A full system path of the directory to which to extract files.
   * @param array $files
   *   Optionally specify a list of files to be extracted. Files are
   *   relative to the root of the archive. If not specified, all files
   *   in the archive will be extracted.
   *
   * @return $this
   *   The called object.
   */
  public function extract($path, array $files = []);

  /**
   * Lists all files in the archive.
   *
   * @return array
   *   An array of file names relative to the root of the archive.
   */
  public function listContents();

}

Members

Namesort descending Modifiers Type Description Overrides
ArchiverInterface::add public function Adds the specified file or directory to the archive. 3
ArchiverInterface::extract public function Extracts multiple files in the archive to the specified path. 3
ArchiverInterface::listContents public function Lists all files in the archive. 3
ArchiverInterface::remove public function Removes the specified file from the archive. 3