You are here

Home » API reference » Custom Tokens 8 » TokenCustomController.php

class TokenCustomController in Custom Tokens 8

Controller for token_custom entity.

Hierarchy

Expanded class hierarchy of TokenCustomController

File

src/Controller/TokenCustomController.php, line 15

Namespace

Drupal\token_custom\Controller
View source 
class TokenCustomController extends ControllerBase {

  /**
   * The custom token storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $tokenCustomStorage;

  /**
   * The custom token type storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $tokenCustomTypeStorage;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $entity_manager = $container
      ->get('entity_type.manager');
    return new static($entity_manager
      ->getStorage('token_custom'), $entity_manager
      ->getStorage('token_custom_type'));
  }

  /**
   * Constructs a TokenCustom object.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $token_custom_storage
   *   The custom token storage.
   * @param \Drupal\Core\Entity\EntityStorageInterface $token_custom_type_storage
   *   The custom token type storage.
   */
  public function __construct(EntityStorageInterface $token_custom_storage, EntityStorageInterface $token_custom_type_storage) {
    $this->tokenCustomStorage = $token_custom_storage;
    $this->tokenCustomTypeStorage = $token_custom_type_storage;
  }

  /**
   * Displays add custom token links for available types.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request object.
   *
   * @return array
   *   A render array for a list of the custom token types that can be added or
   *   if there is only one custom token type defined for the site, the function
   *   returns the custom token add page for that custom token type.
   */
  public function add(Request $request) {
    $types = $this->tokenCustomTypeStorage
      ->loadMultiple();
    if ($types && count($types) == 1) {
      $type = reset($types);
      return $this
        ->addForm($type, $request);
    }
    if (count($types) === 0) {
      return [
        '#markup' => $this
          ->t('You have not created any token types yet. Go to the <a href=":url">token type creation page</a> to add a new token type.', [
          ':url' => Url::fromRoute('token_custom.type_add')
            ->toString(),
        ]),
      ];
    }
    return [
      '#theme' => 'token_custom_add_list',
      '#content' => $types,
    ];
  }

  /**
   * Presents the custom token creation form.
   *
   * @param \Drupal\token_custom\TokenCustomTypeInterface $token_custom_type
   *   The custom token type to add.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request object.
   *
   * @return array
   *   A form array as expected by drupal_render().
   */
  public function addForm(TokenCustomTypeInterface $token_custom_type, Request $request) {
    $token = $this->tokenCustomStorage
      ->create([
      'type' => $token_custom_type
        ->id(),
    ]);
    return $this
      ->entityFormBuilder()
      ->getForm($token);
  }

  /**
   * Provides the page title for this controller.
   *
   * @param \Drupal\token_custom\TokenCustomTypeInterface $token_custom_type
   *   The custom token type being added.
   *
   * @return string
   *   The page title.
   */
  public function getAddFormTitle(TokenCustomTypeInterface $token_custom_type) {
    return $this
      ->t('Add %type custom token', [
      '%type' => $token_custom_type
        ->label(),
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
TokenCustomController::$tokenCustomStorage protected property The custom token storage.
TokenCustomController::$tokenCustomTypeStorage protected property The custom token type storage.
TokenCustomController::add public function Displays add custom token links for available types.
TokenCustomController::addForm public function Presents the custom token creation form.
TokenCustomController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
TokenCustomController::getAddFormTitle public function Provides the page title for this controller.
TokenCustomController::__construct public function Constructs a TokenCustom object.
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.