class MenuTokenSupportedTokensController in Menu Token 8

Class MenuTokenSupportedTokensController.

@package Drupal\menu_token\Controller

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\menu_token\Controller\MenuTokenSupportedTokensController

File

src/Controller/MenuTokenSupportedTokensController.php, line 16

Namespace

Drupal\menu_token\Controller

class MenuTokenSupportedTokensController extends ControllerBase {
  protected $configFactory;
  protected $treeBuilder;
  protected $renderer;

  /**
   * MenuTokenSupportedTokensController constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   Configuration factory.
   * @param \Drupal\token\TreeBuilderInterface $treeBuilder
   *   Tree builder service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   Renderer.
   */
  public function __construct(ConfigFactoryInterface $configFactory, TreeBuilderInterface $treeBuilder, RendererInterface $renderer) {
    $this->configFactory = $configFactory;
    $this->treeBuilder = $treeBuilder;
    $this->renderer = $renderer;
  }

  /**
   * Controller method for displaying supported token page.
   *
   * @return array
   *   Return the build array.
   */
  public function content() {

    /*
     * Load the configuration from configuration entity
     * and check for available entities.
     */
    $availableEntitiesConfiguration = $this->configFactory
      ->get('menu_token.availableentitiesconfiguration');
    $data = $availableEntitiesConfiguration
      ->getRawData();
    $renderable = [];
    foreach ($data['available_entities'] as $config_key => $config_item) {
      if ($config_item !== 0) {
        $renderable[] = $config_key;
      }
    }

    // Build the token tree for display.
    $token_tree = $this->treeBuilder
      ->buildRenderable($renderable, [
      'click_insert' => FALSE,
      'show_restricted' => FALSE,
      'show_nested' => FALSE,
    ]);

    // Create the html output.
    $output = '<dt>' . t('The list of the currently available tokens supported by menu_token are shown below.') . '</dt>';
    $output .= '<br /><dd>' . $this->renderer
      ->render($token_tree) . '</dd>';
    $output .= '</dl>';
    $build = [
      '#type' => 'markup',
      '#markup' => $output,
    ];
    return $build;
  }

  /**
   * When this subscriber is created, it will get the services and store them.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   Dependency injection container.
   *
   * @return static
   *   Container.
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('token.tree_builder'), $container
      ->get('renderer'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MenuTokenSupportedTokensController::$configFactory	protected	property	The configuration factory. Overrides ControllerBase::$configFactory
MenuTokenSupportedTokensController::$renderer	protected	property
MenuTokenSupportedTokensController::$treeBuilder	protected	property
MenuTokenSupportedTokensController::content	public	function	Controller method for displaying supported token page.
MenuTokenSupportedTokensController::create	public static	function	When this subscriber is created, it will get the services and store them. Overrides ControllerBase::create
MenuTokenSupportedTokensController::__construct	public	function	MenuTokenSupportedTokensController constructor.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.