class TestContextAwareLayout

Same name and namespace in other branches
  1. 9 core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Layout/TestContextAwareLayout.php \Drupal\layout_builder_test\Plugin\Layout\TestContextAwareLayout
  2. 11.x core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Layout/TestContextAwareLayout.php \Drupal\layout_builder_test\Plugin\Layout\TestContextAwareLayout

The TestContextAwareLayout Class.

Attributes

#[Layout(id: 'layout_builder_test_context_aware', label: new TranslatableMarkup('Layout Builder Test: Context Aware'), regions: [ "main" => [ "label" => new TranslatableMarkup("Main Region"), ], ], context_definitions: [ "user" => new EntityContextDefinition("entity:user"), ])]

Hierarchy

  • class \Drupal\layout_builder_test\Plugin\Layout\TestContextAwareLayout implements \Drupal\Core\Layout\LayoutDefault

Expanded class hierarchy of TestContextAwareLayout

File

core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Layout/TestContextAwareLayout.php, line 13

Namespace

Drupal\layout_builder_test\Plugin\Layout
View on git.drupalcode.org
View source 
class TestContextAwareLayout extends LayoutDefault {
  
  /**
   * {@inheritdoc}
   */
  public function build(array $regions) {
    $build = parent::build($regions);
    $build['main']['#attributes']['class'][] = 'user--' . $this->getContextValue('user')
      ->getAccountName();
    return $build;
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::getCacheContexts public function 10
ContextAwarePluginTrait::getCacheMaxAge public function 6
ContextAwarePluginTrait::getCacheTags public function 3
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function 1
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
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 2
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange] 2
LayoutDefault::$inPreview protected property Whether the plugin is being rendered in preview mode.
LayoutDefault::$pluginDefinition protected property The layout definition. Overrides PluginBase::$pluginDefinition
LayoutDefault::buildConfigurationForm public function Overrides PluginFormInterface::buildConfigurationForm 3
LayoutDefault::calculateDependencies public function Overrides DependentPluginInterface::calculateDependencies 2
LayoutDefault::defaultConfiguration public function Overrides ConfigurableInterface::defaultConfiguration 4
LayoutDefault::getConfiguration public function Overrides ConfigurableInterface::getConfiguration
LayoutDefault::getPluginDefinition public function Overrides ContextAwarePluginTrait::getPluginDefinition
LayoutDefault::setConfiguration public function Overrides ConfigurableInterface::setConfiguration
LayoutDefault::setInPreview public function Overrides PreviewAwarePluginInterface::setInPreview
LayoutDefault::submitConfigurationForm public function Overrides PluginFormInterface::submitConfigurationForm 3
LayoutDefault::validateConfigurationForm public function Overrides PluginFormInterface::validateConfigurationForm 1
LayoutDefault::__construct public function Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 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::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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
TestContextAwareLayout::build public function Overrides LayoutDefault::build

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.