class EarlyRenderingTestController

Same name and namespace in other branches
  1. 9 core/modules/system/tests/modules/early_rendering_controller_test/src/EarlyRenderingTestController.php \Drupal\early_rendering_controller_test\EarlyRenderingTestController
  2. 8.9.x core/modules/system/tests/modules/early_rendering_controller_test/src/EarlyRenderingTestController.php \Drupal\early_rendering_controller_test\EarlyRenderingTestController
  3. 10 core/modules/system/tests/modules/early_rendering_controller_test/src/EarlyRenderingTestController.php \Drupal\early_rendering_controller_test\EarlyRenderingTestController

Controller routines for early_rendering_test routes.

The methods on this controller each correspond to a route for this module, each of which exist solely for test cases in EarlyRenderingControllerTest; see that test for documentation.

Hierarchy

Expanded class hierarchy of EarlyRenderingTestController

See also

core/modules/early_rendering_controller_test/early_rendering_controller_test.routing.yml

\Drupal\system\Tests\Common\EarlyRenderingControllerTest::testEarlyRendering()

File

core/modules/system/tests/modules/early_rendering_controller_test/src/EarlyRenderingTestController.php, line 22

Namespace

Drupal\early_rendering_controller_test
View source
class EarlyRenderingTestController extends ControllerBase {
    
    /**
     * The renderer.
     *
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * Constructs an EarlyRenderingTestController.
     *
     * @param \Drupal\Core\Render\RendererInterface $renderer
     *   The renderer.
     */
    public function __construct(RendererInterface $renderer) {
        $this->renderer = $renderer;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('renderer'));
    }
    protected function earlyRenderContent() {
        return [
            '#markup' => 'Hello world!',
            '#cache' => [
                'tags' => [
                    'foo',
                ],
            ],
        ];
    }
    public function renderArray() {
        return [
            '#pre_render' => [
                function () {
                    $elements = $this->earlyRenderContent();
                    return $elements;
                },
            ],
        ];
    }
    public function renderArrayEarly() {
        $render_array = $this->earlyRenderContent();
        return [
            '#markup' => $this->renderer
                ->render($render_array),
        ];
    }
    public function ajaxResponse() {
        $response = new AjaxResponse();
        $response->addCommand(new InsertCommand(NULL, $this->renderArray()));
        return $response;
    }
    public function ajaxResponseEarly() {
        $response = new AjaxResponse();
        $response->addCommand(new InsertCommand(NULL, $this->renderArrayEarly()));
        return $response;
    }
    public function response() {
        return new Response('Hello world!');
    }
    public function responseEarly() {
        $render_array = $this->earlyRenderContent();
        return new Response($this->renderer
            ->render($render_array));
    }
    public function responseWithAttachments() {
        return new AttachmentsTestResponse('Hello world!');
    }
    public function responseWithAttachmentsEarly() {
        $render_array = $this->earlyRenderContent();
        return new AttachmentsTestResponse($this->renderer
            ->render($render_array));
    }
    public function cacheableResponse() {
        return new CacheableTestResponse('Hello world!');
    }
    public function cacheableResponseEarly() {
        $render_array = $this->earlyRenderContent();
        return new CacheableTestResponse($this->renderer
            ->render($render_array));
    }
    public function domainObject() {
        return new TestDomainObject();
    }
    public function domainObjectEarly() {
        $render_array = $this->earlyRenderContent();
        $this->renderer
            ->render($render_array);
        return new TestDomainObject();
    }
    public function domainObjectWithAttachments() {
        return new AttachmentsTestDomainObject();
    }
    public function domainObjectWithAttachmentsEarly() {
        $render_array = $this->earlyRenderContent();
        $this->renderer
            ->render($render_array);
        return new AttachmentsTestDomainObject();
    }
    public function cacheableDomainObject() {
        return new CacheableTestDomainObject();
    }
    public function cacheableDomainObjectEarly() {
        $render_array = $this->earlyRenderContent();
        $this->renderer
            ->render($render_array);
        return new CacheableTestDomainObject();
    }

}

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. 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.
EarlyRenderingTestController::$renderer protected property The renderer.
EarlyRenderingTestController::ajaxResponse public function
EarlyRenderingTestController::ajaxResponseEarly public function
EarlyRenderingTestController::cacheableDomainObject public function
EarlyRenderingTestController::cacheableDomainObjectEarly public function
EarlyRenderingTestController::cacheableResponse public function
EarlyRenderingTestController::cacheableResponseEarly public function
EarlyRenderingTestController::create public static function Instantiates a new instance of the implementing class using autowiring. Overrides AutowireTrait::create
EarlyRenderingTestController::domainObject public function
EarlyRenderingTestController::domainObjectEarly public function
EarlyRenderingTestController::domainObjectWithAttachments public function
EarlyRenderingTestController::domainObjectWithAttachmentsEarly public function
EarlyRenderingTestController::earlyRenderContent protected function
EarlyRenderingTestController::renderArray public function
EarlyRenderingTestController::renderArrayEarly public function
EarlyRenderingTestController::response public function
EarlyRenderingTestController::responseEarly public function
EarlyRenderingTestController::responseWithAttachments public function
EarlyRenderingTestController::responseWithAttachmentsEarly public function
EarlyRenderingTestController::__construct public function Constructs an EarlyRenderingTestController.
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.