You are here

Home » API reference » Layout Builder Base 8 » BaseMultipleColumnsLayout.php

class BaseMultipleColumnsLayout in Layout Builder Base 8

Configurable layout plugin class.

@internal Plugin classes are internal.

Hierarchy

Expanded class hierarchy of BaseMultipleColumnsLayout

File

modules/layout_builder_base_library/src/Plugin/Layout/BaseMultipleColumnsLayout.php, line 11

Namespace

Drupal\layout_builder_base_library\Plugin\Layout
View source 
class BaseMultipleColumnsLayout extends BaseOneColumnLayout {

  /**
   * {@inheritdoc}
   */
  protected function isMultipleColumnsLayout() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  protected function getColumnGapOptions() {
    $options = [
      'layout--column-gap--none' => $this
        ->t('None'),
      'layout--column-gap--small' => $this
        ->t('Small'),
      'layout--column-gap--default' => $this
        ->t('Default'),
      'layout--column-gap--big' => $this
        ->t('Big'),
    ];
    $this->moduleHandler
      ->alter('layout_builder_base_column_gap', $options);
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  protected function getRowGapOptions() {
    $options = [
      'layout--row-gap--none' => $this
        ->t('None'),
      'layout--row-gap--small' => $this
        ->t('Small'),
      'layout--row-gap--default' => $this
        ->t('Default'),
      'layout--row-gap--big' => $this
        ->t('Big'),
    ];
    $this->moduleHandler
      ->alter('layout_builder_base_row_gap', $options);
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  protected function getColumnBreakpointOptions() {
    $options = [
      'layout--column-breakpoint--none' => $this
        ->t('None'),
      'layout--column-breakpoint--small' => $this
        ->t('Small'),
      'layout--column-breakpoint--medium' => $this
        ->t('Medium'),
      'layout--column-breakpoint--standard' => $this
        ->t('Standard'),
      'layout--column-breakpoint--large' => $this
        ->t('Large'),
    ];
    $this->moduleHandler
      ->alter('layout_builder_base_column_breakpoint', $options);
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  protected function getAlignItemsOptions() {
    $options = [
      'layout--align-items--normal' => $this
        ->t('Normal'),
      'layout--align-items--stretch' => $this
        ->t('Stretch'),
      'layout--align-items--center' => $this
        ->t('Center'),
      'layout--align-items--start' => $this
        ->t('Start'),
      'layout--align-items--end' => $this
        ->t('End'),
    ];
    $this->moduleHandler
      ->alter('layout_builder_base_align_items', $options);
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BaseLayoutBase::$layoutBuilderBaseSettings protected property The layout builder base settings.
BaseLayoutBase::buildConfigurationForm public function Form constructor. Overrides MultiWidthLayoutBase::buildConfigurationForm
BaseLayoutBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides MultiWidthLayoutBase::defaultConfiguration
BaseLayoutBase::getBackgroundImageStyleOptions protected function Gets the background image style options for the configuration form.
BaseLayoutBase::getDefaultAlignItems protected function Get the default align items option.
BaseLayoutBase::getDefaultAlignment protected function Get the default alignment option.
BaseLayoutBase::getDefaultBackground protected function Get the default background option.
BaseLayoutBase::getDefaultBackgroundAttachment protected function Get the default background attachment option.
BaseLayoutBase::getDefaultBackgroundImageStyle protected function Get the default image style background option.
BaseLayoutBase::getDefaultBackgroundOverlay protected function Get the default background overlay option.
BaseLayoutBase::getDefaultBackgroundPosition protected function Get the default background position option.
BaseLayoutBase::getDefaultBackgroundSize protected function Get the default background size option.
BaseLayoutBase::getDefaultBottomMargin protected function Get the default bottom margin option.
BaseLayoutBase::getDefaultBottomPadding protected function Get the default bottom padding option.
BaseLayoutBase::getDefaultColor protected function Get the default color option.
BaseLayoutBase::getDefaultColumnBreakpoint protected function Get the default column breakpoint option.
BaseLayoutBase::getDefaultColumnGap protected function Get the default column gap option.
BaseLayoutBase::getDefaultColumnWidth protected function Get the default column width option. 2
BaseLayoutBase::getDefaultConfigOption protected function Default behavior to get the default config option.
BaseLayoutBase::getDefaultContainer protected function Get the default container option.
BaseLayoutBase::getDefaultContentContainer protected function Get the default content container option.
BaseLayoutBase::getDefaultCustomizableColumns protected function Get the default customizable columns option.
BaseLayoutBase::getDefaultEqualLeftRightMargin protected function Get the default equal left right margin option.
BaseLayoutBase::getDefaultEqualLeftRightPadding protected function Get the default equal left right padding option.
BaseLayoutBase::getDefaultEqualTopBottomMargin protected function Get the default equal top bottom margin option.
BaseLayoutBase::getDefaultEqualTopBottomPadding protected function Get the default equal top bottom padding option.
BaseLayoutBase::getDefaultHeight protected function Get the default height option.
BaseLayoutBase::getDefaultImageBackground protected function Get the default background option.
BaseLayoutBase::getDefaultLeftMargin protected function Get the default left margin option.
BaseLayoutBase::getDefaultLeftPadding protected function Get the default left padding option.
BaseLayoutBase::getDefaultModifiers protected function Get the default modifiers option.
BaseLayoutBase::getDefaultRightMargin protected function Get the default right margin option.
BaseLayoutBase::getDefaultRightPadding protected function Get the default right padding option.
BaseLayoutBase::getDefaultRowGap protected function Get the default row gap option.
BaseLayoutBase::getDefaultTopMargin protected function Get the default top margin option.
BaseLayoutBase::getDefaultTopPadding protected function Get the default top padding option.
BaseLayoutBase::submitConfigurationForm public function Form submission handler. Overrides MultiWidthLayoutBase::submitConfigurationForm
BaseMultipleColumnsLayout::getAlignItemsOptions protected function Gets the align items options for the configuration form. Overrides DefaultLayoutBase::getAlignItemsOptions
BaseMultipleColumnsLayout::getColumnBreakpointOptions protected function Gets the column breakpoint options for the configuration form. Overrides DefaultLayoutBase::getColumnBreakpointOptions
BaseMultipleColumnsLayout::getColumnGapOptions protected function Gets the column gap options for the configuration form. Overrides DefaultLayoutBase::getColumnGapOptions
BaseMultipleColumnsLayout::getRowGapOptions protected function Gets the row gap options for the configuration form. Overrides DefaultLayoutBase::getRowGapOptions
BaseMultipleColumnsLayout::isMultipleColumnsLayout protected function Function to enable the multiple columns features. Overrides BaseLayoutBase::isMultipleColumnsLayout
BaseOneColumnLayout::$moduleHandler protected property The module handler service.
BaseOneColumnLayout::build public function Build a render array for layout with regions. Overrides BaseLayoutBase::build 4
BaseOneColumnLayout::create public static function Creates an instance of the plugin. Overrides BaseLayoutBase::create
BaseOneColumnLayout::enableImageBackground protected function Function to enable the background image feature. Overrides BaseLayoutBase::enableImageBackground
BaseOneColumnLayout::getAlignmentOptions protected function Gets the alignment options for the configuration form. Overrides DefaultLayoutBase::getAlignmentOptions
BaseOneColumnLayout::getBackgroundAttachmentOptions protected function Gets the background attachment options for the configuration form. Overrides DefaultLayoutBase::getBackgroundAttachmentOptions
BaseOneColumnLayout::getBackgroundOptions protected function Gets the background options for the configuration form. Overrides DefaultLayoutBase::getBackgroundOptions
BaseOneColumnLayout::getBackgroundOverlayOptions protected function Gets the background overlay options for the configuration form. Overrides DefaultLayoutBase::getBackgroundOverlayOptions
BaseOneColumnLayout::getBackgroundPositionOptions protected function Gets the background position options for the configuration form. Overrides DefaultLayoutBase::getBackgroundPositionOptions
BaseOneColumnLayout::getBackgroundSizeOptions protected function Gets the background size options for the configuration form. Overrides DefaultLayoutBase::getBackgroundSizeOptions
BaseOneColumnLayout::getBottomMarginOptions protected function Gets the bottom margin options for the configuration form. Overrides DefaultLayoutBase::getBottomMarginOptions
BaseOneColumnLayout::getBottomPaddingOptions protected function Gets the bottom padding options for the configuration form. Overrides DefaultLayoutBase::getBottomPaddingOptions
BaseOneColumnLayout::getColorsOptions protected function Gets the colors options for the configuration form. Overrides DefaultLayoutBase::getColorsOptions
BaseOneColumnLayout::getContainerOptions protected function Gets the container options for the configuration form. Overrides DefaultLayoutBase::getContainerOptions
BaseOneColumnLayout::getContentContainerOptions protected function Gets the content container options for the configuration form. Overrides DefaultLayoutBase::getContentContainerOptions
BaseOneColumnLayout::getEqualLeftRightMarginsOptions protected function Gets the left and right equal margin options for the configuration form. Overrides DefaultLayoutBase::getEqualLeftRightMarginsOptions
BaseOneColumnLayout::getEqualLeftRightPaddingsOptions protected function Gets the left and right equal padding options for the configuration form. Overrides DefaultLayoutBase::getEqualLeftRightPaddingsOptions
BaseOneColumnLayout::getEqualTopBottomMarginsOptions protected function Gets the top and bottom equal margin options for the configuration form. Overrides DefaultLayoutBase::getEqualTopBottomMarginsOptions
BaseOneColumnLayout::getEqualTopBottomPaddingsOptions protected function Gets the top and bottom equal padding options for the configuration form. Overrides DefaultLayoutBase::getEqualTopBottomPaddingsOptions
BaseOneColumnLayout::getHeightOptions protected function Gets the height options for the configuration form. Overrides DefaultLayoutBase::getHeightOptions
BaseOneColumnLayout::getLeftMarginOptions protected function Gets the left margin options for the configuration form. Overrides DefaultLayoutBase::getLeftMarginOptions
BaseOneColumnLayout::getLeftPaddingOptions protected function Gets the left padding options for the configuration form. Overrides DefaultLayoutBase::getLeftPaddingOptions
BaseOneColumnLayout::getModifiersOptions protected function Gets the modifiers options for the configuration form. Overrides DefaultLayoutBase::getModifiersOptions
BaseOneColumnLayout::getRightMarginOptions protected function Gets the right margin options for the configuration form. Overrides DefaultLayoutBase::getRightMarginOptions
BaseOneColumnLayout::getRightPaddingOptions protected function Gets the right padding options for the configuration form. Overrides DefaultLayoutBase::getRightPaddingOptions
BaseOneColumnLayout::getTopMarginOptions protected function Gets the top margin options for the configuration form. Overrides DefaultLayoutBase::getTopMarginOptions
BaseOneColumnLayout::getTopPaddingOptions protected function Gets the top padding options for the configuration form. Overrides DefaultLayoutBase::getTopPaddingOptions
BaseOneColumnLayout::__construct public function Constructs a BaseOneColumnLayout object. Overrides BaseLayoutBase::__construct
DefaultLayoutBase::getColumnWidthOptions protected function Gets the column width options for the configuration form. Overrides BaseLayoutBase::getColumnWidthOptions 2
DefaultLayoutBase::getCustomizableColumnsOptions protected function Gets the customizable columns options for the configuration form. Overrides BaseLayoutBase::getCustomizableColumnsOptions 1
DefaultLayoutBase::getWidthOptions protected function Gets the width options for the configuration form. Overrides MultiWidthLayoutBase::getWidthOptions
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 1
DependencySerializationTrait::__wakeup public function 2
LayoutDefault::$pluginDefinition protected property The layout definition. Overrides PluginBase::$pluginDefinition
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 PluginBase::getPluginDefinition
LayoutDefault::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
LayoutDefault::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
MultiWidthLayoutBase::getDefaultWidth protected function Provides a default value for the width options. 2
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. 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.