Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Archiver/ArchiverManager.php \Drupal\Core\Archiver\ArchiverManager
- 9 core/lib/Drupal/Core/Archiver/ArchiverManager.php \Drupal\Core\Archiver\ArchiverManager
Provides an Archiver plugin manager.
Hierarchy
- class \Drupal\Core\Archiver\ArchiverManager extends \Drupal\Core\Plugin\DefaultPluginManager
Expanded class hierarchy of ArchiverManager
See also
\Drupal\Core\Archiver\Attribute\Archiver
\Drupal\Core\Archiver\ArchiverInterface
1 file declares its use of ArchiverManager
- UpdateManagerInstall.php in core/
modules/ update/ src/ Form/ UpdateManagerInstall.php
1 string reference to 'ArchiverManager'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses ArchiverManager
File
- core/
lib/ Drupal/ Core/ Archiver/ ArchiverManager.php, line 19
Namespace
Drupal\Core\ArchiverView source
class ArchiverManager extends DefaultPluginManager {
/**
* The file system service.
*
* @var \Drupal\Core\File\FileSystemInterface
*/
protected $fileSystem;
/**
* Constructs an 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) {
parent::__construct('Plugin/Archiver', $namespaces, $module_handler, 'Drupal\\Core\\Archiver\\ArchiverInterface', Archiver::class, 'Drupal\\Core\\Archiver\\Annotation\\Archiver');
$this
->alterInfo('archiver_info');
$this
->setCacheBackend($cache_backend, 'archiver_info_plugins');
$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
->realpath($configuration['filepath']), $configuration);
}
/**
* {@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);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ArchiverManager:: |
protected | property | The file system service. | |
ArchiverManager:: |
public | function | ||
ArchiverManager:: |
public | function | Returns a string of supported archive extensions. | |
ArchiverManager:: |
public | function | ||
ArchiverManager:: |
public | function | Constructs an ArchiverManager object. |