class ArchiverManager

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Archiver/ArchiverManager.php \Drupal\Core\Archiver\ArchiverManager
  2. 10 core/lib/Drupal/Core/Archiver/ArchiverManager.php \Drupal\Core\Archiver\ArchiverManager
  3. 11.x core/lib/Drupal/Core/Archiver/ArchiverManager.php \Drupal\Core\Archiver\ArchiverManager

Provides an Archiver plugin manager.


Expanded class hierarchy of ArchiverManager

See also



Plugin API

1 file declares its use of ArchiverManager
UpdateManagerInstall.php in core/modules/update/src/Form/UpdateManagerInstall.php
1 string reference to 'ArchiverManager' in core/
1 service uses ArchiverManager
plugin.manager.archiver in core/


core/lib/Drupal/Core/Archiver/ArchiverManager.php, line 18


View source
class ArchiverManager extends DefaultPluginManager {
     * The file system service.
     * @var \Drupal\Core\File\FileSystemInterface
    protected $fileSystem;
     * Constructs a ArchiverManager object.
     * @param \Traversable $namespaces
     *   An object that implements \Traversable which contains the root paths
     *   keyed by the corresponding namespace to look for plugin implementations.
     * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
     *   Cache backend instance to use.
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler to invoke the alter hook with.
     * @param \Drupal\Core\File\FileSystemInterface $file_system
     *   The file handler.
    public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, FileSystemInterface $file_system = NULL) {
        parent::__construct('Plugin/Archiver', $namespaces, $module_handler, 'Drupal\\Core\\Archiver\\ArchiverInterface', 'Drupal\\Core\\Archiver\\Annotation\\Archiver');
        $this->setCacheBackend($cache_backend, 'archiver_info_plugins');
        if (!isset($file_system)) {
            @trigger_error('Not defining the final $file_system argument to ' . __METHOD__ . ' is deprecated in drupal:8.8.3 and will throw an error in drupal:10.0.0.', E_USER_DEPRECATED);
            $file_system = \Drupal::service('file_system');
        $this->fileSystem = $file_system;
     * {@inheritdoc}
    public function createInstance($plugin_id, array $configuration = []) {
        $plugin_definition = $this->getDefinition($plugin_id);
        $plugin_class = DefaultFactory::getPluginClass($plugin_id, $plugin_definition, 'Drupal\\Core\\Archiver\\ArchiverInterface');
        return new $plugin_class($this->fileSystem
     * {@inheritdoc}
    public function getInstance(array $options) {
        $filepath = $options['filepath'];
        foreach ($this->getDefinitions() as $plugin_id => $definition) {
            foreach ($definition['extensions'] as $extension) {
                // Because extensions may be multi-part, such as .tar.gz,
                // we cannot use simpler approaches like substr() or pathinfo().
                // This method isn't quite as clean but gets the job done.
                // Also note that the file may not yet exist, so we cannot rely
                // on fileinfo() or other disk-level utilities.
                if (strrpos($filepath, '.' . $extension) === strlen($filepath) - strlen('.' . $extension)) {
                    return $this->createInstance($plugin_id, $options);
     * Returns a string of supported archive extensions.
     * @return string
     *   A space-separated string of extensions suitable for use by the file
     *   validation system.
    public function getExtensions() {
        $valid_extensions = [];
        foreach ($this->getDefinitions() as $archive) {
            foreach ($archive['extensions'] as $extension) {
                foreach (explode('.', $extension) as $part) {
                    if (!in_array($part, $valid_extensions)) {
                        $valid_extensions[] = $part;
        return implode(' ', $valid_extensions);



Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ArchiverManager::$fileSystem protected property The file system service.
ArchiverManager::createInstance public function Overrides PluginManagerBase::createInstance
ArchiverManager::getExtensions public function Returns a string of supported archive extensions.
ArchiverManager::getInstance public function Overrides PluginManagerBase::getInstance
ArchiverManager::__construct public function Constructs a ArchiverManager object. Overrides DefaultPluginManager::__construct
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional namespaces the annotation discovery mechanism should scan for
annotation definitions.
DefaultPluginManager::$alterHook protected property Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey protected property The cache key.
DefaultPluginManager::$cacheTags protected property An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults protected property A set of defaults to be referenced by $this->processDefinition() if
additional processing of plugins is necessary or helpful for development
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object that implements \Traversable which contains the root paths
keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface protected property The interface each plugin should implement. 1
DefaultPluginManager::$subdir protected property The subdirectory within a namespace to look for plugins, or FALSE if the
plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 1
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 5
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::fixContextAwareDefinitions private function Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions protected function Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions 2
DefaultPluginManager::getDiscovery protected function Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery 12
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 13
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 3
DefaultPluginManager::setCacheBackend public function Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions protected function Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches public function Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches 1
DiscoveryCachedTrait::$definitions protected property Cached definitions array. 1
DiscoveryCachedTrait::getDefinition public function Overrides DiscoveryTrait::getDefinition 3
DiscoveryTrait::doGetDefinition protected function Gets a specific plugin definition.
DiscoveryTrait::hasDefinition public function
PluginManagerBase::$discovery protected property The object that discovers plugins managed by this manager.
PluginManagerBase::$factory protected property The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper protected property The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
UseCacheBackendTrait::$cacheBackend protected property Cache backend instance.
UseCacheBackendTrait::$useCaches protected property Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet protected function Fetches from the cache backend, respecting the use caches flag. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.

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