ArchiverManager.php

Namespace

Drupal\Core\Archiver

File

drupal/core/lib/Drupal/Core/Archiver/ArchiverManager.php
View source
<?php

/**
 * Contains \Drupal\Core\Archiver\ArchiverManager.
 */
namespace Drupal\Core\Archiver;

use Drupal\Component\Plugin\Factory\DefaultFactory;
use Drupal\Component\Plugin\PluginManagerBase;
use Drupal\Core\Plugin\Discovery\AlterDecorator;
use Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery;
use Drupal\Core\Plugin\Discovery\CacheDecorator;

/**
 * Archiver plugin manager.
 */
class ArchiverManager extends PluginManagerBase {

  /**
   * 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,
   */
  public function __construct(\Traversable $namespaces) {
    $this->discovery = new AnnotatedClassDiscovery('Archiver', $namespaces);
    $this->discovery = new AlterDecorator($this->discovery, 'archiver_info');
    $this->discovery = new CacheDecorator($this->discovery, 'archiver_info');
  }

  /**
   * Overrides \Drupal\Component\Plugin\PluginManagerBase::createInstance().
   */
  public function createInstance($plugin_id, array $configuration = array()) {
    $plugin_definition = $this->discovery
      ->getDefinition($plugin_id);
    $plugin_class = DefaultFactory::getPluginClass($plugin_id, $plugin_definition);
    return new $plugin_class($configuration['filepath']);
  }

  /**
   * Implements \Drupal\Core\PluginManagerInterface::getInstance().
   */
  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);
        }
      }
    }
  }

}

Classes

Namesort descending Description
ArchiverManager Archiver plugin manager.