class TestPluginBag

Defines a plugin bag which uses fruit plugins.

Hierarchy

  • class \Drupal\Component\Plugin\PluginBag implements \Drupal\Component\Plugin\Iterator, \Drupal\Component\Plugin\Countable

Expanded class hierarchy of TestPluginBag

1 file declares its use of TestPluginBag
PluginBagTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Plugin/PluginBagTest.php
Contains \Drupal\system\Tests\Plugin\PluginBagTest.

File

drupal/core/modules/system/tests/modules/plugin_test/lib/Drupal/plugin_test/Plugin/TestPluginBag.php, line 16
Contains \Drupal\plugin_test\Plugin\TestPluginBag.

Namespace

Drupal\plugin_test\Plugin
View source
class TestPluginBag extends PluginBag {

  /**
   * Stores the plugin manager used by this bag.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $manager;

  /**
   * Constructs a TestPluginBag object.
   *
   * @param \Drupal\Component\Plugin\PluginManagerInterface $manager
   *   The plugin manager that handles test plugins.
   */
  public function __construct(PluginManagerInterface $manager) {
    $this->manager = $manager;
    $this->instanceIDs = drupal_map_assoc(array_keys($this->manager
      ->getDefinitions()));
  }

  /**
   * Implements \Drupal\Component\Plugin\PluginBag::initializePlugin().
   */
  protected function initializePlugin($instance_id) {

    // If the plugin was initialized before, just return.
    if (isset($this->pluginInstances[$instance_id])) {
      return;
    }
    $this->pluginInstances[$instance_id] = $this->manager
      ->createInstance($instance_id, array());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PluginBag::$instanceIDs protected property Stores the IDs of all potential plugin instances.
PluginBag::$pluginInstances protected property Stores all instantiated plugins.
PluginBag::addInstanceID public function Adds an instance ID to the array of available instance IDs.
PluginBag::clear public function Clears all instantiated plugins. 1
PluginBag::count public function Implements \Countable::count().
PluginBag::current public function Implements \Iterator::current().
PluginBag::get public function Retrieves a plugin instance, initializing it if necessary.
PluginBag::getInstanceIDs public function Returns all instance IDs.
PluginBag::has public function Determines if a plugin instance exists.
PluginBag::key public function Implements \Iterator::key().
PluginBag::next public function Implements \Iterator::next().
PluginBag::remove public function Removes an initialized plugin. 1
PluginBag::rewind public function Implements \Iterator::rewind().
PluginBag::set public function Stores an initialized plugin.
PluginBag::setInstanceIDs public function Sets the instance IDs property.
PluginBag::valid public function Implements \Iterator::valid().
TestPluginBag::$manager protected property Stores the plugin manager used by this bag.
TestPluginBag::initializePlugin protected function Implements \Drupal\Component\Plugin\PluginBag::initializePlugin(). Overrides PluginBag::initializePlugin
TestPluginBag::__construct public function Constructs a TestPluginBag object.