You are here

Home » API reference » A/B Test JS 2.0.x » AbjsSettingsAdmin.php

class AbjsSettingsAdmin in A/B Test JS 2.0.x

Same name and namespace in other branches
  1. 8 src/Form/AbjsSettingsAdmin.php \Drupal\abjs\Form\AbjsSettingsAdmin

Build form for settings module.

Hierarchy

Expanded class hierarchy of AbjsSettingsAdmin

1 file declares its use of AbjsSettingsAdmin
AbjsSettingsAdminTest.php in tests/src/Kernel/Form/AbjsSettingsAdminTest.php
1 string reference to 'AbjsSettingsAdmin'
abjs.routing.yml in ./abjs.routing.yml
abjs.routing.yml

File

src/Form/AbjsSettingsAdmin.php, line 11

Namespace

Drupal\abjs\Form
View source 
class AbjsSettingsAdmin extends ConfigFormBase {

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

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

  /**
   * Building form.
   *
   * @param array $form
   *   The form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The state of forms.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('abjs.settings');

    // Each applicable test will have one cookie. The cookie prefix will prefix
    // the name of all test cookies.
    $form['cookie_prefix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cookie Prefix'),
      '#default_value' => $config
        ->get('cookie.prefix'),
      '#description' => $this
        ->t('This string will prefix all A/B test cookie names'),
      '#size' => 10,
      '#maxlength' => 10,
    ];
    $form['cookie_lifetime'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cookie Lifetime'),
      '#description' => $this
        ->t('Enter cookie lifetime in days'),
      '#default_value' => $config
        ->get('cookie.lifetime'),
      '#size' => 4,
      '#maxlength' => 10,
    ];
    $form['cookie_domain'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cookie Domain'),
      '#description' => $this
        ->t('Enter the domain to which the test cookies will be set, e.g. example.com. Leave blank to set the cookies to the domain of the page where the tests are occurring.'),
      '#default_value' => $config
        ->get('cookie.domain'),
      '#size' => 50,
      '#maxlength' => 100,
    ];
    $form['cookie_secure'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Use Secure Cookies?'),
      '#description' => $this
        ->t('This sets the secure flag on A/B test cookies'),
      '#options' => [
        0 => $this
          ->t('No'),
        1 => $this
          ->t('Yes'),
      ],
      '#default_value' => $config
        ->get('cookie.secure'),
    ];
    $form['ace'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Use Ace Code Editor?'),
      '#description' => $this
        ->t('Use Ace Code Editor for entering Condition and Experience scripts. If chosen, it will be loaded via https://cdnjs.cloudflare.com.'),
      '#options' => [
        0 => $this
          ->t('No'),
        1 => $this
          ->t('Yes'),
      ],
      '#default_value' => $config
        ->get('ace'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('abjs.settings')
      ->set('cookie.prefix', $form_state
      ->getValue('cookie_prefix'))
      ->set('cookie.lifetime', $form_state
      ->getValue('cookie_lifetime'))
      ->set('cookie.domain', $form_state
      ->getValue('cookie_domain'))
      ->set('cookie.secure', $form_state
      ->getValue('cookie_secure'))
      ->set('ace', $form_state
      ->getValue('ace'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AbjsSettingsAdmin::buildForm public function Building form. Overrides ConfigFormBase::buildForm
AbjsSettingsAdmin::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AbjsSettingsAdmin::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AbjsSettingsAdmin::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 18
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 16
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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::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 72
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.