ArchiverInterface.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Archiver/ArchiverInterface.php
  2. 10 core/lib/Drupal/Core/Archiver/ArchiverInterface.php
  3. 11.x core/lib/Drupal/Core/Archiver/ArchiverInterface.php

Namespace

Drupal\Core\Archiver

File

core/lib/Drupal/Core/Archiver/ArchiverInterface.php

View source
<?php

namespace Drupal\Core\Archiver;


/**
 * Defines the common interface for all Archiver classes.
 *
 * @see \Drupal\Core\Archiver\ArchiverManager
 * @see \Drupal\Core\Archiver\Annotation\Archiver
 * @see plugin_api
 */
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();

}

Interfaces

Title Deprecated Summary
ArchiverInterface Defines the common interface for all Archiver classes.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.