class ThreeColumnLayout

Same name in other branches
  1. 9 core/modules/layout_builder/src/Plugin/Layout/ThreeColumnLayout.php \Drupal\layout_builder\Plugin\Layout\ThreeColumnLayout
  2. 8.9.x core/modules/layout_builder/src/Plugin/Layout/ThreeColumnLayout.php \Drupal\layout_builder\Plugin\Layout\ThreeColumnLayout
  3. 10 core/modules/layout_builder/src/Plugin/Layout/ThreeColumnLayout.php \Drupal\layout_builder\Plugin\Layout\ThreeColumnLayout

Configurable three column layout plugin class.

@internal Plugin classes are internal.

Hierarchy

Expanded class hierarchy of ThreeColumnLayout

1 string reference to 'ThreeColumnLayout'
layout_builder.layouts.yml in core/modules/layout_builder/layout_builder.layouts.yml
core/modules/layout_builder/layout_builder.layouts.yml

File

core/modules/layout_builder/src/Plugin/Layout/ThreeColumnLayout.php, line 11

Namespace

Drupal\layout_builder\Plugin\Layout
View source
class ThreeColumnLayout extends MultiWidthLayoutBase {
    
    /**
     * {@inheritdoc}
     */
    protected function getWidthOptions() {
        return [
            '25-50-25' => '25%/50%/25%',
            '33-34-33' => '33%/34%/33%',
            '25-25-50' => '25%/25%/50%',
            '50-25-25' => '50%/25%/25%',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getDefaultWidth() {
        return '33-34-33';
    }

}

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::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
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::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 2
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::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
LayoutDefault::__construct public function
MultiWidthLayoutBase::build public function Build a render array for layout with regions. Overrides LayoutDefault::build
MultiWidthLayoutBase::buildConfigurationForm public function Form constructor. Overrides LayoutDefault::buildConfigurationForm
MultiWidthLayoutBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides LayoutDefault::defaultConfiguration
MultiWidthLayoutBase::submitConfigurationForm public function Form submission handler. Overrides LayoutDefault::submitConfigurationForm
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
ThreeColumnLayout::getDefaultWidth protected function Provides a default value for the width options. Overrides MultiWidthLayoutBase::getDefaultWidth
ThreeColumnLayout::getWidthOptions protected function Gets the width options for the configuration form. Overrides MultiWidthLayoutBase::getWidthOptions

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