You are here

Home » API reference » Domain Menus for Domains 9.1.x » DomainMenusMenuBlock.php

class DomainMenusMenuBlock in Domain Menus for Domains 9.1.x

Same name and namespace in other branches
  1. 9.x src/Plugin/Block/DomainMenusMenuBlock.php \Drupal\domain_menus\Plugin\Block\DomainMenusMenuBlock
  2. 3.x src/Plugin/Block/DomainMenusMenuBlock.php \Drupal\domain_menus\Plugin\Block\DomainMenusMenuBlock

Provides a block that displays an active domain menu.

Plugin annotation


@Block(
  id = "domain_menus_active_domain_menu_block",
  admin_label = @Translation("Domain menus active domain menu"),
  category = @Translation("Domain"),
)

Hierarchy

Expanded class hierarchy of DomainMenusMenuBlock

File

src/Plugin/Block/DomainMenusMenuBlock.php, line 23

Namespace

Drupal\domain_menus\Plugin\Block
View source 
class DomainMenusMenuBlock extends SystemMenuBlock {

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface;
   */
  protected $configFactory;

  /**
   * The domain negotiator service.
   *
   * @var \Drupal\domain\DomainNegotiatorInterface
   */
  protected $domainNegotiator;

  /**
   * Config settings.
   *
   * @var string
   */
  const SETTINGS = 'domain_menus.settings';

  /**
   * An array of settings.
   *
   * @var string[]
   */
  public $settings = [];

  /**
   * {@inheritdoc}
   */
  public function __construct($configuration, $plugin_id, $plugin_definition, $menu_tree, $menu_active_trail, ConfigFactoryInterface $config_factory, DomainNegotiatorInterface $domain_negotiator) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $menu_tree, $menu_active_trail);
    $this->configFactory = $config_factory;
    $this->domainNegotiator = $domain_negotiator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('menu.link_tree'), $container
      ->get('menu.active_trail'), $container
      ->get('config.factory'), $container
      ->get('domain.negotiator'));
  }

  /**
   * {@inheritdoc}
   */
  public function getDerivativeId() {
    $menu_name = Markup::create($this
      ->getSetting('menu_name'));
    $domain = $this->domainNegotiator
      ->getActiveDomain();
    $domain_domainid = $domain
      ->getDomainId();
    $id = trim($this
      ->t(DOMAIN_MENUS_MENU_ID_PATTERN, [
      '@domain_domainid' => $domain_domainid,
      '@menu_name' => $menu_name,
    ]));
    return $id;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $defaults = $this
      ->defaultConfiguration();
    $options = [
      '' => '',
    ];
    $domain_menus_menu_names = $this->configFactory
      ->get(static::SETTINGS)
      ->get('domain_menus_menu_names');
    if (!empty($domain_menus_menu_names)) {
      $menu_names = explode("\r\n", $domain_menus_menu_names);
      foreach ($menu_names as $menu_name) {
        if (!empty($menu_name)) {
          $options[$menu_name] = $menu_name;
        }
      }
    }
    $form['menu_name'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Domain menu name'),
      '#default_value' => $this
        ->getSetting('menu_name'),
      '#options' => $options,
      '#description' => $this
        ->t(''),
      '#required' => TRUE,
    );
    return parent::blockForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {

    // Process the block's submission handling if no errors occurred only.
    if (!$form_state
      ->getErrors()) {
      foreach (array_keys($this
        ->defaultConfiguration()) as $element) {
        $this->configuration[$element] = $form_state
          ->getValue($element);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    return parent::build();
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $defaults = parent::defaultConfiguration();
    $defaults['menu_name'] = '';
    return $defaults;
  }

  /**
   * Gets the configuration for the block, loading defaults if not set.
   *
   * @param string $key
   *   The setting key to retrieve, a string.
   *
   * @return string
   *   The setting value, a string.
   */
  public function getSetting($key) {
    if (isset($this->settings[$key])) {
      return $this->settings[$key];
    }
    $defaults = $this
      ->defaultConfiguration();
    if (isset($this->configuration[$key])) {
      $this->settings[$key] = $this->configuration[$key];
    }
    else {
      $this->settings[$key] = $defaults[$key];
    }
    return $this->settings[$key];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
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. Aliased as: traitBuildConfigurationForm
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.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract protected function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
DomainMenusMenuBlock::$configFactory protected property The config factory service.
DomainMenusMenuBlock::$domainNegotiator protected property The domain negotiator service.
DomainMenusMenuBlock::$settings public property An array of settings.
DomainMenusMenuBlock::blockForm public function Overrides SystemMenuBlock::blockForm
DomainMenusMenuBlock::blockSubmit public function Overrides SystemMenuBlock::blockSubmit
DomainMenusMenuBlock::build public function Builds and returns the renderable array for this block plugin. Overrides SystemMenuBlock::build
DomainMenusMenuBlock::create public static function Creates an instance of the plugin. Overrides SystemMenuBlock::create
DomainMenusMenuBlock::defaultConfiguration public function Overrides SystemMenuBlock::defaultConfiguration
DomainMenusMenuBlock::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides PluginBase::getDerivativeId
DomainMenusMenuBlock::getSetting public function Gets the configuration for the block, loading defaults if not set.
DomainMenusMenuBlock::SETTINGS constant Config settings.
DomainMenusMenuBlock::__construct public function Constructs a new SystemMenuBlock. Overrides SystemMenuBlock::__construct
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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::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 Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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::getCacheContexts public function Overrides ContextAwarePluginTrait::getCacheContexts
SystemMenuBlock::getCacheTags public function Overrides ContextAwarePluginTrait::getCacheTags
SystemMenuBlock::processMenuLevelParents public static function Form API callback: Processes the menu_levels field element.