class DefaultLayoutBase in Layout Builder Base 8

Configurable layout plugin class.

@internal Plugin classes are internal.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Layout\LayoutDefault implements LayoutInterface, PluginFormInterface
      • class \Drupal\layout_builder\Plugin\Layout\MultiWidthLayoutBase implements PluginFormInterface
        • class \Drupal\layout_builder_base\Plugin\Layout\BaseLayoutBase
          • class \Drupal\layout_builder_base\Plugin\Layout\DefaultLayoutBase

1 file declares its use of DefaultLayoutBase

BaseOneColumnLayout.php in modules/layout_builder_base_library/src/Plugin/Layout/BaseOneColumnLayout.php

File

src/Plugin/Layout/DefaultLayoutBase.php, line 11

Namespace

Drupal\layout_builder_base\Plugin\Layout

class DefaultLayoutBase extends BaseLayoutBase {

  /**
   * {@inheritdoc}
   */
  protected function getWidthOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getBackgroundOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getBackgroundPositionOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getBackgroundAttachmentOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getBackgroundSizeOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getBackgroundOverlayOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getEqualTopBottomMarginsOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getEqualLeftRightMarginsOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getTopMarginOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getRightMarginOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getBottomMarginOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getLeftMarginOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getEqualTopBottomPaddingsOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getEqualLeftRightPaddingsOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getTopPaddingOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getRightPaddingOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getBottomPaddingOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getLeftPaddingOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getContainerOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getContentContainerOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getHeightOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getColorsOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getAlignmentOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getColumnGapOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getRowGapOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getColumnBreakpointOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getColumnWidthOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getAlignItemsOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getModifiersOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getCustomizableColumnsOptions() {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BaseLayoutBase::$layoutBuilderBaseSettings	protected	property	The layout builder base settings.
BaseLayoutBase::build	public	function	Build a render array for layout with regions. Overrides MultiWidthLayoutBase::build	1
BaseLayoutBase::buildConfigurationForm	public	function	Form constructor. Overrides MultiWidthLayoutBase::buildConfigurationForm
BaseLayoutBase::create	public static	function		1
BaseLayoutBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides MultiWidthLayoutBase::defaultConfiguration
BaseLayoutBase::enableImageBackground	protected	function	Function to enable the background image feature.	1
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::isMultipleColumnsLayout	protected	function	Function to enable the multiple columns features.	1
BaseLayoutBase::submitConfigurationForm	public	function	Form submission handler. Overrides MultiWidthLayoutBase::submitConfigurationForm
BaseLayoutBase::__construct	public	function	Constructs a BaseOneColumnLayout object. Overrides LayoutDefault::__construct	1
DefaultLayoutBase::getAlignItemsOptions	protected	function	Gets the align items options for the configuration form. Overrides BaseLayoutBase::getAlignItemsOptions	1
DefaultLayoutBase::getAlignmentOptions	protected	function	Gets the alignment options for the configuration form. Overrides BaseLayoutBase::getAlignmentOptions	1
DefaultLayoutBase::getBackgroundAttachmentOptions	protected	function	Gets the background attachment options for the configuration form. Overrides BaseLayoutBase::getBackgroundAttachmentOptions	1
DefaultLayoutBase::getBackgroundOptions	protected	function	Gets the background options for the configuration form. Overrides BaseLayoutBase::getBackgroundOptions	1
DefaultLayoutBase::getBackgroundOverlayOptions	protected	function	Gets the background overlay options for the configuration form. Overrides BaseLayoutBase::getBackgroundOverlayOptions	1
DefaultLayoutBase::getBackgroundPositionOptions	protected	function	Gets the background position options for the configuration form. Overrides BaseLayoutBase::getBackgroundPositionOptions	1
DefaultLayoutBase::getBackgroundSizeOptions	protected	function	Gets the background size options for the configuration form. Overrides BaseLayoutBase::getBackgroundSizeOptions	1
DefaultLayoutBase::getBottomMarginOptions	protected	function	Gets the bottom margin options for the configuration form. Overrides BaseLayoutBase::getBottomMarginOptions	1
DefaultLayoutBase::getBottomPaddingOptions	protected	function	Gets the bottom padding options for the configuration form. Overrides BaseLayoutBase::getBottomPaddingOptions	1
DefaultLayoutBase::getColorsOptions	protected	function	Gets the colors options for the configuration form. Overrides BaseLayoutBase::getColorsOptions	1
DefaultLayoutBase::getColumnBreakpointOptions	protected	function	Gets the column breakpoint options for the configuration form. Overrides BaseLayoutBase::getColumnBreakpointOptions	1
DefaultLayoutBase::getColumnGapOptions	protected	function	Gets the column gap options for the configuration form. Overrides BaseLayoutBase::getColumnGapOptions	1
DefaultLayoutBase::getColumnWidthOptions	protected	function	Gets the column width options for the configuration form. Overrides BaseLayoutBase::getColumnWidthOptions	2
DefaultLayoutBase::getContainerOptions	protected	function	Gets the container options for the configuration form. Overrides BaseLayoutBase::getContainerOptions	1
DefaultLayoutBase::getContentContainerOptions	protected	function	Gets the content container options for the configuration form. Overrides BaseLayoutBase::getContentContainerOptions	1
DefaultLayoutBase::getCustomizableColumnsOptions	protected	function	Gets the customizable columns options for the configuration form. Overrides BaseLayoutBase::getCustomizableColumnsOptions	1
DefaultLayoutBase::getEqualLeftRightMarginsOptions	protected	function	Gets the left and right equal margin options for the configuration form. Overrides BaseLayoutBase::getEqualLeftRightMarginsOptions	1
DefaultLayoutBase::getEqualLeftRightPaddingsOptions	protected	function	Gets the left and right equal padding options for the configuration form. Overrides BaseLayoutBase::getEqualLeftRightPaddingsOptions	1
DefaultLayoutBase::getEqualTopBottomMarginsOptions	protected	function	Gets the top and bottom equal margin options for the configuration form. Overrides BaseLayoutBase::getEqualTopBottomMarginsOptions	1
DefaultLayoutBase::getEqualTopBottomPaddingsOptions	protected	function	Gets the top and bottom equal padding options for the configuration form. Overrides BaseLayoutBase::getEqualTopBottomPaddingsOptions	1
DefaultLayoutBase::getHeightOptions	protected	function	Gets the height options for the configuration form. Overrides BaseLayoutBase::getHeightOptions	1
DefaultLayoutBase::getLeftMarginOptions	protected	function	Gets the left margin options for the configuration form. Overrides BaseLayoutBase::getLeftMarginOptions	1
DefaultLayoutBase::getLeftPaddingOptions	protected	function	Gets the left padding options for the configuration form. Overrides BaseLayoutBase::getLeftPaddingOptions	1
DefaultLayoutBase::getModifiersOptions	protected	function	Gets the modifiers options for the configuration form. Overrides BaseLayoutBase::getModifiersOptions	1
DefaultLayoutBase::getRightMarginOptions	protected	function	Gets the right margin options for the configuration form. Overrides BaseLayoutBase::getRightMarginOptions	1
DefaultLayoutBase::getRightPaddingOptions	protected	function	Gets the right padding options for the configuration form. Overrides BaseLayoutBase::getRightPaddingOptions	1
DefaultLayoutBase::getRowGapOptions	protected	function	Gets the row gap options for the configuration form. Overrides BaseLayoutBase::getRowGapOptions	1
DefaultLayoutBase::getTopMarginOptions	protected	function	Gets the top margin options for the configuration form. Overrides BaseLayoutBase::getTopMarginOptions	1
DefaultLayoutBase::getTopPaddingOptions	protected	function	Gets the top padding options for the configuration form. Overrides BaseLayoutBase::getTopPaddingOptions	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.