class ArchiverTar

Archiver for .tar files.

Hierarchy

Expanded class hierarchy of ArchiverTar

2 string references to 'ArchiverTar'
hook_archiver_info in modules/system/system.api.php
Declare archivers to the system.
system_archiver_info in modules/system/system.module
Implements hook_archiver_info().

File

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

View source 
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, '', FALSE, FALSE);
        }
        else {
            $this->tar
                ->extract($path, FALSE, FALSE);
        }
        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;
    }

}

Members

Title Modifiers Object type Summary Overriden Title
ArchiverTar::$tar protected property The underlying Archive_Tar instance that does the heavy lifting.
ArchiverTar::add public function Adds the specified file or directory to the archive. Overrides ArchiverInterface::add
ArchiverTar::extract public function Extracts multiple files in the archive to the specified path. Overrides ArchiverInterface::extract
ArchiverTar::getArchive public function Retrieve the tar engine itself.
ArchiverTar::listContents public function Lists all files in the archive. Overrides ArchiverInterface::listContents
ArchiverTar::remove public function Removes the specified file from the archive. Overrides ArchiverInterface::remove
ArchiverTar::__construct public function Constructs a new archiver instance. Overrides ArchiverInterface::__construct

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