function ArchiverInterface::extract

Same name in other branches
  1. 9 core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\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

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

$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

ArchiverInterface The called object.

2 methods override ArchiverInterface::extract()
ArchiverTar::extract in modules/system/system.archiver.inc
Extracts multiple files in the archive to the specified path.
ArchiverZip::extract in modules/system/system.archiver.inc
Extracts multiple files in the archive to the specified path.

File

includes/archiver.inc, line 59

Class

ArchiverInterface
Defines the common interface for all Archiver classes.

Code

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

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