You are here

Home » API reference » Menu Link (Field) 8 » MenuLinkBreadcrumbFormatter.php

class MenuLinkBreadcrumbFormatter in Menu Link (Field) 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/Field/FieldFormatter/MenuLinkBreadcrumbFormatter.php \Drupal\menu_link\Plugin\Field\FieldFormatter\MenuLinkBreadcrumbFormatter

Plugin implementation of the 'menu_link_breadcrumb' formatter.

Plugin annotation


@FieldFormatter(
  id = "menu_link_breadcrumb",
  label = @Translation("Menu link breadcrumb"),
  field_types = {
    "menu_link",
  }
)

Hierarchy

Expanded class hierarchy of MenuLinkBreadcrumbFormatter

File

src/Plugin/Field/FieldFormatter/MenuLinkBreadcrumbFormatter.php, line 27

Namespace

Drupal\menu_link\Plugin\Field\FieldFormatter
View source 
class MenuLinkBreadcrumbFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * @var MenuLinkManagerInterface
   */
  protected $menuLinkManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('plugin.manager.menu.link'));
  }

  /**
   * Constructs a MenuLinkBreadcrumbFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager
   *   The menu link manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, $menu_link_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->menuLinkManager = $menu_link_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $options = parent::defaultSettings();
    $options['parents_only'] = FALSE;
    $options['link_to_target'] = TRUE;
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['link_to_target'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable links'),
      '#description' => $this
        ->t('Enable this for links in the breadcrumb, or disable this for a plain text breadcrumb.'),
      '#default_value' => $this
        ->getSetting('link_to_target'),
    ];
    $form['parents_only'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Only show the parents of the menu link'),
      '#description' => $this
        ->t('Enable this only show the parents of the menu link, hiding the men link itself from the breadcrumb trail.'),
      '#default_value' => $this
        ->getSetting('parents_only'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('link_to_target')) {
      $summary[] = $this
        ->t('Links enabled');
    }
    if ($this
      ->getSetting('parents_only')) {
      $summary[] = $this
        ->t('Parents only');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $menu_links = [];
      $id = $items[$delta]
        ->getMenuPluginId();
      $parent_ids = $this->menuLinkManager
        ->getParentIds($id);
      if (!empty($parent_ids)) {
        foreach ($parent_ids as $parent_id) {
          if (!$this
            ->getSetting('parents_only') || $parent_id != $id) {
            $menu_links[] = $this->menuLinkManager
              ->createInstance($parent_id);
          }
        }
      }
      $menu_links = array_reverse($menu_links);

      // Get the links to add to the breadcrumb.
      $links = array_map(function ($link) {
        if ($this
          ->getSetting('link_to_target')) {
          $url = $link
            ->getUrlObject();
        }
        else {

          // Set URL to none if we don't want to link to the menu link target.
          $url = new Url('<none>');
        }
        return Link::fromTextAndUrl($link
          ->getTitle(), $url);
      }, $menu_links);

      // Set up the breadcrumb.
      $breadcrumb = new Breadcrumb();
      $breadcrumb
        ->setLinks($links);
      $elements[$delta] = $breadcrumb
        ->toRenderable();
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
MenuLinkBreadcrumbFormatter::$menuLinkManager protected property
MenuLinkBreadcrumbFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
MenuLinkBreadcrumbFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
MenuLinkBreadcrumbFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
MenuLinkBreadcrumbFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
MenuLinkBreadcrumbFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
MenuLinkBreadcrumbFormatter::__construct public function Constructs a MenuLinkBreadcrumbFormatter object. Overrides FormatterBase::__construct
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.