class BlockDisplayVariant in Chaos Tool Suite (ctools) 8.3

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Display\VariantBase implements VariantInterface uses RefinableCacheableDependencyTrait, PluginDependencyTrait
      • class \Drupal\ctools\Plugin\DisplayVariant\BlockDisplayVariant implements ContextAwareVariantInterface, ContainerFactoryPluginInterface, BlockVariantInterface uses AjaxFormTrait, BlockVariantTrait
        • class \Drupal\ctools_block_display_test\Plugin\DisplayVariant\BlockDisplayVariant

1 file declares its use of BlockDisplayVariant

BlockDisplayVariantTest.php in tests/src/Kernel/BlockDisplayVariantTest.php

File

tests/modules/ctools_block_display_test/src/Plugin/DisplayVariant/BlockDisplayVariant.php, line 7

Namespace

Drupal\ctools_block_display_test\Plugin\DisplayVariant

class BlockDisplayVariant extends BaseBlockDisplayVariant {

  /**
   * {@inheritdoc}
   */
  public function getRegionNames() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AjaxFormTrait::getAjaxAttributes	public static	function	Gets attributes for use with an AJAX modal.
AjaxFormTrait::getAjaxButtonAttributes	public static	function	Gets attributes for use with an add button AJAX modal.
BlockDisplayVariant::$account	protected	property	The current user.
BlockDisplayVariant::$contextHandler	protected	property	The context handler.
BlockDisplayVariant::$contexts	protected	property	An array of collected contexts.
BlockDisplayVariant::$token	protected	property	The token service.
BlockDisplayVariant::$uuidGenerator	protected	property	The UUID generator.
BlockDisplayVariant::build	public	function	Builds and returns the renderable array for the display variant. Overrides VariantInterface::build
BlockDisplayVariant::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides VariantBase::calculateDependencies
BlockDisplayVariant::contextHandler	protected	function
BlockDisplayVariant::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BlockDisplayVariant::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides VariantBase::defaultConfiguration
BlockDisplayVariant::getBlockConfig	protected	function	Returns the configuration for stored blocks. Overrides BlockVariantTrait::getBlockConfig
BlockDisplayVariant::getConfiguration	public	function	Gets this plugin's configuration. Overrides VariantBase::getConfiguration
BlockDisplayVariant::getContexts	public	function	Gets the contexts. Overrides ContextAwareVariantInterface::getContexts
BlockDisplayVariant::getRegionNames	public	function	Overrides BlockVariantTrait::getRegionNames
BlockDisplayVariant::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides VariantBase::setConfiguration
BlockDisplayVariant::setContexts	public	function	Sets the contexts. Overrides ContextAwareVariantInterface::setContexts
BlockDisplayVariant::uuidGenerator	protected	function	Returns the UUID generator. Overrides BlockVariantTrait::uuidGenerator
BlockDisplayVariant::__construct	public	function	Constructs a new BlockDisplayVariant. Overrides VariantBase::__construct
BlockDisplayVariant::__sleep	public	function	Overrides DependencySerializationTrait::__sleep
BlockVariantTrait::$blockManager	protected	property	The block manager.
BlockVariantTrait::$blockPluginCollection	protected	property	The plugin collection that holds the block plugins.
BlockVariantTrait::$eventDispatcher	protected	property	The event dispatcher.
BlockVariantTrait::addBlock	public	function
BlockVariantTrait::eventDispatcher	protected	function	Gets the event dispatcher.
BlockVariantTrait::getBlock	public	function
BlockVariantTrait::getBlockCollection	protected	function	Returns the block plugins used for this display variant.
BlockVariantTrait::getBlockManager	protected	function	Gets the block plugin manager.
BlockVariantTrait::getRegionAssignment	public	function
BlockVariantTrait::getRegionAssignments	public	function
BlockVariantTrait::getRegionName	public	function
BlockVariantTrait::removeBlock	public	function
BlockVariantTrait::updateBlock	public	function
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::getCacheContexts	public	function		3
CacheableDependencyTrait::getCacheMaxAge	public	function		3
CacheableDependencyTrait::getCacheTags	public	function		3
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
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::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
VariantBase::access	public	function	Determines if this display variant is accessible. Overrides VariantInterface::access
VariantBase::adminLabel	public	function	Returns the admin-facing display variant label. Overrides VariantInterface::adminLabel
VariantBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
VariantBase::getWeight	public	function	Returns the weight of the display variant. Overrides VariantInterface::getWeight
VariantBase::id	public	function	Returns the unique ID for the display variant. Overrides VariantInterface::id
VariantBase::label	public	function	Returns the user-facing display variant label. Overrides VariantInterface::label
VariantBase::setWeight	public	function	Sets the weight of the display variant. Overrides VariantInterface::setWeight
VariantBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
VariantBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm