class TaxonomyMenuMenuLink in Zircon Profile 8

Defines menu links provided by taxonomy menu.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\Core\Menu\MenuLinkBase implements MenuLinkInterface
      • class \Drupal\taxonomy_menu\Plugin\Menu\TaxonomyMenuMenuLink implements ContainerFactoryPluginInterface

See also

\Drupal\taxonony_menu\Plugin\Derivative\TaxonomyMenuMenuLink

1 string reference to 'TaxonomyMenuMenuLink'

taxonomy_menu.links.menu.yml in modules/taxonomy_menu/taxonomy_menu.links.menu.yml

modules/taxonomy_menu/taxonomy_menu.links.menu.yml

File

modules/taxonomy_menu/src/Plugin/Menu/TaxonomyMenuMenuLink.php, line 21

Contains \Drupal\taxonomy_menu\Plugin\Menu\TaxonomyMenuMenuLink.

Namespace

Drupal\taxonomy_menu\Plugin\Menu

class TaxonomyMenuMenuLink extends MenuLinkBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  protected $overrideAllowed = array(
    //'menu_name' => 1,

    //'parent' => 1,
    'weight' => 1,
    'expanded' => 1,
    'enabled' => 1,
  );

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManager
   */
  protected $entityManager;

  /**
   * Constructs a new TaxonomyMenuMenuLink.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager
   * @param \Drupal\views\ViewExecutableFactory $view_executable_factory
   *   The view executable factory
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager) {
    $this->configuration = $configuration;
    $this->pluginId = $plugin_id;
    $this->pluginDefinition = $plugin_definition;
    $this->entityManager = $entity_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return $this->entityManager
      ->getStorage('taxonomy_term')
      ->load($this->pluginDefinition['metadata']['taxonomy_term_id'])
      ->label();
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->entityManager
      ->getStorage('taxonomy_term')
      ->load($this->pluginDefinition['metadata']['taxonomy_term_id'])
      ->getDescription();
  }

  /**
   * {@inheritdoc}
   */
  public function updateLink(array $new_definition_values, $persist) {
    $overrides = array_intersect_key($new_definition_values, $this->overrideAllowed);

    // Update the definition.
    $this->pluginDefinition = $overrides + $this->pluginDefinition;
    if ($persist) {

      // TODO - consider any "persistence" back to TaxonomyMenu and/or Taxonomy upon menu link update.
    }
    return $this->pluginDefinition;
  }

  /**
   * {@inheritdoc}
   */
  public function isDeletable() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function deleteLink() {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
MenuLinkBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	3
MenuLinkBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	2
MenuLinkBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	2
MenuLinkBase::getDeleteRoute	public	function	Returns route information for a route to delete the menu link. Overrides MenuLinkInterface::getDeleteRoute	1
MenuLinkBase::getEditRoute	public	function	Returns route information for a custom edit form for the menu link. Overrides MenuLinkInterface::getEditRoute	1
MenuLinkBase::getFormClass	public	function	Returns the name of a class that can build an editing form for this link. Overrides MenuLinkInterface::getFormClass
MenuLinkBase::getMenuName	public	function	Returns the menu name of the menu link. Overrides MenuLinkInterface::getMenuName
MenuLinkBase::getMetaData	public	function	Returns any metadata for this link. Overrides MenuLinkInterface::getMetaData
MenuLinkBase::getOptions	public	function	Returns the options for this link. Overrides MenuLinkInterface::getOptions
MenuLinkBase::getParent	public	function	Returns the plugin ID of the menu link's parent, or an empty string. Overrides MenuLinkInterface::getParent
MenuLinkBase::getProvider	public	function	Returns the provider (module name) of the menu link. Overrides MenuLinkInterface::getProvider
MenuLinkBase::getRouteName	public	function	Returns the route name, if available. Overrides MenuLinkInterface::getRouteName	2
MenuLinkBase::getRouteParameters	public	function	Returns the route parameters, if available. Overrides MenuLinkInterface::getRouteParameters
MenuLinkBase::getTranslateRoute	public	function	Returns route information for a route to translate the menu link. Overrides MenuLinkInterface::getTranslateRoute	1
MenuLinkBase::getUrlObject	public	function	Returns a URL object containing either the external path or route. Overrides MenuLinkInterface::getUrlObject
MenuLinkBase::getWeight	public	function	Returns the weight of the menu link. Overrides MenuLinkInterface::getWeight
MenuLinkBase::isEnabled	public	function	Returns whether the menu link is enabled (not hidden). Overrides MenuLinkInterface::isEnabled
MenuLinkBase::isExpanded	public	function	Returns whether the child menu links should always been shown. Overrides MenuLinkInterface::isExpanded	1
MenuLinkBase::isResettable	public	function	Returns whether this link can be reset. Overrides MenuLinkInterface::isResettable	1
MenuLinkBase::isTranslatable	public	function	Returns whether this link can be translated. Overrides MenuLinkInterface::isTranslatable	1
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.
TaxonomyMenuMenuLink::$entityManager	protected	property	The entity manager.
TaxonomyMenuMenuLink::$overrideAllowed	protected	property	The list of definition values where an override is allowed. Overrides MenuLinkBase::$overrideAllowed
TaxonomyMenuMenuLink::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TaxonomyMenuMenuLink::deleteLink	public	function	Deletes a menu link. Overrides MenuLinkBase::deleteLink
TaxonomyMenuMenuLink::getDescription	public	function	Returns the description of the menu link. Overrides MenuLinkInterface::getDescription
TaxonomyMenuMenuLink::getTitle	public	function	Returns the localized title to be shown for this link. Overrides MenuLinkInterface::getTitle
TaxonomyMenuMenuLink::isDeletable	public	function	Returns whether this link can be deleted. Overrides MenuLinkBase::isDeletable
TaxonomyMenuMenuLink::updateLink	public	function	Updates the definition values for a menu link. Overrides MenuLinkInterface::updateLink
TaxonomyMenuMenuLink::__construct	public	function	Constructs a new TaxonomyMenuMenuLink. Overrides PluginBase::__construct