archiver_get_archiver($file) Creates the appropriate archiver for the specified file. Parameters $file: The full path of the archive file. Note that stream wrapper paths are supported, but not remote ones. Return value A newly created instance of the archiver class appropriate for the specified file, already bound to that file. If no appropriate archiver class was found, will return FALSE. File core/includes/common.inc, line 1245 Common functions that many Drupal modules will need to referenc

public ArchiverManager::getInstance(array $options) Gets a preconfigured instance of a plugin. Parameters array $options: An array of options that can be used to determine a suitable plugin to instantiate and how to configure it. Return value object|false A fully configured plugin instance. The interface of the plugin instance will depends on the plugin type. If no instance can be retrieved, FALSE will be returned. Overrides PluginManagerBase::getInstance File core/lib/Drupal/Core/Archiver/Ar

public ArchiverInterface::remove($path) Removes the specified file from the archive. Parameters string $path: The file name relative to the root of the archive to remove. Return value \Drupal\Core\Archiver\ArchiverInterface The called object. File core/lib/Drupal/Core/Archiver/ArchiverInterface.php, line 35 Class ArchiverInterface Defines the common interface for all Archiver classes. Namespace Drupal\Core\Archiver Code public function remove($path);

Provides an Archiver plugin manager. Hierarchy class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTraitclass \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTraitclass \Drupal\Core\Archiver\ArchiverManager See also \Drupal\Core\Archiver\Annotation\Archiver \Drupal\Core\Archiver\ArchiverInterface Plugin API File core/lib/

public ArchiverManager::createInstance($plugin_id, array $configuration = array()) Creates a pre-configured instance of a plugin. Parameters string $plugin_id: The ID of the plugin being instantiated. array $configuration: An array of configuration relevant to the plugin instance. Return value object A fully configured plugin instance. Throws \Drupal\Component\Plugin\Exception\PluginException If the instance cannot be created, such as if the ID is invalid. Overrides PluginManagerBase::create

Defines an exception class for Drupal\Core\Archiver\ArchiverInterface. Hierarchy class \Drupal\Core\Archiver\ArchiverException extends \Exception File core/lib/Drupal/Core/Archiver/ArchiverException.php, line 8 Namespace Drupal\Core\Archiver Members

The human-readable name of the archiver plugin. Type: \Drupal\Core\Annotation\Translation Related topics Annotation for translatable text Describes how to put translatable UI text into annotations. File core/lib/Drupal/Core/Archiver/Annotation/Archiver.php, line 37 Class Archiver Defines an archiver annotation object. Namespace Drupal\Core\Archiver\Annotation Code public $title;

Defines the common interface for all Archiver classes. Hierarchy interface \Drupal\Core\Archiver\ArchiverInterface See also \Drupal\Core\Archiver\ArchiverManager \Drupal\Core\Archiver\Annotation\Archiver Plugin API File core/lib/Drupal/Core/Archiver/ArchiverInterface.php, line 12 Namespace Drupal\Core\Archiver Members Name Modifiers Type Description ArchiverInterface::add public function Adds the specified file or directory to the archive. ArchiverInterface::extract

The archiver plugin ID. Type: string File core/lib/Drupal/Core/Archiver/Annotation/Archiver.php, line 28 Class Archiver Defines an archiver annotation object. Namespace Drupal\Core\Archiver\Annotation Code public $id;

public ArchiverInterface::add($file_path) Adds the specified file or directory to the archive. Parameters string $file_path: The full system path of the file or directory to add. Only local files and directories are supported. Return value \Drupal\Core\Archiver\ArchiverInterface The called object. File core/lib/Drupal/Core/Archiver/ArchiverInterface.php, line 24 Class ArchiverInterface Defines the common interface for all Archiver classes. Namespace Drupal\Core\Archiver Code public f