ArchiverTar

  1. drupal
    1. 8
    2. 7

Archiver for .tar files.

Hierarchy

Properties

NameDescription
ArchiverTar::$tarThe underlying Archive_Tar instance that does the heavy lifting.

Functions & methods

NameDescription
ArchiverTar::addAdd the specified file or directory to the archive. Overrides ArchiverInterface::add
ArchiverTar::extractExtract multiple files in the archive to the specified path. Overrides ArchiverInterface::extract
ArchiverTar::getArchiveRetrieve the tar engine itself.
ArchiverTar::listContentsList all files in the archive. Overrides ArchiverInterface::listContents
ArchiverTar::removeRemove the specified file from the archive. Overrides ArchiverInterface::remove
ArchiverTar::__constructConstructor for a new archiver instance. Overrides ArchiverInterface::__construct

modules/system/system.archiver.inc, line 11

View source
<?php
class ArchiverTar implements ArchiverInterface {

  /**
   * The underlying Archive_Tar instance that does the heavy lifting.
   *
   * @var Archive_Tar
   */
  protected $tar;

  public function __construct($file_path) {
    $this->tar = new Archive_Tar($file_path);
  }

  public function add($file_path) {
    $this->tar->add($file_path);

    return $this;
  }

  public function remove($file_path) {
    // @todo Archive_Tar doesn't have a remove operation
    // so we'll have to simulate it somehow, probably by
    // creating a new archive with everything but the removed
    // file.

    return $this;
  }

  public function extract($path, Array $files = array()) {
    if ($files) {
      $this->tar->extractList($files, $path);
    }
    else {
      $this->tar->extract($path);
    }

    return $this;
  }

  public function listContents() {
    $files = array();
    foreach ($this->tar->listContent() as $file_data) {
      $files[] = $file_data['filename'];
    }
    return $files;
  }

  /**
   * Retrieve the tar engine itself.
   *
   * In some cases it may be necessary to directly access the underlying
   * Archive_Tar object for implementation-specific logic. This is for advanced
   * use only as it is not shared by other implementations of ArchiveInterface.
   *
   * @return
   *   The Archive_Tar object used by this object.
   */
  public function getArchive() {
    return $this->tar;
  }
}
?>