public function ForumManager::getIndex in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/forum/src/ForumManager.php \Drupal\forum\ForumManager::getIndex()
2. 10 core/modules/forum/src/ForumManager.php \Drupal\forum\ForumManager::getIndex()

Generates and returns the forum index.

The forum index is a pseudo term that provides an overview of all forums.

Return value

\Drupal\taxonomy\TermInterface A pseudo term representing the overview of all forums.

Overrides ForumManagerInterface::getIndex

File

core/modules/forum/src/ForumManager.php, line 440

Class

ForumManager

Provides forum manager service.

Namespace

Drupal\forum

Code

public function getIndex() {
  if ($this->index) {
    return $this->index;
  }
  $vid = $this->configFactory
    ->get('forum.settings')
    ->get('vocabulary');
  $index = $this->entityTypeManager
    ->getStorage('taxonomy_term')
    ->create([
    'tid' => 0,
    'container' => 1,
    'parents' => [],
    'isIndex' => TRUE,
    'vid' => $vid,
  ]);

  // Load the tree below.
  $index->forums = $this
    ->getChildren($vid, 0);
  $this->index = $index;
  return $index;
}