class ApiTokenController in API Tokens 8

Controller routines for API tokens routes.

Hierarchy

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

File

src/Controller/ApiTokenController.php, line 12

Namespace

Drupal\api_tokens\Controller

class ApiTokenController extends ControllerBase {

  /**
   * The API token manager.
   *
   * @var \Drupal\api_tokens\ApiTokenManagerInterface
   */
  protected $apiTokenManager;

  /**
   * Constructs a new ApiTokenController.
   *
   * @param \Drupal\api_tokens\ApiTokenManagerInterface $api_token_manager
   *   The API token manager.
   */
  public function __construct(ApiTokenManagerInterface $api_token_manager) {
    $this->apiTokenManager = $api_token_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.api_token'));
  }

  /**
   * Displays the API tokens overview page.
   *
   * @return array
   *   A renderable array.
   */
  public function adminOverview() {
    $build['table'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Token'),
        $this
          ->t('Synopsis'),
        $this
          ->t('Provider'),
      ],
      '#empty' => $this
        ->t('There are no API tokens registered.'),
    ];
    foreach ($this->apiTokenManager
      ->getSortedDefinitions() as $id => $definition) {
      $row =& $build['table'][$id];
      $row['token'] = [
        '#type' => 'item',
        '#title' => $definition['label'],
        '#description' => $definition['description'],
        '#description_display' => 'after',
      ];
      $row['synopsis'] = $this
        ->buildSynopsis($id);
      $row['provider'] = [
        '#type' => 'item',
        '#title' => $definition['category'],
        '#description' => $this
          ->t('Machine name: @provider', [
          '@provider' => $definition['provider'],
        ]),
        '#description_display' => 'after',
      ];
    }
    return $build;
  }

  /**
   * Renders the API token synopsis.
   *
   * @param string $id
   *   The API token plugin ID.
   *
   * @return array
   *   A renderable array.
   */
  protected function buildSynopsis($id) {
    $plugin = $this->apiTokenManager
      ->createInstance($id);
    $parts = [];
    foreach ($plugin
      ->reflector()
      ->getParameters() as $param) {
      $name = $param
        ->getName();
      if (!$param
        ->isOptional()) {
        $name = "<strong>{$name}</strong>";
      }
      $parts[] = "<em>{$name}</em>";
    }
    $params = $parts ? '[' . implode(', ', $parts) . ']' : '';
    $build = [
      '#type' => 'html_tag',
      '#tag' => 'code',
      '#value' => "[api:{$id}{$params}/]",
    ];
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ApiTokenController::$apiTokenManager	protected	property	The API token manager.
ApiTokenController::adminOverview	public	function	Displays the API tokens overview page.
ApiTokenController::buildSynopsis	protected	function	Renders the API token synopsis.
ApiTokenController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ApiTokenController::__construct	public	function	Constructs a new ApiTokenController.
ControllerBase::$configFactory	protected	property	The configuration factory.
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.
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.