class UpdateTestController
Same name in other branches
- 9 core/modules/update/tests/modules/update_test/src/Controller/UpdateTestController.php \Drupal\update_test\Controller\UpdateTestController
- 10 core/modules/update/tests/modules/update_test/src/Controller/UpdateTestController.php \Drupal\update_test\Controller\UpdateTestController
- 11.x core/modules/update/tests/modules/update_test/src/Controller/UpdateTestController.php \Drupal\update_test\Controller\UpdateTestController
Provides different routes of the update_test module.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\Routing\LinkGeneratorTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\Routing\UrlGeneratorTrait
- class \Drupal\update_test\Controller\UpdateTestController extends \Drupal\Core\Controller\ControllerBase
Expanded class hierarchy of UpdateTestController
File
-
core/
modules/ update/ tests/ modules/ update_test/ src/ Controller/ UpdateTestController.php, line 12
Namespace
Drupal\update_test\ControllerView source
class UpdateTestController extends ControllerBase {
/**
* Displays an Error 503 (Service unavailable) page.
*
* @return \Symfony\Component\HttpFoundation\Response
* Returns the response with a special header.
*/
public function updateError() {
$response = new Response();
$response->setStatusCode(503);
$response->headers
->set('Status', '503 Service unavailable');
return $response;
}
/**
* Page callback: Prints mock XML for the Update Manager module.
*
* The specific XML file to print depends on two things: the project we're
* trying to fetch data for, and the desired "availability scenario" for that
* project which we're trying to test. Before attempting to fetch this data (by
* checking for updates on the available updates report), callers need to define
* the 'update_test_xml_map' variable as an array, keyed by project name,
* indicating which availability scenario to use for that project.
*
* @param string $project_name
* The project short name the update manager is trying to fetch data for (the
* fetch URLs are of the form: [base_url]/[project_name]/[core_version]).
* @param string $version
* The version of Drupal core.
*
* @return \Symfony\Component\HttpFoundation\BinaryFileResponse|Response
* A BinaryFileResponse object containing the content of the XML release file
* for the specified project if one is available; a Response object with no
* content otherwise.
*/
public function updateTest($project_name, $version) {
$xml_map = $this->config('update_test.settings')
->get('xml_map');
if (isset($xml_map[$project_name])) {
$availability_scenario = $xml_map[$project_name];
}
elseif (isset($xml_map['#all'])) {
$availability_scenario = $xml_map['#all'];
}
else {
// The test didn't specify (for example, the webroot has other modules and
// themes installed but they're disabled by the version of the site
// running the test. So, we default to a file we know won't exist, so at
// least we'll get an empty xml response instead of a bunch of Drupal page
// output.
$availability_scenario = '#broken#';
}
$file = __DIR__ . "/../../../../fixtures/release-history/{$project_name}.{$availability_scenario}.xml";
$headers = [
'Content-Type' => 'text/xml; charset=utf-8',
];
if (!is_file($file)) {
// Return an empty response.
return new Response('', 200, $headers);
}
return new BinaryFileResponse($file, 200, $headers);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | 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. | |||
ControllerBase::$entityTypeManager | protected | property | The entity type manager. | |||
ControllerBase::$formBuilder | protected | property | The form builder. | 2 | ||
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 | 46 | |
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. | ||
ControllerBase::entityTypeManager | protected | function | Retrieves the entity type manager. | |||
ControllerBase::formBuilder | protected | function | Returns the form builder service. | 2 | ||
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::redirect | protected | function | Returns a redirect response object for the specified route. | Overrides UrlGeneratorTrait::redirect | ||
ControllerBase::state | protected | function | Returns the state storage service. | |||
LinkGeneratorTrait::$linkGenerator | protected | property | The link generator. | 1 | ||
LinkGeneratorTrait::getLinkGenerator | Deprecated | protected | function | Returns the link generator. | ||
LinkGeneratorTrait::l | Deprecated | protected | function | Renders a link to a route given a route name and its parameters. | ||
LinkGeneratorTrait::setLinkGenerator | Deprecated | public | function | Sets the link generator 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. | |||
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. | |||
UpdateTestController::updateError | public | function | Displays an Error 503 (Service unavailable) page. | |||
UpdateTestController::updateTest | public | function | Page callback: Prints mock XML for the Update Manager module. | |||
UrlGeneratorTrait::$urlGenerator | protected | property | The url generator. | |||
UrlGeneratorTrait::getUrlGenerator | Deprecated | protected | function | Returns the URL generator service. | ||
UrlGeneratorTrait::setUrlGenerator | Deprecated | public | function | Sets the URL generator service. | ||
UrlGeneratorTrait::url | Deprecated | protected | function | Generates a URL or path for a specific route based on the given parameters. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.