class ApiController
Provides API endpoints to interact with a stage directory in functional test.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\AutowireTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\package_manager_test_api\ApiController extends \Drupal\Core\Controller\ControllerBase
Expanded class hierarchy of ApiController
File
-
core/
modules/ package_manager/ tests/ modules/ package_manager_test_api/ src/ ApiController.php, line 25
Namespace
Drupal\package_manager_test_apiView source
class ApiController extends ControllerBase {
/**
* The route to redirect to after the stage has been applied.
*
* @var string
*/
protected $finishedRoute = 'package_manager_test_api.finish';
public function __construct(StageBase $stage) {
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
$stage = new ControllerStage($container->get(PathLocator::class), $container->get(BeginnerInterface::class), $container->get(StagerInterface::class), $container->get(CommitterInterface::class), $container->get(QueueFactory::class), $container->get('event_dispatcher'), $container->get('tempstore.shared'), $container->get('datetime.time'), $container->get(PathFactoryInterface::class), $container->get(FailureMarker::class));
return new static($stage);
}
/**
* Begins a stage life cycle.
*
* Creates a stage directory, requires packages into it, applies changes to
* the active directory.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request. The runtime and dev dependencies are expected to be in
* either the query string or request body, under the 'runtime' and 'dev'
* keys, respectively.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A response that directs to the ::finish() method.
*
* @see ::finish()
*/
public function run(Request $request) : RedirectResponse {
$id = $this->createAndApplyStage($request);
$redirect_url = Url::fromRoute($this->finishedRoute)
->setRouteParameter('id', $id)
->setAbsolute()
->toString();
return new RedirectResponse($redirect_url);
}
/**
* Performs post-apply tasks and destroys the stage.
*
* @param string $id
* The stage ID.
*
* @return \Symfony\Component\HttpFoundation\Response
* The response.
*/
public function finish(string $id) : Response {
$this->stage
->claim($id)
->postApply();
$this->stage
->destroy();
return new Response();
}
/**
* Creates a stage, requires packages into it, and applies the changes.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request. The runtime and dev dependencies are expected to be in
* either the query string or request body, under the 'runtime' and 'dev'
* keys, respectively.
*
* @return string
* Unique ID for the stage, which can be used to claim the stage before
* performing other operations on it. Calling code should store this ID for
* as long as the stage needs to exist.
*/
protected function createAndApplyStage(Request $request) : string {
$id = $this->stage
->create();
$this->stage
->require($request->get('runtime', []), $request->get('dev', []));
$this->stage
->apply();
return $id;
}
/**
* Returns the information about current PHP server used for build tests.
*
* @return \Symfony\Component\HttpFoundation\Response
* The response.
*/
public function checkSetup() : Response {
return new Response('max_execution_time=' . ini_get('max_execution_time') . ':set_time_limit-exists=' . (function_exists('set_time_limit') ? 'yes' : 'no'));
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ApiController::$finishedRoute | protected | property | The route to redirect to after the stage has been applied. | ||
ApiController::checkSetup | public | function | Returns the information about current PHP server used for build tests. | ||
ApiController::create | public static | function | Overrides AutowireTrait::create | ||
ApiController::createAndApplyStage | protected | function | Creates a stage, requires packages into it, and applies the changes. | ||
ApiController::finish | public | function | Performs post-apply tasks and destroys the stage. | ||
ApiController::run | public | function | Begins a stage life cycle. | ||
ApiController::__construct | public | function | |||
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. | ||
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 '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. | 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.