class MenuTestController

Same name in other branches
  1. 9 core/modules/system/tests/modules/menu_test/src/Controller/MenuTestController.php \Drupal\menu_test\Controller\MenuTestController
  2. 8.9.x core/modules/system/tests/modules/menu_test/src/Controller/MenuTestController.php \Drupal\menu_test\Controller\MenuTestController
  3. 11.x core/modules/system/tests/modules/menu_test/src/Controller/MenuTestController.php \Drupal\menu_test\Controller\MenuTestController

Controller routines for menu_test routes.

Hierarchy

Expanded class hierarchy of MenuTestController

File

core/modules/system/tests/modules/menu_test/src/Controller/MenuTestController.php, line 14

Namespace

Drupal\menu_test\Controller
View source
class MenuTestController extends ControllerBase {
    
    /**
     * The theme manager.
     *
     * @var \Drupal\Core\Theme\ThemeManagerInterface
     */
    protected $themeManager;
    
    /**
     * The theme negotiator.
     *
     * @var \Drupal\Core\Theme\ThemeNegotiatorInterface
     */
    protected $themeNegotiator;
    
    /**
     * The active route match.
     *
     * @var \Drupal\Core\Routing\RouteMatchInterface
     */
    protected $routeMatch;
    
    /**
     * Constructs the MenuTestController object.
     *
     * @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
     *   The theme manager.
     * @param \Drupal\Core\Theme\ThemeNegotiatorInterface $theme_negotiator
     *   The theme negotiator.
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The current route match.
     */
    public function __construct(ThemeManagerInterface $theme_manager, ThemeNegotiatorInterface $theme_negotiator, RouteMatchInterface $route_match) {
        $this->themeManager = $theme_manager;
        $this->themeNegotiator = $theme_negotiator;
        $this->routeMatch = $route_match;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('theme.manager'), $container->get('theme.negotiator'), $container->get('current_route_match'));
    }
    
    /**
     * Some known placeholder content which can be used for testing.
     *
     * @return string
     *   A string that can be used for comparison.
     */
    public function menuTestCallback() {
        return [
            '#markup' => 'This is the menuTestCallback content.',
        ];
    }
    
    /**
     * A title callback method for test routes.
     *
     * @param array $_title_arguments
     *   Optional array from the route defaults.
     * @param string $_title
     *   Optional _title string from the route defaults.
     *
     * @return string
     *   The route title.
     */
    public function titleCallback(array $_title_arguments = [], $_title = '') {
        $_title_arguments += [
            'case_number' => '2',
            'title' => $_title,
        ];
        return t($_title_arguments['title']) . ' - Case ' . $_title_arguments['case_number'];
    }
    
    /**
     * Page callback: Tests the theme negotiation functionality.
     *
     * @param bool $inherited
     *   TRUE when the requested page is intended to inherit
     *   the theme of its parent.
     *
     * @return string
     *   A string describing the requested custom theme and actual
     *   theme being used
     *   for the current page request.
     */
    public function themePage($inherited) {
        $theme_key = $this->themeManager
            ->getActiveTheme()
            ->getName();
        // Now we check what the theme negotiator service returns.
        $active_theme = $this->themeNegotiator
            ->determineActiveTheme($this->routeMatch);
        $output = "Active theme: {$active_theme}. Actual theme: {$theme_key}.";
        if ($inherited) {
            $output .= ' Theme negotiation inheritance is being tested.';
        }
        return [
            '#markup' => $output,
        ];
    }
    
    /**
     * A title callback for XSS breadcrumb check.
     *
     * @return string
     */
    public function breadcrumbTitleCallback() {
        return '<script>alert(123);</script>';
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 2
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
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. 2
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
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. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage 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.
MenuTestController::$routeMatch protected property The active route match.
MenuTestController::$themeManager protected property The theme manager.
MenuTestController::$themeNegotiator protected property The theme negotiator.
MenuTestController::breadcrumbTitleCallback public function A title callback for XSS breadcrumb check.
MenuTestController::create public static function Instantiates a new instance of the implementing class using autowiring. Overrides AutowireTrait::create
MenuTestController::menuTestCallback public function Some known placeholder content which can be used for testing.
MenuTestController::themePage public function Page callback: Tests the theme negotiation functionality.
MenuTestController::titleCallback public function A title callback method for test routes.
MenuTestController::__construct public function Constructs the MenuTestController object.
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.