class VariantPluginCollection in Chaos Tool Suite (ctools) 8.3

Provides a collection of variants plugins.

Hierarchy

• class \Drupal\Component\Plugin\LazyPluginCollection implements \Drupal\Component\Plugin\IteratorAggregate, \Drupal\Component\Plugin\Countable
  • class \Drupal\Core\Plugin\DefaultLazyPluginCollection uses DependencySerializationTrait
    • class \Drupal\ctools\Plugin\VariantPluginCollection

1 file declares its use of VariantPluginCollection

VariantCollectionTraitTest.php in tests/src/Unit/VariantCollectionTraitTest.php

File

src/Plugin/VariantPluginCollection.php, line 10

Namespace

Drupal\ctools\Plugin

class VariantPluginCollection extends DefaultLazyPluginCollection {

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Display\VariantInterface
   */
  public function &get($instance_id) {
    return parent::get($instance_id);
  }

  /**
   * {@inheritdoc}
   */
  public function sort() {

    // @todo Determine the reason this needs error suppression.
    @uasort($this->instanceIds, [
      $this,
      'sortHelper',
    ]);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function sortHelper($aID, $bID) {
    $a_weight = $this
      ->get($aID)
      ->getWeight();
    $b_weight = $this
      ->get($bID)
      ->getWeight();
    if ($a_weight == $b_weight) {
      return strcmp($aID, $bID);
    }
    return $a_weight < $b_weight ? -1 : 1;
  }

}

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::initializePlugin	protected	function	Initializes and stores a plugin. Overrides LazyPluginCollection::initializePlugin	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::__construct	public	function	Constructs a new DefaultLazyPluginCollection object.	1
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
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.
LazyPluginCollection::count	public	function
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.
LazyPluginCollection::set	public	function	Stores an initialized plugin.
VariantPluginCollection::get	public	function	Overrides LazyPluginCollection::get
VariantPluginCollection::sort	public	function	Sorts all plugin instances in this collection. Overrides DefaultLazyPluginCollection::sort
VariantPluginCollection::sortHelper	public	function	Provides uasort() callback to sort plugins. Overrides DefaultLazyPluginCollection::sortHelper