You are here

Home » API reference » Decoupled Blocks: Vue.js 8 » VueForm.php

class VueForm in Decoupled Blocks: Vue.js 8

Class VueForm.

@package Drupal\pdb_vue\Form

Hierarchy

Expanded class hierarchy of VueForm

1 file declares its use of VueForm
VueFormTest.php in tests/src/Unit/Form/VueFormTest.php
1 string reference to 'VueForm'
pdb_vue.routing.yml in ./pdb_vue.routing.yml
pdb_vue.routing.yml

File

src/Form/VueForm.php, line 13

Namespace

Drupal\pdb_vue\Form
View source 
class VueForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'pdb_vue.settings',
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('pdb_vue.settings');
    $form['version'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Choose the version of Vue'),
      '#options' => [
        'vue3' => $this
          ->t('Vue 3'),
        'vue2' => $this
          ->t('Vue 2'),
      ],
      '#default_value' => $config
        ->get('version'),
    ];
    $form['development_mode'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Development Mode'),
      '#description' => $this
        ->t('Checking the box enables development mode'),
      '#default_value' => $config
        ->get('development_mode'),
    ];
    $form['use_spa'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use Vue components in a Single Page App format.'),
      '#description' => $this
        ->t('Checking the box will initialize a Vue instance on a root element to overtake the entire page allowing each block to be a <a href="https://v3.vuejs.org/guide/component-basics.html#components-basics">Vue Components</a>.'),
      '#default_value' => $config
        ->get('use_spa'),
    ];
    $form['spa_element'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('App Element Selector'),
      '#description' => $this
        ->t('Set the element that the Vue instance will be attached to. By default it will use the Classy theme\'s wrapping element "#page-wrapper".'),
      '#default_value' => $config
        ->get('spa_element') ? $config
        ->get('spa_element') : '#page-wrapper',
      '#states' => [
        // Only show this field when the use_spa checkbox is checked.
        'visible' => [
          ':input[name="use_spa"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // Get the config object.
    $config = $this
      ->configFactory()
      ->getEditable('pdb_vue.settings');

    // Set the values the user submitted in the form.
    $config
      ->set('version', $form_state
      ->getValue('version'));
    $config
      ->set('development_mode', $form_state
      ->getValue('development_mode'));
    $config
      ->set('use_spa', $form_state
      ->getValue('use_spa'));
    $config
      ->set('spa_element', $form_state
      ->getValue('spa_element'));
    $config
      ->save();

    // Clear caches so that it will pick up the changes to vue library.
    $this
      ->flushCaches();
  }

  /**
   * Clear all caches.
   */
  public function flushCaches() {
    drupal_flush_all_caches();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::configFactory protected function Gets the config factory for this form. 1
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. 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
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.
VueForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
VueForm::flushCaches public function Clear all caches.
VueForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
VueForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
VueForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm