You are here

Home » API reference » Layout Builder Symmetric Translations 8 » TranslatableSectionStorageInterface.php

interface TranslatableSectionStorageInterface in Layout Builder Symmetric Translations 8

Defines an interface for translatable section overrides.

Hierarchy

Expanded class hierarchy of TranslatableSectionStorageInterface

All classes that implement TranslatableSectionStorageInterface

3 files declare their use of TranslatableSectionStorageInterface
LayoutBuilderWidget.php in src/Plugin/Field/FieldWidget/LayoutBuilderWidget.php
OverridesSectionStorage.php in src/Plugin/SectionStorage/OverridesSectionStorage.php
TranslateBlockForm.php in src/Form/TranslateBlockForm.php

File

src/TranslatableSectionStorageInterface.php, line 10

Namespace

Drupal\layout_builder_st
View source 
interface TranslatableSectionStorageInterface extends SectionStorageInterface {

  /**
   * Indicates if the layout is default translation layout.
   *
   * @return bool
   *   TRUE if the layout is the default translation layout, otherwise FALSE.
   */
  public function isDefaultTranslation();

  /**
   * Sets the translated component configuration.
   *
   * @param string $uuid
   *   The component UUID.
   * @param array $configuration
   *   The component's translated configuration.
   */
  public function setTranslatedComponentConfiguration($uuid, array $configuration);

  /**
   * Gets the translated component configuration.
   *
   * @param string $uuid
   *   The component UUID.
   *
   * @return array
   *   The component's translated configuration.
   */
  public function getTranslatedComponentConfiguration($uuid);

  /**
   * Gets the translated configuration for the layout.
   *
   * @return array
   *   The translated configuration for the layout.
   */
  public function getTranslatedConfiguration();

  /**
   * Gets the language of the translation if any.
   *
   * @return \Drupal\Core\Language\LanguageInterface|null
   *   The translation language if the current layout is for a translation
   *   otherwise NULL.
   */
  public function getTranslationLanguage();

  /**
   * Gets the source language of the translation if any.
   *
   * @return \Drupal\Core\Language\LanguageInterface|null
   *   The translation source language if the current layout is for a
   *   translation otherwise NULL.
   */
  public function getSourceLanguage();

}

Members

Namesort descending Modifiers Type Description Overrides
ContextAwarePluginInterface::getContext public function Gets a defined context. 1
ContextAwarePluginInterface::getContextDefinition public function Gets a specific context definition of the plugin. Overrides ContextAwarePluginInterface::getContextDefinition
ContextAwarePluginInterface::getContextDefinitions public function Gets the context definitions of the plugin. Overrides ContextAwarePluginInterface::getContextDefinitions
ContextAwarePluginInterface::getContextMapping public function Gets a mapping of the expected assignment names to their context names. 1
ContextAwarePluginInterface::getContexts public function Gets the defined contexts. 1
ContextAwarePluginInterface::getContextValue public function Gets the value for a defined context. 1
ContextAwarePluginInterface::getContextValues public function Gets the values for all defined contexts. 1
ContextAwarePluginInterface::setContext public function Set a context on this plugin. 1
ContextAwarePluginInterface::setContextMapping public function Sets a mapping of the expected assignment names to their context names. 1
ContextAwarePluginInterface::setContextValue public function Sets the value for a defined context. 1
ContextAwarePluginInterface::validateContexts public function Validates the set values for the defined contexts. 1
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
SectionListInterface::appendSection public function Appends a new section to the end of the list. 1
SectionListInterface::getSection public function Gets a domain object for the layout section. 1
SectionListInterface::getSections public function Gets the layout sections. 5
SectionListInterface::insertSection public function Inserts a new section at a given delta. 1
SectionListInterface::removeAllSections public function Removes all of the sections. 1
SectionListInterface::removeSection public function Removes the section at the given delta. 1
SectionStorageInterface::access public function Overrides \Drupal\Core\Access\AccessibleInterface::access(). Overrides AccessibleInterface::access 4
SectionStorageInterface::buildRoutes public function Provides the routes needed for Layout Builder UI. 4
SectionStorageInterface::deriveContextsFromRoute public function Derives the available plugin contexts from route values. 4
SectionStorageInterface::extractIdFromRoute Deprecated public function Configures the plugin based on route values. 4
SectionStorageInterface::getContextsDuringPreview public function Gets contexts for use during preview. 2
SectionStorageInterface::getLayoutBuilderUrl public function Gets the URL used to display the Layout Builder UI. 4
SectionStorageInterface::getPluginDefinition public function Overrides \Drupal\Component\Plugin\PluginInspectionInterface::getPluginDefinition(). Overrides PluginInspectionInterface::getPluginDefinition
SectionStorageInterface::getRedirectUrl public function Gets the URL used when redirecting away from the Layout Builder UI. 4
SectionStorageInterface::getSectionListFromId Deprecated public function Derives the section list from the storage ID. 4
SectionStorageInterface::getStorageId public function Returns an identifier for this storage. 4
SectionStorageInterface::getStorageType public function Returns the type of this storage. 2
SectionStorageInterface::isApplicable public function Determines if this section storage is applicable for the current contexts. 4
SectionStorageInterface::label public function Gets the label for the object using the sections. 4
SectionStorageInterface::save public function Saves the sections. 4
TranslatableSectionStorageInterface::getSourceLanguage public function Gets the source language of the translation if any. 1
TranslatableSectionStorageInterface::getTranslatedComponentConfiguration public function Gets the translated component configuration. 1
TranslatableSectionStorageInterface::getTranslatedConfiguration public function Gets the translated configuration for the layout. 1
TranslatableSectionStorageInterface::getTranslationLanguage public function Gets the language of the translation if any. 1
TranslatableSectionStorageInterface::isDefaultTranslation public function Indicates if the layout is default translation layout. 1
TranslatableSectionStorageInterface::setTranslatedComponentConfiguration public function Sets the translated component configuration. 1