class WebformHandlerPluginCollection in Webform 6.x

A collection of webform handlers.

Hierarchy

• class \Drupal\Component\Plugin\LazyPluginCollection implements \Drupal\Component\Plugin\IteratorAggregate, \Drupal\Component\Plugin\Countable
  • class \Drupal\Core\Plugin\DefaultLazyPluginCollection uses DependencySerializationTrait
    • class \Drupal\webform\Plugin\WebformHandlerPluginCollection

1 file declares its use of WebformHandlerPluginCollection

Webform.php in src/Entity/Webform.php

File

src/Plugin/WebformHandlerPluginCollection.php, line 11

Namespace

Drupal\webform\Plugin

class WebformHandlerPluginCollection extends DefaultLazyPluginCollection {

  /**
   * {@inheritdoc}
   */
  public function sortHelper($a_id, $b_id) {

    /** @var \Drupal\webform\Plugin\WebformHandlerInterface $a */
    $a = $this
      ->get($a_id);

    /** @var \Drupal\webform\Plugin\WebformHandlerInterface $b */
    $b = $this
      ->get($b_id);
    $a_weight = $a
      ->getWeight();
    $b_weight = $b
      ->getWeight();
    if ($a_weight === $b_weight) {
      return strnatcasecmp($a
        ->getHandlerId(), $b
        ->getHandlerId());
    }
    return $a_weight < $b_weight ? -1 : 1;
  }

  /**
   * {@inheritdoc}
   */
  protected function initializePlugin($instance_id) {
    parent::initializePlugin($instance_id);

    // If the initialized handler is broken preserve the original
    // handler's plugin ID.
    // @see \Drupal\webform\Plugin\WebformHandler\BrokenWebformHandler::setPluginId
    $plugin = $this
      ->get($instance_id);
    if ($plugin instanceof BrokenWebformHandler) {
      $original_id = $this->configurations[$instance_id]['id'];
      $plugin
        ->setPluginId($original_id);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultLazyPluginCollection::$configurations	protected	property	The initial configuration for each plugin in the collection.
DefaultLazyPluginCollection::$manager	protected	property	The manager used to instantiate the plugins.
DefaultLazyPluginCollection::$originalOrder	protected	property	The original order of the instances.
DefaultLazyPluginCollection::$pluginKey	protected	property	The key within the plugin configuration that contains the plugin ID.	3
DefaultLazyPluginCollection::addInstanceId	public	function	Adds an instance ID to the available instance IDs. Overrides LazyPluginCollection::addInstanceId
DefaultLazyPluginCollection::getConfiguration	public	function	Gets the current configuration of all plugins in this collection. Overrides LazyPluginCollection::getConfiguration	2
DefaultLazyPluginCollection::removeInstanceId	public	function	Removes an instance ID. Overrides LazyPluginCollection::removeInstanceId
DefaultLazyPluginCollection::setConfiguration	public	function	Sets the configuration for all plugins in this collection. Overrides LazyPluginCollection::setConfiguration
DefaultLazyPluginCollection::setInstanceConfiguration	public	function	Updates the configuration for a plugin instance.
DefaultLazyPluginCollection::sort	public	function	Sorts all plugin instances in this collection.	1
DefaultLazyPluginCollection::__construct	public	function	Constructs a new DefaultLazyPluginCollection object.	1
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
LazyPluginCollection::$instanceIds	protected	property	Stores the IDs of all potential plugin instances.
LazyPluginCollection::$pluginInstances	protected	property	Stores all instantiated plugins.
LazyPluginCollection::clear	public	function	Clears all instantiated plugins.	1
LazyPluginCollection::count	public	function
LazyPluginCollection::get	public	function	Gets a plugin instance, initializing it if necessary.	8
LazyPluginCollection::getInstanceIds	public	function	Gets all instance IDs.
LazyPluginCollection::getIterator	public	function
LazyPluginCollection::has	public	function	Determines if a plugin instance exists.
LazyPluginCollection::remove	public	function	Removes an initialized plugin.	1
LazyPluginCollection::set	public	function	Stores an initialized plugin.
WebformHandlerPluginCollection::initializePlugin	protected	function	Initializes and stores a plugin. Overrides DefaultLazyPluginCollection::initializePlugin
WebformHandlerPluginCollection::sortHelper	public	function	Provides uasort() callback to sort plugins. Overrides DefaultLazyPluginCollection::sortHelper