class TipsBag

A collection of tips.

Hierarchy

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

Expanded class hierarchy of TipsBag

1 file declares its use of TipsBag
Tour.php in drupal/core/modules/tour/lib/Drupal/tour/Plugin/Core/Entity/Tour.php
Contains \Drupal\tour\Plugin\Core\Entity\Tour.

File

drupal/core/modules/tour/lib/Drupal/tour/TipsBag.php, line 18
Contains \Drupal\tour\TipsBag.

Namespace

Drupal\tour
View source
class TipsBag extends PluginBag {

  /**
   * The initial configuration for each tip in the bag.
   *
   * @var array
   *   An associative array containing the initial configuration for each tip
   *   in the bag, keyed by plugin instance ID.
   */
  protected $configurations = array();

  /**
   * The manager used to instantiate the plugins.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $manager;

  /**
   * Constructs a TipsBag object.
   *
   * @param \Drupal\Component\Plugin\PluginManagerInterface $manager
   *   The manager to be used for instantiating plugins.
   * @param array $configurations
   *   (optional) An associative array containing the initial configuration for
   *   each tour in the bag, keyed by plugin instance ID.
   */
  public function __construct(PluginManagerInterface $manager, array $configurations = array()) {
    $this->manager = $manager;
    $this->configurations = $configurations;
    if (!empty($configurations)) {
      $this->instanceIDs = array_combine(array_keys($configurations), array_keys($configurations));
    }
  }

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

    // If the tip was initialized before, just return.
    if (isset($this->pluginInstances[$instance_id])) {
      return;
    }
    $type = $this->configurations[$instance_id]['plugin'];
    $definition = $this->manager
      ->getDefinition($type);
    if (isset($definition)) {
      $this
        ->addInstanceID($instance_id);
      $configuration = $definition;

      // Merge the actual configuration into the default configuration.
      if (isset($this->configurations[$instance_id])) {
        $configuration = NestedArray::mergeDeep($configuration, $this->configurations[$instance_id]);
      }
      $this->pluginInstances[$instance_id] = $this->manager
        ->createInstance($type, $configuration);
    }
    else {
      throw new PluginException(format_string("Unknown tip plugin ID '@tip'.", array(
        '@tip' => $instance_id,
      )));
    }
  }

}

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().
TipsBag::$configurations protected property The initial configuration for each tip in the bag.
TipsBag::$manager protected property The manager used to instantiate the plugins.
TipsBag::initializePlugin protected function Overrides \Drupal\Component\Plugin\PluginBag::initializePlugin(). Overrides PluginBag::initializePlugin
TipsBag::__construct public function Constructs a TipsBag object.