You are here

Home » API reference » Zircon Profile 8.0 » ThemeTestController.php

class ThemeTestController in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/modules/system/tests/modules/theme_test/src/ThemeTestController.php \Drupal\theme_test\ThemeTestController

Controller routines for theme test routes.

Hierarchy

Expanded class hierarchy of ThemeTestController

File

core/modules/system/tests/modules/theme_test/src/ThemeTestController.php, line 16
Contains \Drupal\theme_test\ThemeTestController.

Namespace

Drupal\theme_test
View source 
class ThemeTestController extends ControllerBase {

  /**
   * A theme template that overrides a theme function.
   *
   * @return array
   *   Render array containing a theme.
   */
  public function functionTemplateOverridden() {
    return array(
      '#theme' => 'theme_test_function_template_override',
    );
  }

  /**
   * Adds stylesheets to test theme .info.yml property processing.
   *
   * @return array
   *   A render array containing custom stylesheets.
   */
  public function testInfoStylesheets() {
    return array(
      '#attached' => array(
        'library' => array(
          'theme_test/theme_stylesheets_override_and_remove_test',
        ),
      ),
    );
  }

  /**
   * Tests template overriding based on filename.
   *
   * @return array
   *   A render array containing a theme override.
   */
  public function testTemplate() {
    return [
      '#markup' => \Drupal::theme()
        ->render('theme_test_template_test', array()),
    ];
  }

  /**
   * Tests the inline template functionality.
   *
   * @return array
   *   A render array containing an inline template.
   */
  public function testInlineTemplate() {
    $element = array();
    $element['test'] = array(
      '#type' => 'inline_template',
      '#template' => 'test-with-context {{ llama }}',
      '#context' => array(
        'llama' => 'muuh',
      ),
    );
    return $element;
  }

  /**
   * Calls a theme hook suggestion.
   *
   * @return string
   *   An HTML string containing the themed output.
   */
  public function testSuggestion() {
    return [
      '#markup' => \Drupal::theme()
        ->render(array(
        'theme_test__suggestion',
        'theme_test',
      ), array()),
    ];
  }

  /**
   * Tests themed output generated in a request listener.
   *
   * @return string
   *   Content in theme_test_output GLOBAL.
   */
  public function testRequestListener() {
    return [
      '#markup' => $GLOBALS['theme_test_output'],
    ];
  }

  /**
   * Menu callback for testing suggestion alter hooks with template files.
   */
  function suggestionProvided() {
    return array(
      '#theme' => 'theme_test_suggestion_provided',
    );
  }

  /**
   * Menu callback for testing suggestion alter hooks with template files.
   */
  function suggestionAlter() {
    return array(
      '#theme' => 'theme_test_suggestions',
    );
  }

  /**
   * Menu callback for testing hook_theme_suggestions_alter().
   */
  function generalSuggestionAlter() {
    return array(
      '#theme' => 'theme_test_general_suggestions',
    );
  }

  /**
   * Menu callback for testing suggestion alter hooks with specific suggestions.
   */
  function specificSuggestionAlter() {
    return array(
      '#theme' => 'theme_test_specific_suggestions__variant',
    );
  }

  /**
   * Menu callback for testing suggestion alter hooks with theme functions.
   */
  function functionSuggestionAlter() {
    return array(
      '#theme' => 'theme_test_function_suggestions',
    );
  }

  /**
   * Menu callback for testing includes with suggestion alter hooks.
   */
  function suggestionAlterInclude() {
    return array(
      '#theme' => 'theme_test_suggestions_include',
    );
  }

  /**
   * Controller to ensure that no theme is initialized.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The json response with the theme initialized information.
   */
  public function nonHtml() {
    $theme_initialized = \Drupal::theme()
      ->hasActiveTheme();
    return new JsonResponse([
      'theme_initialized' => $theme_initialized,
    ]);
  }

  /**
   * Controller for testing preprocess functions with theme suggestions.
   */
  public function preprocessSuggestions() {
    return [
      [
        '#theme' => 'theme_test_preprocess_suggestions',
        '#foo' => 'suggestion',
      ],
      [
        '#theme' => 'theme_test_preprocess_suggestions',
        '#foo' => 'kitten',
      ],
      [
        '#theme' => 'theme_test_preprocess_suggestions',
        '#foo' => 'monkey',
      ],
      [
        '#theme' => 'theme_test_preprocess_suggestions__kitten__flamingo',
      ],
    ];
  }

}

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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 42
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.
ThemeTestController::functionSuggestionAlter function Menu callback for testing suggestion alter hooks with theme functions.
ThemeTestController::functionTemplateOverridden public function A theme template that overrides a theme function.
ThemeTestController::generalSuggestionAlter function Menu callback for testing hook_theme_suggestions_alter().
ThemeTestController::nonHtml public function Controller to ensure that no theme is initialized.
ThemeTestController::preprocessSuggestions public function Controller for testing preprocess functions with theme suggestions.
ThemeTestController::specificSuggestionAlter function Menu callback for testing suggestion alter hooks with specific suggestions.
ThemeTestController::suggestionAlter function Menu callback for testing suggestion alter hooks with template files.
ThemeTestController::suggestionAlterInclude function Menu callback for testing includes with suggestion alter hooks.
ThemeTestController::suggestionProvided function Menu callback for testing suggestion alter hooks with template files.
ThemeTestController::testInfoStylesheets public function Adds stylesheets to test theme .info.yml property processing.
ThemeTestController::testInlineTemplate public function Tests the inline template functionality.
ThemeTestController::testRequestListener public function Tests themed output generated in a request listener.
ThemeTestController::testSuggestion public function Calls a theme hook suggestion.
ThemeTestController::testTemplate public function Tests template overriding based on filename.
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.