CToolsPluginDiscovery.php in Service Container 7

Contains \Drupal\service_container\Plugin\Discovery\CToolsPluginDiscovery

Namespace

Drupal\service_container\Plugin\Discovery

File

src/Plugin/Discovery/CToolsPluginDiscovery.php

<?php

/**
 * @file
 * Contains \Drupal\service_container\Plugin\Discovery\CToolsPluginDiscovery
 */
namespace Drupal\service_container\Plugin\Discovery;

use Drupal\Component\Plugin\Discovery\DiscoveryInterface;
use Drupal\Component\Plugin\Exception\PluginNotFoundException;

/**
 * A discovery mechanism that uses ctools plugins for Drupal 7 compatibility.
 *
 * This class cannot be tested as it relies on the existence of procedural code.
 * @codeCoverageIgnore
 */
class CToolsPluginDiscovery implements DiscoveryInterface {

  /**
   * The owning module.
   *
   * @var string
   */
  protected $pluginOwner;

  /**
   * The plugin type.
   *
   * @var string
   */
  protected $pluginType;

  /**
   * Constructs a CToolsPluginDiscovery object.
   *
   * @param array $plugin_manager_definition
   *   The domain specific plugin manager definition.
   */
  public function __construct($plugin_manager_definition) {
    $this->pluginOwner = $plugin_manager_definition['owner'];
    $this->pluginType = $plugin_manager_definition['type'];
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinitions() {
    ctools_include('plugins');
    return ctools_get_plugins($this->pluginOwner, $this->pluginType);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinition($plugin_id, $exception_on_invalid = TRUE) {
    ctools_include('plugins');
    $definition = ctools_get_plugins($this->pluginOwner, $this->pluginType, $plugin_id);
    if (!$definition && $exception_on_invalid) {
      throw new PluginNotFoundException($plugin_id, sprintf('The "%s" plugin does not exist.', $plugin_id));
    }
    return $definition;
  }

  /**
   * {@inheritdoc}
   */
  public function hasDefinition($plugin_id) {
    return (bool) $this
      ->getDefinition($plugin_id, FALSE);
  }

}

Classes

Name	Description
CToolsPluginDiscovery	A discovery mechanism that uses ctools plugins for Drupal 7 compatibility.