class VariantPluginCollection

Same name in other branches
  1. 4.0.x src/Plugin/VariantPluginCollection.php \Drupal\ctools\Plugin\VariantPluginCollection

Provides a collection of variants plugins.

Hierarchy

Expanded class hierarchy of 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
View source 
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

Title Modifiers Object type Summary Overriden Title 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
DependencySerializationTrait::$_serviceIds protected property
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. 1
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. 1
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