You are here

Home » API reference » JS Callback Handler 8.3 » JsCallbackExamplesForm.php

class JsCallbackExamplesForm in JS Callback Handler 8.3

JsCallbackExamplesForm.

Hierarchy

Expanded class hierarchy of JsCallbackExamplesForm

1 string reference to 'JsCallbackExamplesForm'
js_callback_examples.routing.yml in js_callback_examples/js_callback_examples.routing.yml
js_callback_examples/js_callback_examples.routing.yml

File

js_callback_examples/src/Form/JsCallbackExamplesForm.php, line 19
Contains \Drupal\js_callback_examples\Form\JsCallbackExamplesForm.

Namespace

Drupal\js_callback_examples\Form
View source 
class JsCallbackExamplesForm extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'js_callback_examples_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#attached']['library'][] = 'js_callback_examples/js_callback_examples';
    $form['intro'] = [
      '#markup' => t('<p>This example page will show you examples on how each of these callbacks work using the JS module API.</p>'),
    ];
    $user = User::load(\Drupal::currentUser()
      ->id());
    $submit = [
      '#type' => 'submit',
      '#value' => t('Send')
        ->render(),
      '#js_callback' => 'js_callback_examples.email',
      '#attributes' => [
        'data-user' => $user
          ->id(),
      ],
    ];
    $submit_code = $submit;
    $description = t('Use <code>#js_callback</code> on elements (like this submit button) to automatically generate the necessary data attributes. Its value should be the identifier of a valid @JsCallback plugin.');
    $description .= '<pre><code>' . trim(htmlentities(var_export($submit_code, TRUE))) . '</code></pre>';
    $description .= '<pre><code>' . trim(htmlentities(preg_replace('/<!--(.*)-->/Uis', '', render($submit_code)))) . '</code></pre>';
    $form['get_uid'] = [
      '#type' => 'fieldset',
      '#title' => t('Get UID (using #js_callback and $.fn.jsCallback())'),
      '#description' => $description,
      '#attributes' => [
        'data-js-type' => 'callback',
      ],
    ];
    $form['get_uid']['email'] = [
      '#type' => 'entity_autocomplete',
      '#title' => $this
        ->t('Users'),
      '#target_type' => 'user',
      '#default_value' => $user,
    ];
    $form['get_uid']['actions'] = [
      '#type' => 'actions',
    ];
    $form['get_uid']['actions']['submit'] = $submit;
    $form['get_uid']['results'] = [
      '#type' => 'fieldset',
      '#title' => t('Results'),
      '#attributes' => [
        'class' => [
          'results',
        ],
      ],
      '#value' => '<pre><code></code></pre>',
      // Needs high weight so it appears after actions.
      '#weight' => 1000,
    ];
    $items[] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Node 2'),
      '#url' => Node::load(2)
        ->toUrl(),
      '#js_get' => TRUE,
    ];
    $items[] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Access Denied'),
      '#url' => Url::fromRoute('js_callback_examples.access_denied'),
      '#js_get' => TRUE,
    ];
    $items[] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Redirect'),
      '#url' => Url::fromRoute('js_callback_examples.redirect'),
      '#js_get' => TRUE,
    ];
    $items[] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Admin'),
      '#url' => Url::fromRoute('system.admin'),
      '#js_get' => Url::fromRoute('system.admin'),
    ];
    $items[] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Front Page'),
      '#url' => Url::fromRoute('<front>'),
      '#js_get' => TRUE,
    ];
    $form['using_js_get'] = [
      '#type' => 'fieldset',
      '#title' => t('Using $.jsGet()'),
      '#description' => t('Click the links below to see the results.'),
      '#attributes' => [
        'data-js-type' => 'get',
      ],
      'links' => [
        '#theme' => 'item_list',
        '#items' => $items,
      ],
      'results' => [
        '#type' => 'fieldset',
        '#title' => t('Results'),
        '#attributes' => [
          'class' => [
            'results',
          ],
        ],
        '#value' => '<pre><code></code></pre>',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Intentionally left empty.
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
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. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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. Overrides UrlGeneratorTrait::redirect
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 62
JsCallbackExamplesForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
JsCallbackExamplesForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
JsCallbackExamplesForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.