TaxonomyMenuInterface.php in Zircon Profile 8

Contains Drupal\taxonomy_menu\TaxonomyMenuInterface.

Namespace

Drupal\taxonomy_menu

File

modules/taxonomy_menu/src/TaxonomyMenuInterface.php

<?php

/**
 * @file
 * Contains Drupal\taxonomy_menu\TaxonomyMenuInterface.
 */
namespace Drupal\taxonomy_menu;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Provides an interface defining a TaxonomyMenu entity.
 */
interface TaxonomyMenuInterface extends ConfigEntityInterface {

  /**
   * @return string
   *   The machine name of the menu entity which hold the vocabulary's menu items.
   */
  public function getMenu();

  /**
   * @return string
   *   The vocabulary whose terms will be used to generate a menu.
   */
  public function getVocabulary();

  /**
   * Get menu link plugin definitions
   *
   * @param array $base_plugin_definition
   *
   * @param bool $include_base_plugin_id
   *   If true, 'taxonomy_menu.menu_link:' will be prepended to the returned
   *   plugin ids.
   *
   * @return array
   */
  public function getLinks($base_plugin_definition = [], $include_base_plugin_id = FALSE);

}

Interfaces

Name	Description
TaxonomyMenuInterface	Provides an interface defining a TaxonomyMenu entity.