class SystemTestController in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/system/tests/modules/system_test/src/Controller/SystemTestController.php \Drupal\system_test\Controller\SystemTestController
Controller routines for system_test routes.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\system_test\Controller\SystemTestController
Expanded class hierarchy of SystemTestController
File
- core/
modules/ system/ tests/ modules/ system_test/ src/ Controller/ SystemTestController.php, line 26 - Contains \Drupal\system_test\Controller\SystemTestController.
Namespace
Drupal\system_test\ControllerView source
class SystemTestController extends ControllerBase {
/**
* The lock service.
*
* @var \Drupal\Core\Lock\LockBackendInterface
*/
protected $lock;
/**
* The persistent lock service.
*
* @var \Drupal\Core\Lock\LockBackendInterface
*/
protected $persistentLock;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* Constructs the SystemTestController.
*
* @param \Drupal\Core\Lock\LockBackendInterface $lock
* The lock service.
* @param \Drupal\Core\Lock\LockBackendInterface $persistent_lock
* The persistent lock service.
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer.
*/
public function __construct(LockBackendInterface $lock, LockBackendInterface $persistent_lock, AccountInterface $current_user, RendererInterface $renderer) {
$this->lock = $lock;
$this->persistentLock = $persistent_lock;
$this->currentUser = $current_user;
$this->renderer = $renderer;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('lock'), $container
->get('lock.persistent'), $container
->get('current_user'), $container
->get('renderer'));
}
/**
* Tests main content fallback.
*
* @return string
* The text to display.
*/
public function mainContentFallback() {
return [
'#markup' => $this
->t('Content to test main content fallback'),
];
}
/**
* Tests setting messages and removing one before it is displayed.
*
* @return string
* Empty string, we just test the setting of messages.
*/
public function drupalSetMessageTest() {
// Set two messages.
drupal_set_message('First message (removed).');
drupal_set_message(t('Second message with <em>markup!</em> (not removed).'));
// Remove the first.
unset($_SESSION['messages']['status'][0]);
// Duplicate message check.
drupal_set_message('Non Duplicated message', 'status', FALSE);
drupal_set_message('Non Duplicated message', 'status', FALSE);
drupal_set_message('Duplicated message', 'status', TRUE);
drupal_set_message('Duplicated message', 'status', TRUE);
// Add a Markup message.
drupal_set_message(Markup::create('Markup with <em>markup!</em>'));
// Test duplicate Markup messages.
drupal_set_message(Markup::create('Markup with <em>markup!</em>'));
// Ensure that multiple Markup messages work.
drupal_set_message(Markup::create('Markup2 with <em>markup!</em>'));
// Test mixing of types.
drupal_set_message(Markup::create('Non duplicate Markup / string.'));
drupal_set_message('Non duplicate Markup / string.');
drupal_set_message(Markup::create('Duplicate Markup / string.'), 'status', TRUE);
drupal_set_message('Duplicate Markup / string.', 'status', TRUE);
// Test auto-escape of non safe strings.
drupal_set_message('<em>This<span>markup will be</span> escaped</em>.');
return [];
}
/**
* Controller to return $_GET['destination'] for testing.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request.
*
* @return \Symfony\Component\HttpFoundation\Response
* The response.
*/
public function getDestination(Request $request) {
$response = new Response($request->query
->get('destination'));
return $response;
}
/**
* Controller to return $_REQUEST['destination'] for testing.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request.
*
* @return \Symfony\Component\HttpFoundation\Response
* The response.
*/
public function requestDestination(Request $request) {
$response = new Response($request->request
->get('destination'));
return $response;
}
/**
* Try to acquire a named lock and report the outcome.
*/
public function lockAcquire() {
if ($this->lock
->acquire('system_test_lock_acquire')) {
$this->lock
->release('system_test_lock_acquire');
return [
'#markup' => 'TRUE: Lock successfully acquired in \\Drupal\\system_test\\Controller\\SystemTestController::lockAcquire()',
];
}
else {
return [
'#markup' => 'FALSE: Lock not acquired in \\Drupal\\system_test\\Controller\\SystemTestController::lockAcquire()',
];
}
}
/**
* Try to acquire a specific lock, and then exit.
*/
public function lockExit() {
if ($this->lock
->acquire('system_test_lock_exit', 900)) {
echo 'TRUE: Lock successfully acquired in \\Drupal\\system_test\\Controller\\SystemTestController::lockExit()';
// The shut-down function should release the lock.
exit;
}
else {
return [
'#markup' => 'FALSE: Lock not acquired in system_test_lock_exit()',
];
}
}
/**
* Creates a lock that will persist across requests.
*
* @param string $lock_name
* The name of the persistent lock to acquire.
*
* @return string
* The text to display.
*/
public function lockPersist($lock_name) {
if ($this->persistentLock
->acquire($lock_name)) {
return [
'#markup' => 'TRUE: Lock successfully acquired in SystemTestController::lockPersist()',
];
}
else {
return [
'#markup' => 'FALSE: Lock not acquired in SystemTestController::lockPersist()',
];
}
}
/**
* Set cache tag on on the returned render array.
*/
public function system_test_cache_tags_page() {
$build['main'] = array(
'#cache' => array(
'tags' => array(
'system_test_cache_tags_page',
),
),
'#pre_render' => array(
'\\Drupal\\system_test\\Controller\\SystemTestController::preRenderCacheTags',
),
'message' => array(
'#markup' => 'Cache tags page example',
),
);
return $build;
}
/**
* Set cache max-age on the returned render array.
*/
public function system_test_cache_maxage_page() {
$build['main'] = array(
'#cache' => array(
'max-age' => 90,
),
'message' => array(
'#markup' => 'Cache max-age page example',
),
);
return $build;
}
/**
* Sets a cache tag on an element to help test #pre_render and cache tags.
*/
public static function preRenderCacheTags($elements) {
$elements['#cache']['tags'][] = 'pre_render';
return $elements;
}
/**
* Initialize authorize.php during testing.
*
* @see system_authorized_init().
*/
public function authorizeInit($page_title) {
$authorize_url = Url::fromUri('base:core/authorize.php', array(
'absolute' => TRUE,
))
->toString();
system_authorized_init('system_test_authorize_run', drupal_get_path('module', 'system_test') . '/system_test.module', array(), $page_title);
return new RedirectResponse($authorize_url);
}
/**
* Sets a header.
*/
public function setHeader(Request $request) {
$query = $request->query
->all();
$response = new CacheableResponse();
$response->headers
->set($query['name'], $query['value']);
$response
->getCacheableMetadata()
->addCacheContexts([
'url.query_args:name',
'url.query_args:value',
]);
$response
->setContent($this
->t('The following header was set: %name: %value', array(
'%name' => $query['name'],
'%value' => $query['value'],
)));
return $response;
}
/**
* A simple page callback that uses a plain Symfony response object.
*/
public function respondWithReponse(Request $request) {
return new Response('test');
}
/**
* A plain Symfony reponse with Cache-Control: public, max-age=60.
*/
public function respondWithPublicResponse() {
return (new Response('test'))
->setPublic()
->setMaxAge(60);
}
/**
* A simple page callback that uses a CacheableResponse object.
*/
public function respondWithCacheableReponse(Request $request) {
return new CacheableResponse('test');
}
/**
* A simple page callback which adds a register shutdown function.
*/
public function shutdownFunctions($arg1, $arg2) {
drupal_register_shutdown_function('_system_test_first_shutdown_function', $arg1, $arg2);
// If using PHP-FPM then fastcgi_finish_request() will have been fired
// preventing further output to the browser which means that the escaping of
// the exception message can not be tested.
// @see _drupal_shutdown_function()
// @see \Drupal\system\Tests\System\ShutdownFunctionsTest
if (function_exists('fastcgi_finish_request')) {
return [
'#markup' => 'The function fastcgi_finish_request exists when serving the request.',
];
}
return [];
}
/**
* Returns the title for system_test.info.yml's configure route.
*
* @param string $foo
* Any string for the {foo} slug.
*
* @return string
*/
public function configureTitle($foo) {
return 'Bar.' . $foo;
}
/**
* Shows permission-dependent content.
*
* @return array
* A render array.
*/
public function permissionDependentContent() {
$build = [];
// The content depends on the access result.
$access = AccessResult::allowedIfHasPermission($this->currentUser, 'pet llamas');
$this->renderer
->addCacheableDependency($build, $access);
// Build the content.
if ($access
->isAllowed()) {
$build['allowed'] = [
'#markup' => 'Permission to pet llamas: yes!',
];
}
else {
$build['forbidden'] = [
'#markup' => 'Permission to pet llamas: no!',
];
}
return $build;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity manager. | 1 |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 3 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity manager service. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 3 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function | Returns the state storage service. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
SystemTestController:: |
protected | property |
The current user. Overrides ControllerBase:: |
|
SystemTestController:: |
protected | property | The lock service. | |
SystemTestController:: |
protected | property | The persistent lock service. | |
SystemTestController:: |
protected | property | The renderer. | |
SystemTestController:: |
public | function | Initialize authorize.php during testing. | |
SystemTestController:: |
public | function | Returns the title for system_test.info.yml's configure route. | |
SystemTestController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
SystemTestController:: |
public | function | Tests setting messages and removing one before it is displayed. | |
SystemTestController:: |
public | function | Controller to return $_GET['destination'] for testing. | |
SystemTestController:: |
public | function | Try to acquire a named lock and report the outcome. | |
SystemTestController:: |
public | function | Try to acquire a specific lock, and then exit. | |
SystemTestController:: |
public | function | Creates a lock that will persist across requests. | |
SystemTestController:: |
public | function | Tests main content fallback. | |
SystemTestController:: |
public | function | Shows permission-dependent content. | |
SystemTestController:: |
public static | function | Sets a cache tag on an element to help test #pre_render and cache tags. | |
SystemTestController:: |
public | function | Controller to return $_REQUEST['destination'] for testing. | |
SystemTestController:: |
public | function | A simple page callback that uses a CacheableResponse object. | |
SystemTestController:: |
public | function | A plain Symfony reponse with Cache-Control: public, max-age=60. | |
SystemTestController:: |
public | function | A simple page callback that uses a plain Symfony response object. | |
SystemTestController:: |
public | function | Sets a header. | |
SystemTestController:: |
public | function | A simple page callback which adds a register shutdown function. | |
SystemTestController:: |
public | function | Set cache max-age on the returned render array. | |
SystemTestController:: |
public | function | Set cache tag on on the returned render array. | |
SystemTestController:: |
public | function | Constructs the SystemTestController. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Returns a redirect response object for the specified route. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |