You are here

Home » API reference » Layout Builder UX 8 » InlineBlockUX.php

class InlineBlockUX in Layout Builder UX 8

Alters the inline block form.

Hierarchy

Expanded class hierarchy of InlineBlockUX

1 file declares its use of InlineBlockUX
lb_ux.module in ./lb_ux.module
Contains lb_ux.module.

File

src/Plugin/Block/InlineBlockUX.php, line 13

Namespace

Drupal\lb_ux\Plugin\Block
View source 
class InlineBlockUX extends InlineBlock {

  /**
   * The keyvalue factory.
   *
   * @var \Drupal\Core\KeyValueStore\KeyValueFactoryInterface
   */
  protected $keyValueFactory;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance->keyValueFactory = $container
      ->get('keyvalue');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);

    // Hide the label field when the label display is unchecked.
    $form['label']['#states']['invisible'][':input[name="settings[label_display]"]']['checked'] = FALSE;
    if ($this->isNew) {

      // Uncheck the label display checkbox for new blocks.
      $form['label_display']['#default_value'] = FALSE;

      // Prefill the label field for new blocks.
      $form['label']['#default_value'] = $this
        ->t('@label @count', [
        '@label' => $this
          ->label(),
        '@count' => $this
          ->getNextInlineBlockNumber($form_state),
      ]);
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    parent::blockSubmit($form, $form_state);
    if ($form_state
      ->has('lb_ux.inline_block_count')) {

      /** @var \Drupal\layout_builder\SectionStorageInterface $section_storage */
      $section_storage = $form_state
        ->getFormObject()
        ->getSectionStorage();
      $this->keyValueFactory
        ->get('lb_ux.inline_block_count.' . $section_storage
        ->getStorageType())
        ->set($section_storage
        ->getStorageId(), $form_state
        ->get('lb_ux.inline_block_count'));
    }
  }

  /**
   * Gets the number of the next inline block.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return int
   *   The next number.
   */
  protected function getNextInlineBlockNumber(FormStateInterface $form_state) {
    if ($form_state
      ->has('lb_ux.inline_block_count')) {
      return $form_state
        ->get('lb_ux.inline_block_count');
    }

    /** @var \Drupal\layout_builder\SectionStorageInterface $section_storage */
    $section_storage = $form_state
      ->getFormObject()
      ->getSectionStorage();
    $count = $this->keyValueFactory
      ->get('lb_ux.inline_block_count.' . $section_storage
      ->getStorageType())
      ->get($section_storage
      ->getStorageId(), 0);
    if (!$count) {
      foreach ($section_storage
        ->getSections() as $section) {
        foreach ($section
          ->getComponents() as $component) {
          $plugin = $component
            ->getPlugin();
          if ($plugin instanceof DerivativeInspectionInterface && $plugin
            ->getBaseId() === 'inline_block') {
            $count++;
          }
        }
      }

      // Exclude the component being added.
      if ($form_state
        ->has('layout_builder__component')) {
        $count--;
      }
    }
    $form_state
      ->set('lb_ux.inline_block_count', ++$count);
    return $count;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
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
InlineBlock::$blockContent protected property The block content entity.
InlineBlock::$currentUser protected property The current user.
InlineBlock::$entityDisplayRepository protected property The entity display repository.
InlineBlock::$entityTypeManager protected property The entity type manager.
InlineBlock::$isNew protected property Whether a new block is being created.
InlineBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
InlineBlock::blockForm public function Overrides BlockPluginTrait::blockForm
InlineBlock::blockValidate public function Overrides BlockPluginTrait::blockValidate
InlineBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
InlineBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
InlineBlock::getEntity protected function Loads or creates the block content entity of the block.
InlineBlock::processBlockForm public static function Process callback to insert a Custom Block form.
InlineBlock::saveBlockContent public function Saves the block_content entity for this plugin.
InlineBlock::__construct public function Constructs a new InlineBlock. Overrides BlockPluginTrait::__construct
InlineBlockUX::$keyValueFactory protected property The keyvalue factory.
InlineBlockUX::blockSubmit public function Overrides InlineBlock::blockSubmit
InlineBlockUX::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. Overrides InlineBlock::buildConfigurationForm
InlineBlockUX::create public static function Creates an instance of the plugin. Overrides InlineBlock::create
InlineBlockUX::getNextInlineBlockNumber protected function Gets the number of the next inline block.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 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::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
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.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
RefinableDependentAccessTrait::$accessDependency protected property The access dependency.
RefinableDependentAccessTrait::addAccessDependency public function
RefinableDependentAccessTrait::getAccessDependency public function
RefinableDependentAccessTrait::setAccessDependency public function
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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2