class HtmxTestAttachmentsController

Returns responses for HTMX Test Attachments routes.

Hierarchy

Expanded class hierarchy of HtmxTestAttachmentsController

1 file declares its use of HtmxTestAttachmentsController
HtmxTestAjaxForm.php in core/modules/system/tests/modules/test_htmx/src/Form/HtmxTestAjaxForm.php

File

core/modules/system/tests/modules/test_htmx/src/Controller/HtmxTestAttachmentsController.php, line 13

Namespace

Drupal\test_htmx\Controller
View source 
final class HtmxTestAttachmentsController extends ControllerBase {
    
    /**
     * Builds the response.
     *
     * @return mixed[]
     *   A render array.
     */
    public function page() : array {
        return self::generateHtmxButton();
    }
    
    /**
     * Builds the HTMX response.
     *
     * @return mixed[]
     *   A render array.
     */
    public function replace() : array {
        $build['content'] = [
            '#type' => 'container',
            '#attached' => [
                'library' => [
                    'test_htmx/assets',
                ],
            ],
            '#attributes' => [
                'class' => [
                    'ajax-content',
                ],
            ],
            'example' => [
                '#markup' => 'Initial Content',
            ],
        ];
        return $build;
    }
    
    /**
     * Static helper to for reusable render array.
     *
     * @return array
     *   The render array.
     */
    public static function generateHtmxButton() : array {
        $url = Url::fromRoute('test_htmx.attachments.replace');
        $build['replace'] = [
            '#type' => 'html_tag',
            '#tag' => 'button',
            '#attributes' => [
                'type' => 'button',
                'name' => 'replace',
                'data-hx-get' => $url->toString(),
                'data-hx-select' => 'div.ajax-content',
                'data-hx-target' => '[data-drupal-htmx-target]',
            ],
            '#value' => 'Click this',
            '#attached' => [
                'library' => [
                    'core/drupal.htmx',
                ],
            ],
        ];
        $build['content'] = [
            '#type' => 'container',
            '#attributes' => [
                'data-drupal-htmx-target' => TRUE,
                'class' => [
                    'htmx-test-container',
                ],
            ],
        ];
        return $build;
    }

}

Members

Title Modifiers Object type Summary Overrides
AutowireTrait::create public static function Instantiates a new instance of the implementing class using autowiring. 33
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.
HtmxTestAttachmentsController::generateHtmxButton public static function Static helper to for reusable render array.
HtmxTestAttachmentsController::page public function Builds the response.
HtmxTestAttachmentsController::replace public function Builds the HTMX response.
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. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.