You are here

Home » API reference » Taxonomy menu 8.3 » TaxonomyMenu.php

class TaxonomyMenu in Taxonomy menu 8.3

Same name in this branch
  1. 8.3 src/Controller/TaxonomyMenu.php \Drupal\taxonomy_menu\Controller\TaxonomyMenu
  2. 8.3 src/Entity/TaxonomyMenu.php \Drupal\taxonomy_menu\Entity\TaxonomyMenu

Defines the TaxonomyMenu entity.

Plugin annotation


@ConfigEntityType(
  id = "taxonomy_menu",
  label = @Translation("Taxonomy menu"),
  handlers = {
    "list_builder" = "Drupal\taxonomy_menu\Controller\TaxonomyMenuListBuilder",
    "form" = {
      "add" = "Drupal\taxonomy_menu\Form\TaxonomyMenuForm",
      "edit" = "Drupal\taxonomy_menu\Form\TaxonomyMenuForm",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm"
    }
  },
  config_prefix = "taxonomy_menu",
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  },
  links = {
    "edit-form" = "/admin/structure/taxonomy_menu/{taxonomy_menu}",
    "delete-form" = "/admin/structure/taxonomy_menu/{taxonomy_menu}/delete",
    "collection" = "/admin/structure/taxonomy_menu"
  },
  config_export = {
    "id",
    "label",
    "vocabulary",
    "depth",
    "menu",
    "expanded",
    "menu_parent",
    "description_field_name",
    "use_term_weight_order"
  }
)

Hierarchy

Expanded class hierarchy of TaxonomyMenu

File

src/Entity/TaxonomyMenu.php, line 50

Namespace

Drupal\taxonomy_menu\Entity
View source 
class TaxonomyMenu extends ConfigEntityBase implements TaxonomyMenuInterface {

  /**
   * The TaxonomyMenu ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The TaxonomyMenu label.
   *
   * @var string
   */
  protected $label;

  /**
   * The taxonomy vocabulary.
   *
   * @var string
   *   The machine name of the vocabulary this entity represents.
   */
  protected $vocabulary;

  /**
   * The depth to generate menu items.
   *
   * @var int
   */
  protected $depth;

  /**
   * The menu to embed the vocabulary.
   *
   * @var string
   *   The machine name of the menu entity.
   */
  protected $menu;

  /**
   * The expanded mode.
   *
   * @var bool
   */
  public $expanded;

  /**
   * The menu parent.
   *
   * @var string
   */
  protected $menu_parent;

  /**
   * The name of the description field.
   *
   * @var string
   *  The machine name of the field to be used as the description.
   */
  protected $description_field_name;

  /**
   * {@inheritdoc}
   */
  public function getVocabulary() {
    return $this->vocabulary;
  }

  /**
   * {@inheritdoc}
   */
  public function getDepth() {
    return $this->depth;
  }

  /**
   * {@inheritdoc}
   */
  public function getMenu() {
    return $this->menu;
  }

  /**
   * {@inheritdoc}
   */
  public function getMenuParent() {
    return $this->menu_parent;
  }

  /**
   * Return if menu items should be ordered by the terms weight.
   *
   * Default value is TRUE.
   *
   * @return bool
   *   True or false.
   */
  public function useTermWeightOrder() {
    return isset($this->use_term_weight_order) ? $this->use_term_weight_order : TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescriptionFieldName() {
    return $this->description_field_name;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);
    $this
      ->addDependency('config', 'system.menu.' . $this
      ->getMenu());
    $this
      ->addDependency('config', 'taxonomy.vocabulary.' . $this
      ->getVocabulary());
  }

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

    // Make sure we don't have any save exceptions before building menu
    // definitions.
    $return = parent::save();
    foreach ($this
      ->getLinks([], TRUE) as $link_key => $link_def) {
      if ($this
        ->isNew() || !$this
        ->getMenuLinkManager()
        ->hasDefinition($link_key)) {
        $this
          ->getMenuLinkManager()
          ->addDefinition($link_key, $link_def);
      }
      else {
        $this
          ->getMenuLinkManager()
          ->updateDefinition($link_key, $link_def);
      }
    }
    return $return;
  }

  /**
   * {@inheritdoc}
   */
  public function delete() {
    foreach (array_keys($this
      ->getLinks([], TRUE)) as $link_key) {
      $this
        ->getMenuLinkManager()
        ->removeDefinition($link_key, FALSE);
    }
    parent::delete();
  }

  /**
   * {@inheritdoc}
   */
  public function getLinks(array $base_plugin_definition = [], $include_base_plugin_id = FALSE) {

    /* @var $termStorage \Drupal\taxonomy\TermStorageInterface */
    $termStorage = $this
      ->entityTypeManager()
      ->getStorage('taxonomy_term');

    // Load taxonomy terms for tax menu vocab.
    $terms = $termStorage
      ->loadTree($this
      ->getVocabulary(), 0, $this
      ->getDepth() + 1);
    $links = [];

    // Create menu links for each term in the vocabulary.
    foreach ($terms as $term) {
      if (!$term instanceof TermInterface) {
        $term = Term::load($term->tid);
      }
      $mlid = $this
        ->buildMenuPluginId($term, $include_base_plugin_id);
      $links[$mlid] = $this
        ->buildMenuDefinition($term, $base_plugin_definition);
    }
    return $links;
  }

  /**
   * Get the Menu Link Manager.
   *
   * @return \Drupal\Core\Menu\MenuLinkManagerInterface
   *   The Menu Link Manager Service
   */
  protected function getMenuLinkManager() {
    return \Drupal::service('plugin.manager.menu.link');
  }

  /**
   * {@inheritdoc}
   */
  public function buildMenuPluginId(TermInterface $term, $include_base_plugin_id = TRUE) {
    $plugin_id = '';
    if ($include_base_plugin_id) {
      $plugin_id .= 'taxonomy_menu.menu_link:';
    }
    $plugin_id .= 'taxonomy_menu.menu_link.' . $this
      ->id() . '.' . $term
      ->id();
    return $plugin_id;
  }

  /**
   * Generate a menu link plugin definition for a taxonomy term.
   *
   * @param \Drupal\taxonomy\TermInterface $term
   *   The taxonomy term for which to build a menu link render array.
   * @param array $base_plugin_definition
   *   The base plugin definition to merge the link with.
   *
   * @return array
   *   The menu link plugin definition.
   */
  protected function buildMenuDefinition(TermInterface $term, array $base_plugin_definition) {
    $term_id = $term
      ->id();
    $term_url = $term
      ->toUrl();
    $taxonomy_menu_id = $this
      ->id();
    $menu_id = $this
      ->getMenu();

    // Determine parent link.
    // TODO:
    // Evaluate use case of multiple parents (should we make many menu items?)
    $menu_parent_id = NULL;

    /* @var $termStorage \Drupal\taxonomy\TermStorageInterface */
    $termStorage = $this
      ->entityTypeManager()
      ->getStorage('taxonomy_term');
    $parents = $termStorage
      ->loadParents($term_id);
    $parents = array_values($parents);
    if (is_array($parents) && count($parents) && !is_null($parents[0]) && $parents[0] != '0') {
      $menu_parent_id = $this
        ->buildMenuPluginId($parents[0]);
    }

    // Note:
    // if menu_parent_id is NULL, it will not update the hierarchy properly.
    if (empty($menu_parent_id)) {
      $menu_parent_id = str_replace($this
        ->getMenu() . ':', '', $this
        ->getMenuParent());
    }

    // TODO: Consider implementing a forced weight based on taxonomy tree.
    // Generate link.
    $arguments = [
      'taxonomy_term' => $term_id,
    ];
    $link = $base_plugin_definition;
    $link += [
      'id' => $this
        ->buildMenuPluginId($term),
      'title' => $term
        ->label(),
      'description' => $term
        ->getDescription(),
      'menu_name' => $menu_id,
      'expanded' => $this->expanded,
      'metadata' => [
        'taxonomy_menu_id' => $taxonomy_menu_id,
        'taxonomy_term_id' => $term_id,
      ],
      'route_name' => $term_url
        ->getRouteName(),
      'route_parameters' => $term_url
        ->getRouteParameters(),
      'load arguments' => $arguments,
      'parent' => $menu_parent_id,
      'provider' => 'taxonomy_menu',
      'class' => 'Drupal\\taxonomy_menu\\Plugin\\Menu\\TaxonomyMenuMenuLink',
    ];

    // Order by terms weight if configured for this taxonomy_menu.
    if ($this
      ->useTermWeightOrder()) {
      $link['weight'] = $term
        ->getWeight();
    }
    \Drupal::moduleHandler()
      ->alter('taxonomy_menu_link', $link, $term);
    return $link;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
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 Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function
TaxonomyMenu::$depth protected property The depth to generate menu items.
TaxonomyMenu::$description_field_name protected property The name of the description field.
TaxonomyMenu::$expanded public property The expanded mode.
TaxonomyMenu::$id protected property The TaxonomyMenu ID.
TaxonomyMenu::$label protected property The TaxonomyMenu label.
TaxonomyMenu::$menu protected property The menu to embed the vocabulary.
TaxonomyMenu::$menu_parent protected property The menu parent.
TaxonomyMenu::$vocabulary protected property The taxonomy vocabulary.
TaxonomyMenu::buildMenuDefinition protected function Generate a menu link plugin definition for a taxonomy term.
TaxonomyMenu::buildMenuPluginId public function Generates a menu link id for the taxonomy term. Overrides TaxonomyMenuInterface::buildMenuPluginId
TaxonomyMenu::delete public function Deletes an entity permanently. Overrides EntityBase::delete
TaxonomyMenu::getDepth public function Get the depth of terms to generate menu items for. Overrides TaxonomyMenuInterface::getDepth
TaxonomyMenu::getDescriptionFieldName public function Get machine name of the field. Overrides TaxonomyMenuInterface::getDescriptionFieldName
TaxonomyMenu::getLinks public function Get menu link plugin definitions. Overrides TaxonomyMenuInterface::getLinks
TaxonomyMenu::getMenu public function Get the menu that the menu items are being created in. Overrides TaxonomyMenuInterface::getMenu
TaxonomyMenu::getMenuLinkManager protected function Get the Menu Link Manager.
TaxonomyMenu::getMenuParent public function Get the menu item to use as the parent for the taxonomy menu. Overrides TaxonomyMenuInterface::getMenuParent
TaxonomyMenu::getVocabulary public function Get the vocabulary being used. Overrides TaxonomyMenuInterface::getVocabulary
TaxonomyMenu::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
TaxonomyMenu::save public function Saves an entity permanently. Overrides ConfigEntityBase::save
TaxonomyMenu::useTermWeightOrder public function Return if menu items should be ordered by the terms weight.