class FrontController in Subrequests 8

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\subrequests\Controller\FrontController

File

src/Controller/FrontController.php, line 14

Namespace

Drupal\subrequests\Controller

class FrontController extends ControllerBase {

  /**
   * @var \Drupal\subrequests\Blueprint\Parser
   */
  protected $parser;

  /**
   * @var \Symfony\Component\HttpKernel\HttpKernelInterface
   */
  protected $httpKernel;

  /**
   * FrontController constructor.
   */
  public function __construct(Parser $parser, HttpKernelInterface $http_kernel) {
    $this->parser = $parser;
    $this->httpKernel = $http_kernel;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('subrequests.blueprint_parser'), $container
      ->get('http_kernel'));
  }

  /**
   * Controller handler.
   */
  public function handle(Request $request) {
    $this->parser
      ->parseRequest($request);
    $responses = [];

    /** @var \Drupal\subrequests\Blueprint\RequestTree $tree */
    $root_tree = $request->attributes
      ->get(RequestTree::SUBREQUEST_TREE);
    $trees = [
      $root_tree,
    ];

    // Handle all the sub-requests.
    while (!$root_tree
      ->isDone()) {

      // Requests in the current level may have references to older responses.
      // This step resolves those.
      array_walk($trees, function (RequestTree $tree) use ($responses) {
        $tree
          ->dereference($responses);
      });

      // Get all the requests in the trees for the previous pass.
      $requests = array_reduce($trees, function (array $carry, RequestTree $tree) {
        return array_merge($carry, $tree
          ->getRequests());
      }, []);

      // Get the next batch of trees for the next level.
      $trees = array_reduce($trees, function (array $carry, RequestTree $tree) {
        return array_merge($carry, $tree
          ->getSubTrees());
      }, []);

      // Handle the requests for the trees at this level and gather the
      // responses.
      $level_responses = array_map(function (Request $request) {
        $response = $this->httpKernel
          ->handle($request, HttpKernelInterface::MASTER_REQUEST);

        // Manually mark the request as done. We cannot use a response
        // subscriber, since it may not fire if the subrequest is cached by
        // PageCache.
        $request->attributes
          ->set(RequestTree::SUBREQUEST_DONE, TRUE);
        $id = $request->headers
          ->get('Content-ID');
        $response->headers
          ->set('Content-ID', $id);
        return $response;
      }, $requests);
      $responses = array_merge($responses, $level_responses);
    }
    return $this->parser
      ->combineResponses($responses);
  }

}

Members

Name	Modifiers	Type	Description	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::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.
FrontController::$httpKernel	protected	property
FrontController::$parser	protected	property
FrontController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
FrontController::handle	public	function	Controller handler.
FrontController::__construct	public	function	FrontController constructor.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	1
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.
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.