trait VariantCollectionTrait in Chaos Tool Suite (ctools) 8.3
Provides methods for VariantCollectionInterface.
Hierarchy
- trait \Drupal\ctools\Plugin\VariantCollectionTrait
1 file declares its use of VariantCollectionTrait
- VariantCollectionTraitTest.php in tests/
src/ Unit/ VariantCollectionTraitTest.php
File
- src/
Plugin/ VariantCollectionTrait.php, line 8
Namespace
Drupal\ctools\PluginView source
trait VariantCollectionTrait {
/**
* The plugin collection that holds the variants.
*
* @var \Drupal\ctools\Plugin\VariantPluginCollection
*/
protected $variantCollection;
/**
* @see \Drupal\ctools\Plugin\VariantCollectionInterface::addVariant()
*/
public function addVariant(array $configuration) {
$configuration['uuid'] = $this
->uuidGenerator()
->generate();
$this
->getVariants()
->addInstanceId($configuration['uuid'], $configuration);
return $configuration['uuid'];
}
/**
* @see \Drupal\ctools\Plugin\VariantCollectionInterface::getVariant()
*/
public function getVariant($variant_id) {
return $this
->getVariants()
->get($variant_id);
}
/**
* @see \Drupal\ctools\Plugin\VariantCollectionInterface::removeVariant()
*/
public function removeVariant($variant_id) {
$this
->getVariants()
->removeInstanceId($variant_id);
return $this;
}
/**
* @see \Drupal\ctools\Plugin\VariantCollectionInterface::getVariants()
*/
public function getVariants() {
if (!$this->variantCollection) {
$this->variantCollection = new VariantPluginCollection(\Drupal::service('plugin.manager.display_variant'), $this
->getVariantConfig());
$this->variantCollection
->sort();
}
return $this->variantCollection;
}
/**
* Returns the configuration for stored variants.
*
* @return array
* An array of variant configuration, keyed by the unique variant ID.
*/
protected abstract function getVariantConfig();
/**
* Returns the UUID generator.
*
* @return \Drupal\Component\Uuid\UuidInterface
*/
protected abstract function uuidGenerator();
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
VariantCollectionTrait:: |
protected | property | The plugin collection that holds the variants. | |
VariantCollectionTrait:: |
public | function | ||
VariantCollectionTrait:: |
public | function | ||
VariantCollectionTrait:: |
abstract protected | function | Returns the configuration for stored variants. | 1 |
VariantCollectionTrait:: |
public | function | ||
VariantCollectionTrait:: |
public | function | ||
VariantCollectionTrait:: |
abstract protected | function | Returns the UUID generator. | 1 |