class TestContextAwareLayout

Same name in other branches
  1. 10 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

Plugin annotation


@Layout(
  id = "layout_builder_test_context_aware",
  label = @Translation("Layout Builder Test: Context Aware"),
  regions = {
    "main" = {
      "label" = @Translation("Main Region")
    }
  },
  context_definitions = {
    "user" = @ContextDefinition("entity:user")
  }
)

Hierarchy

Expanded class hierarchy of TestContextAwareLayout

File

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

Namespace

Drupal\layout_builder_test\Plugin\Layout
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 Sort descending 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::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
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
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
LayoutDefault::$inPreview protected property Whether the plugin is being rendered in preview mode.
LayoutDefault::$pluginDefinition protected property The layout definition.
LayoutDefault::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 3
LayoutDefault::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 2
LayoutDefault::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 4
LayoutDefault::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
LayoutDefault::getPluginDefinition public function Overrides ContextAwarePluginTrait::getPluginDefinition
LayoutDefault::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
LayoutDefault::setInPreview public function Set preview mode for the plugin. Overrides PreviewAwarePluginInterface::setInPreview
LayoutDefault::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 3
LayoutDefault::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
LayoutDefault::__construct public function
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
TestContextAwareLayout::build public function Build a render array for layout with regions. Overrides LayoutDefault::build

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