You are here

Home » API reference » Menu item content fields 8 » FieldMenuBlock.php

class FieldMenuBlock in Menu item content fields 8

Provides a drupal menu that uses display view modes.

Plugin annotation


@Block(
  id = "menu_item_fields",
  admin_label = @Translation("Menu with fields"),
  deriver = "Drupal\system\Plugin\Derivative\SystemMenuBlock",
  category = @Translation("Menu Item Fields")
)

Hierarchy

Expanded class hierarchy of FieldMenuBlock

File

src/Plugin/Block/FieldMenuBlock.php, line 19

Namespace

Drupal\menu_item_fields\Plugin\Block
View source 
class FieldMenuBlock extends SystemMenuBlock {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $defaultConfiguration = parent::defaultConfiguration() + [
      'view_mode' => 'default',
      'view_mode_override_field' => '_none',
    ];
    return $defaultConfiguration;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $viewModes = \Drupal::entityTypeManager()
      ->getStorage('entity_view_mode')
      ->loadByProperties([
      'targetEntityType' => 'menu_link_content',
    ]);
    $viewModeOptions = [
      'default' => $this
        ->t('Default'),
    ];
    foreach ($viewModes as $viewMode) {
      $id = substr($viewMode
        ->id(), strlen('menu_link_content.'));
      $viewModeOptions[$id] = $viewMode
        ->label();
    }
    $form['view_mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('View mode to use when rendering the menu items'),
      '#default_value' => $this->configuration['view_mode'],
      '#description' => $this
        ->t('View mode to use when rendering menu items. <a href="@url">Configure view modes</a>', [
        '@url' => Url::fromRoute('entity.entity_view_display.menu_link_content.default')
          ->toString(),
      ]),
      '#options' => $viewModeOptions,
    ];
    $fields = \Drupal::entityTypeManager()
      ->getStorage('field_config')
      ->loadByProperties([
      'entity_type' => 'menu_link_content',
    ]);
    $fieldOptions = [
      '_none' => $this
        ->t('None'),
    ];
    foreach ($fields as $field) {
      list(, , $id) = explode('.', $field
        ->id());
      $fieldOptions[$id] = $field
        ->label();
    }
    $form['view_mode_override_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Field that stores the view mode override per menu item'),
      '#default_value' => $this->configuration['view_mode_override_field'],
      '#description' => $this
        ->t('This field will usually be a an options field with the available view mode ids.'),
      '#options' => $fieldOptions,
    ];
    $form += parent::blockForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    parent::blockSubmit($form, $form_state);
    $this->configuration['view_mode'] = $form_state
      ->getValue('view_mode');
    $this->configuration['view_mode_override_field'] = $form_state
      ->getValue('view_mode_override_field');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = parent::build();
    if (isset($build['#theme'])) {
      $build['#theme'] = $this
        ->addThemeSuggestion($build['#theme']);
    }
    $build['#view_mode'] = $this->configuration['view_mode'];
    if ($this->configuration['view_mode_override_field'] != '_none') {
      $build['#view_mode_override_field'] = $this->configuration['view_mode_override_field'];
    }

    // TODO: inject this dependency.
    $moduleHandler = \Drupal::service('module_handler');
    if ($moduleHandler
      ->moduleExists('menu_ui')) {
      $menuName = $this
        ->getDerivativeId();
      $build['#contextual_links']['menu'] = [
        'route_parameters' => [
          'menu' => $menuName,
        ],
      ];
    }
    return $build;
  }

  /**
   * Add a suggestion to be able to overwrite menu links markup.
   */
  protected function addThemeSuggestion($themeHook) {
    return preg_replace('/^menu__/', 'menu__field_content__', $themeHook);
  }

}

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::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::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. 2
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::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
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
FieldMenuBlock::addThemeSuggestion protected function Add a suggestion to be able to overwrite menu links markup.
FieldMenuBlock::blockForm public function Overrides SystemMenuBlock::blockForm
FieldMenuBlock::blockSubmit public function Overrides SystemMenuBlock::blockSubmit
FieldMenuBlock::build public function Builds and returns the renderable array for this block plugin. Overrides SystemMenuBlock::build
FieldMenuBlock::defaultConfiguration public function Overrides SystemMenuBlock::defaultConfiguration
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
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.
SystemMenuBlock::$menuActiveTrail protected property The active menu trail service.
SystemMenuBlock::$menuTree protected property The menu link tree service.
SystemMenuBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SystemMenuBlock::getCacheContexts public function The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
SystemMenuBlock::getCacheTags public function The cache tags associated with this object. Overrides ContextAwarePluginBase::getCacheTags
SystemMenuBlock::processMenuLevelParents public static function Form API callback: Processes the menu_levels field element.
SystemMenuBlock::__construct public function Constructs a new SystemMenuBlock. Overrides BlockPluginTrait::__construct
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