class AjaxCssForm

Same name in other branches
  1. 8.9.x core/modules/ckeditor/tests/modules/src/Form/AjaxCssForm.php \Drupal\ckeditor_test\Form\AjaxCssForm

A form for testing delivery of CSS to CKEditor via AJAX.

@internal

Hierarchy

Expanded class hierarchy of AjaxCssForm

1 string reference to 'AjaxCssForm'
ckeditor_test.routing.yml in core/modules/ckeditor/tests/modules/ckeditor_test.routing.yml
core/modules/ckeditor/tests/modules/ckeditor_test.routing.yml

File

core/modules/ckeditor/tests/modules/src/Form/AjaxCssForm.php, line 17

Namespace

Drupal\ckeditor_test\Form
View source
class AjaxCssForm extends FormBase {
    
    /**
     * The file URL generator.
     *
     * @var \Drupal\Core\File\FileUrlGeneratorInterface
     */
    protected $fileUrlGenerator;
    
    /**
     * Constructs an AjaxCssForm.
     *
     * @param \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator
     *   The file URL generator.
     */
    public function __construct(FileUrlGeneratorInterface $file_url_generator) {
        $this->fileUrlGenerator = $file_url_generator;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('file_url_generator'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'ckeditor_test_ajax_css_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        // Create an inline and iframe CKEditor instance so we can test against
        // both.
        $form['inline'] = [
            '#type' => 'container',
            '#attached' => [
                'library' => [
                    'ckeditor_test/ajax_css',
                ],
            ],
            '#children' => $this->t('Here be dragons.'),
        ];
        $form['iframe'] = [
            '#type' => 'text_format',
            '#default_value' => $this->t('Here be llamas.'),
        ];
        // A pair of buttons to trigger the AJAX events.
        $form['actions'] = [
            'css_inline' => [
                '#type' => 'submit',
                '#value' => $this->t('Add CSS to inline CKEditor instance'),
                '#ajax' => [
                    'callback' => [
                        $this,
                        'addCssInline',
                    ],
                ],
            ],
            'css_frame' => [
                '#type' => 'submit',
                '#value' => $this->t('Add CSS to iframe CKEditor instance'),
                '#ajax' => [
                    'callback' => [
                        $this,
                        'addCssIframe',
                    ],
                ],
            ],
            '#type' => 'actions',
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        // Nothing to do here.
    }
    
    /**
     * Generates an AJAX response to add CSS to a CKEditor Text Editor instance.
     *
     * @param string $editor_id
     *   The Text Editor instance ID.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   An AJAX response.
     */
    protected function generateResponse($editor_id) {
        // Build a URL to the style sheet that will be added.
        $url = \Drupal::service('extension.list.module')->getPath('ckeditor_test') . '/css/test.css';
        $url = $this->fileUrlGenerator
            ->generateString($url);
        $response = new AjaxResponse();
        return $response->addCommand(new AddStyleSheetCommand($editor_id, [
            $url,
        ]));
    }
    
    /**
     * Handles the AJAX request to add CSS to the inline editor.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   An AJAX response.
     */
    public function addCssInline() {
        return $this->generateResponse('edit-inline');
    }
    
    /**
     * Handles the AJAX request to add CSS to the iframe editor.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   An AJAX response.
     */
    public function addCssIframe() {
        return $this->generateResponse('edit-iframe-value');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AjaxCssForm::$fileUrlGenerator protected property The file URL generator.
AjaxCssForm::addCssIframe public function Handles the AJAX request to add CSS to the iframe editor.
AjaxCssForm::addCssInline public function Handles the AJAX request to add CSS to the inline editor.
AjaxCssForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AjaxCssForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
AjaxCssForm::generateResponse protected function Generates an AJAX response to add CSS to a CKEditor Text Editor instance.
AjaxCssForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AjaxCssForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AjaxCssForm::__construct public function Constructs an AjaxCssForm.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 73
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. 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.