function Tar::extract

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Archiver/Tar.php \Drupal\Core\Archiver\Tar::extract()
  2. 10 core/lib/Drupal/Core/Archiver/Tar.php \Drupal\Core\Archiver\Tar::extract()
  3. 11.x core/lib/Drupal/Core/Archiver/Tar.php \Drupal\Core\Archiver\Tar::extract()

Extracts multiple files in the archive to the specified path.

Parameters

string $path: A full system path of the directory to which to extract files.

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 value

$this The called object.

Overrides ArchiverInterface::extract

File

core/lib/Drupal/Core/Archiver/Tar.php, line 55

Class

Tar
Defines an archiver implementation for .tar files.

Namespace

Drupal\Core\Archiver

Code

public function extract($path, array $files = []) {
    if ($files) {
        $this->tar
            ->extractList($files, $path, '', FALSE, FALSE);
    }
    else {
        $this->tar
            ->extract($path, FALSE, FALSE);
    }
    return $this;
}

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