function ArchiverInterface::extract

Same name in other branches
  1. 7.x includes/archiver.inc \ArchiverInterface::extract()
  2. 8.9.x core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface::extract()
  3. 10 core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface::extract()
  4. 11.x core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface::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.

3 methods override ArchiverInterface::extract()
Tar::extract in core/lib/Drupal/Core/Archiver/Tar.php
Extracts multiple files in the archive to the specified path.
UpdateTestArchiver::extract in core/modules/update/tests/modules/update_test/src/Plugin/Archiver/UpdateTestArchiver.php
Extracts multiple files in the archive to the specified path.
Zip::extract in core/lib/Drupal/Core/Archiver/Zip.php
Extracts multiple files in the archive to the specified path.

File

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

Class

ArchiverInterface
Defines the common interface for all Archiver classes.

Namespace

Drupal\Core\Archiver

Code

public function extract($path, array $files = []);

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