You are here

Home » API reference » Entity Reference Hierarchy 3.x » MicrositeMenu.php

class MicrositeMenu in Entity Reference Hierarchy 3.x

Same name and namespace in other branches
  1. 8.2 modules/entity_hierarchy_microsite/src/Plugin/Block/MicrositeMenu.php \Drupal\entity_hierarchy_microsite\Plugin\Block\MicrositeMenu

Defines a class for a microsite menu.

Plugin annotation


@Block(
  id = "entity_hierarchy_microsite_menu",
  admin_label = @Translation("Microsite Menu"),
  category = @Translation("Microsite"),
  context_definitions = {
    "node" = @ContextDefinition("entity:node", label = @Translation("Current node"))
  }
)

Hierarchy

Expanded class hierarchy of MicrositeMenu

File

modules/entity_hierarchy_microsite/src/Plugin/Block/MicrositeMenu.php, line 26

Namespace

Drupal\entity_hierarchy_microsite\Plugin\Block
View source 
class MicrositeMenu extends SystemMenuBlock implements ContainerFactoryPluginInterface {
  use MicrositePluginTrait {
    create as traitCreate;
    buildConfigurationForm as traitBuildConfigurationForm;
    submitConfigurationForm as traitSubmitConfigurationForm;
    defaultConfiguration as traitDefaultConfiguration;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + $this
      ->traitDefaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return parent::buildConfigurationForm($form, $form_state) + $this
      ->traitBuildConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    return parent::submitConfigurationForm($form, $form_state) + $this
      ->traitSubmitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var \Drupal\entity_hierarchy_microsite\Plugin\Block\MicrositeMenu $instance */
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    return $instance
      ->setChildOfMicrositeLookup($container
      ->get('entity_hierarchy_microsite.microsite_lookup'))
      ->setEntityFieldManager($container
      ->get('entity_field.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $cache = new CacheableMetadata();
    if (!($node = $this
      ->getContextValue('node')) || !$node instanceof NodeInterface || !($microsites = $this->childOfMicrositeLookup
      ->findMicrositesForNodeAndField($node, $this->configuration['field']))) {
      $build = [];
      if ($node) {
        $cache
          ->addCacheableDependency($node);
      }
      $cache
        ->applyTo($build);
      return $build;
    }

    /** @var \Drupal\entity_hierarchy_microsite\Entity\MicrositeInterface $microsite */
    $microsite = reset($microsites);
    $cache
      ->addCacheableDependency($node);
    $cache
      ->addCacheableDependency($microsite);
    if ($home = $microsite
      ->getHome()) {
      $cache
        ->addCacheableDependency($home);
    }
    $menu_name = $this
      ->getDerivativeId();
    if ($this->configuration['expand_all_items']) {
      $parameters = new MenuTreeParameters();
      $active_trail = $this->menuActiveTrail
        ->getActiveTrailIds($menu_name);
      $parameters
        ->setActiveTrail($active_trail);
    }
    else {
      $parameters = $this->menuTree
        ->getCurrentRouteMenuTreeParameters($menu_name);
    }
    if ($home) {
      $parameters
        ->setRoot('entity_hierarchy_microsite:' . $home
        ->uuid());
    }

    // Adjust the menu tree parameters based on the block's configuration.
    $level = $this->configuration['level'];
    $depth = $this->configuration['depth'];
    $parameters
      ->setMinDepth($level);

    // When the depth is configured to zero, there is no depth limit. When depth
    // is non-zero, it indicates the number of levels that must be displayed.
    // Hence this is a relative depth that we must convert to an actual
    // (absolute) depth, that may never exceed the maximum depth.
    if ($depth > 0) {
      $parameters
        ->setMaxDepth(min($level + $depth - 1, $this->menuTree
        ->maxDepth()));
    }

    // For menu blocks with start level greater than 1, only show menu items
    // from the current active trail. Adjust the root according to the current
    // position in the menu in order to determine if we can show the subtree.
    if ($level > 1) {
      if (count($parameters->activeTrail) >= $level) {

        // Active trail array is child-first. Reverse it, and pull the new menu
        // root based on the parent of the configured start level.
        $menu_trail_ids = array_reverse(array_values($parameters->activeTrail));
        if ($depth > 0) {
          $parameters
            ->setMaxDepth(min($level - 1 + $depth - 1, $this->menuTree
            ->maxDepth()));
        }
      }
      else {
        $build = [];
        $cache
          ->applyTo($build);
        return $build;
      }
    }
    $tree = $this->menuTree
      ->load($menu_name, $parameters);
    $manipulators = [
      [
        'callable' => 'menu.default_tree_manipulators:checkAccess',
      ],
      [
        'callable' => 'menu.default_tree_manipulators:generateIndexAndSort',
      ],
    ];
    $tree = $this->menuTree
      ->transform($tree, $manipulators);
    $build = $this->menuTree
      ->build($tree);
    $cache
      ->applyTo($build);
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getDerivativeId() {
    return 'entity-hierarchy-microsite';
  }

}

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::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::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
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
MicrositeMenu::build public function Builds and returns the renderable array for this block plugin. Overrides SystemMenuBlock::build
MicrositeMenu::buildConfigurationForm public function Form constructor. Overrides BlockBase::buildConfigurationForm
MicrositeMenu::create public static function Creates an instance of the plugin. Overrides SystemMenuBlock::create
MicrositeMenu::defaultConfiguration public function Overrides SystemMenuBlock::defaultConfiguration
MicrositeMenu::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides PluginBase::getDerivativeId
MicrositeMenu::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). Overrides BlockPluginTrait::submitConfigurationForm
MicrositePluginTrait::$childOfMicrositeLookup protected property Child of microsite lookup.
MicrositePluginTrait::$entityFieldManager protected property Entity field manager.
MicrositePluginTrait::buildConfigurationForm public function Aliased as: traitBuildConfigurationForm
MicrositePluginTrait::create public static function Aliased as: traitCreate
MicrositePluginTrait::defaultConfiguration public function Aliased as: traitDefaultConfiguration
MicrositePluginTrait::getFieldOptions protected function Gets field options.
MicrositePluginTrait::setChildOfMicrositeLookup public function Sets value of NestedSetStorageFactory.
MicrositePluginTrait::setEntityFieldManager protected function Entity field manager.
MicrositePluginTrait::submitConfigurationForm public function Aliased as: traitSubmitConfigurationForm
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::blockForm public function Overrides BlockPluginTrait::blockForm
SystemMenuBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
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.
SystemMenuBlock::__construct public function Constructs a new SystemMenuBlock. Overrides BlockPluginTrait::__construct