You are here

class TestController in Zircon Profile 8

Same name in this branch
  1. 8 core/tests/Drupal/Tests/Core/Controller/TestController.php \Drupal\Tests\Core\Controller\TestController
  2. 8 core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php \Drupal\Tests\Core\Access\TestController
  3. 8 core/modules/system/tests/modules/httpkernel_test/src/Controller/TestController.php \Drupal\httpkernel_test\Controller\TestController
  4. 8 core/modules/system/tests/modules/token_test/src/Controller/TestController.php \Drupal\token_test\Controller\TestController
  5. 8 core/modules/system/tests/modules/conneg_test/src/Controller/TestController.php \Drupal\conneg_test\Controller\TestController
Same name and namespace in other branches
  1. 8.0 core/modules/system/tests/modules/token_test/src/Controller/TestController.php \Drupal\token_test\Controller\TestController

Provides a test controller for token replacement.

Hierarchy

Expanded class hierarchy of TestController

File

core/modules/system/tests/modules/token_test/src/Controller/TestController.php, line 20
Contains \Drupal\token_test\Controller\TestController.

Namespace

Drupal\token_test\Controller
View source
class TestController extends ControllerBase {

  /**
   * The token replacement system.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * Constructs a new TestController instance.
   *
   * @param \Drupal\Core\Utility\Token $token
   *   The token replacement system.
   */
  public function __construct(Token $token) {
    $this->token = $token;
  }

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

  /**
   * Provides a token replacement with a node as well as the current user.
   *
   * This controller passes an explicit bubbleable metadata object to
   * $this->token->replace(), and applies the collected metadata to the render
   * array being built.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The node.
   *
   * @return array
   *   The render array.
   */
  public function tokenReplace(NodeInterface $node) {
    $bubbleable_metadata = new BubbleableMetadata();
    $build['#markup'] = $this->token
      ->replace('Tokens: [node:nid] [current-user:uid]', [
      'node' => $node,
    ], [], $bubbleable_metadata);
    $bubbleable_metadata
      ->applyTo($build);
    return $build;
  }

  /**
   * Provides a token replacement with a node as well as the current user.
   *
   * This controller is for testing the token service's fallback behavior of
   * applying collected metadata to the currently active render context when an
   * explicit bubbleable metadata object isn't passed in.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The node.
   *
   * @return array
   *   The render array.
   */
  public function tokenReplaceWithoutPassedBubbleableMetadata(NodeInterface $node) {
    $build['#markup'] = $this->token
      ->replace('Tokens: [node:nid] [current-user:uid]', [
      'node' => $node,
    ], []);
    return $build;
  }

}

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. 1
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 3
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. 1
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 3
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::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
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.
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.
TestController::$token protected property The token replacement system.
TestController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
TestController::tokenReplace public function Provides a token replacement with a node as well as the current user.
TestController::tokenReplaceWithoutPassedBubbleableMetadata public function Provides a token replacement with a node as well as the current user.
TestController::__construct public function Constructs a new TestController instance.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator protected function Returns the URL generator service.
UrlGeneratorTrait::redirect protected function Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator public function Sets the URL generator service.
UrlGeneratorTrait::url protected function Generates a URL or path for a specific route based on the given parameters.