You are here

Home » API reference » Node.js integration 8 » NodejsConfigForm.php

class NodejsConfigForm in Node.js integration 8

Configure node.js integration.

Hierarchy

Expanded class hierarchy of NodejsConfigForm

1 string reference to 'NodejsConfigForm'
nodejs.routing.yml in ./nodejs.routing.yml
nodejs.routing.yml

File

src/Form/NodejsConfigForm.php, line 12

Namespace

Drupal\nodejs\Form
View source 
class NodejsConfigForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'nodejs_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this->configFactory
      ->get('nodejs.config');
    $form['server'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Node.js Drupal settings'),
    );
    $form['server']['scheme'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Drupal to Node.js server protocol'),
      '#default_value' => $config
        ->get('nodejs.scheme'),
      '#options' => array(
        'http' => t('http'),
        'https' => t('https'),
      ),
      '#description' => $this
        ->t('The protocol used to communicate with the Node.js server from Drupal PHP code.'),
    );
    $form['server']['host'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Node.js server host'),
      '#default_value' => $config
        ->get('nodejs.host'),
      '#size' => 40,
      '#required' => TRUE,
      '#description' => $this
        ->t('The hostname of the Node.js server.'),
    );
    $form['server']['port'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Node.js server port'),
      '#default_value' => $config
        ->get('nodejs.port'),
      '#size' => 10,
      '#required' => TRUE,
      '#description' => $this
        ->t('The port of the Node.js server.'),
    );
    $form['server']['service_key'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Service Key'),
      '#required' => TRUE,
      '#description' => $this
        ->t('An arbitrary string used as a secret between the node.js server and the Drupal site. This setting needs to match the Node.js server configuration.'),
      '#default_value' => $config
        ->get('service_key'),
    );
    $description = $this
      ->t("Enter one page per line as Drupal paths. The '*' character is a wildcard.\n                      Example paths are %blog for the blog page and %blog-wildcard for every personal blog.\n                      %front is the front page.", array(
      '%blog' => '/blog',
      '%blog-wildcard' => '/blog/*',
      '%front' => '<front>',
    ));
    $form['server']['pages'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Pages on which to enable nodejs'),
      '#default_value' => $config
        ->get('pages'),
      '#required' => TRUE,
      '#description' => $description,
    );
    $form['server']['client_scheme'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Client javascript to Node.js server protocol'),
      '#default_value' => $config
        ->get('client.scheme'),
      '#options' => array(
        'http' => t('http'),
        'https' => t('https'),
      ),
      '#description' => $this
        ->t('The protocol used to communicate with the Node.js server from client javascript code.'),
    );
    $form['server']['client_host'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Node.js server host for client javascript.'),
      '#default_value' => $config
        ->get('client.host'),
      '#size' => 40,
      '#required' => TRUE,
      '#description' => $this
        ->t('The hostname of the Node.js server.'),
    );
    $form['server']['client_port'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Node.js server port for client javacript'),
      '#default_value' => $config
        ->get('client.port'),
      '#size' => 10,
      '#required' => TRUE,
      '#description' => $this
        ->t('The port of the Node.js server.'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->configFactory
      ->getEditable('nodejs.config')
      ->set('nodejs.scheme', $form_state
      ->getValue('scheme'))
      ->set('nodejs.host', $form_state
      ->getValue('host'))
      ->set('nodejs.port', $form_state
      ->getValue('port'))
      ->set('client.scheme', $form_state
      ->getValue('client_scheme'))
      ->set('client.host', $form_state
      ->getValue('client_host'))
      ->set('client.port', $form_state
      ->getValue('client_port'))
      ->set('pages', $form_state
      ->getValue('pages'))
      ->set('service_key', $form_state
      ->getValue('service_key'))
      ->save();
    parent::submitForm($form, $form_state);
  }

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

}

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
FormInterface::getFormId public function Returns a unique string identifying the form. 236
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.
NodejsConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
NodejsConfigForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
NodejsConfigForm::getFormID public function
NodejsConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.