class TestLayoutMainFooter

Same name in other branches
  1. 8.9.x core/modules/field_layout/tests/modules/field_layout_test/src/Plugin/Layout/TestLayoutMainFooter.php \Drupal\field_layout_test\Plugin\Layout\TestLayoutMainFooter
  2. 10 core/modules/field_layout/tests/modules/field_layout_test/src/Plugin/Layout/TestLayoutMainFooter.php \Drupal\field_layout_test\Plugin\Layout\TestLayoutMainFooter
  3. 11.x core/modules/field_layout/tests/modules/field_layout_test/src/Plugin/Layout/TestLayoutMainFooter.php \Drupal\field_layout_test\Plugin\Layout\TestLayoutMainFooter

Provides an annotated layout plugin for field_layout tests.

Plugin annotation


@Layout(
  id = "test_layout_main_and_footer",
  label = @Translation("Test plugin: Main and Footer"),
  category = @Translation("Layout test"),
  description = @Translation("Test layout"),
  regions = {
    "main" = {
      "label" = @Translation("Main Region")
    },
    "footer" = {
      "label" = @Translation("Footer Region")
    }
  },
  config_dependencies = {
    "module" = {
      "dependency_from_annotation",
    },
  },
)

Hierarchy

Expanded class hierarchy of TestLayoutMainFooter

File

core/modules/field_layout/tests/modules/field_layout_test/src/Plugin/Layout/TestLayoutMainFooter.php, line 30

Namespace

Drupal\field_layout_test\Plugin\Layout
View source
class TestLayoutMainFooter extends LayoutDefault {
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'setting_1' => 'Default',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        $dependencies = parent::calculateDependencies();
        $dependencies['module'][] = 'dependency_from_calculateDependencies';
        return $dependencies;
    }

}

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::build public function Build a render array for layout with regions. Overrides LayoutInterface::build 4
LayoutDefault::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 3
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
TestLayoutMainFooter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides LayoutDefault::calculateDependencies
TestLayoutMainFooter::defaultConfiguration public function Gets default configuration for this plugin. Overrides LayoutDefault::defaultConfiguration

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