class SessionExampleController
Same name in other branches
- 4.0.x modules/session_example/src/Controller/SessionExampleController.php \Drupal\session_example\Controller\SessionExampleController
Controller for a page to display the session information.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\session_example\Controller\SessionExampleController extends \Drupal\Core\Controller\ControllerBase
Expanded class hierarchy of SessionExampleController
Related topics
File
-
modules/
session_example/ src/ Controller/ SessionExampleController.php, line 13
Namespace
Drupal\session_example\ControllerView source
class SessionExampleController extends ControllerBase {
/**
* Display the example session information.
*
* By default, controller methods receive a Request object as a parameter, so
* we can use one here.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request object.
*
* @return string
* A renderable array containing the user information from the session.
*/
public function showSession(Request $request) {
// Get the session from the request object.
$session = $request->getSession();
// Make a table of the session information.
$row = [];
foreach ([
'name',
'email',
'quest',
'color',
] as $item) {
$key = "session_example.{$item}";
// Get the session value, with a default of 'No name' etc. for each type
// of information we have.
$row[0][$item] = $session->get($key, $this->t('No @type', [
'@type' => $item,
]));
}
return [
// Since this page will be cached, we have to manage the caching. We'll
// use a cache tag and manage it within the session helper. We use the
// session ID to guarantee a unique tag per session. The submission form
// will manage invalidating this tag.
'#cache' => [
'tags' => [
'session_example:' . $session->getId(),
],
],
'description' => [
'#type' => 'item',
'#title' => $this->t('Saved Session Keys'),
'#markup' => $this->t('The example form lets you set some session keys. This page lists their current values.'),
],
'session_status' => [
'#type' => 'table',
'#header' => [
$this->t('Name'),
$this->t('Email'),
$this->t('Quest'),
$this->t('Color'),
],
'#rows' => $row,
],
];
}
}
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. | 3 | |
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::create | public static | function | Instantiates a new instance of this class. | Overrides ContainerInjectionInterface::create | 49 |
ControllerBase::currentUser | protected | function | Returns the current user. | 3 | |
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. | ||
MessengerTrait::$messenger | protected | property | The messenger. | 17 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
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. | ||
SessionExampleController::showSession | public | function | Display the example session information. | ||
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. |