You are here

Home » API reference » A/B Test JS 8 » AbjsExperienceForm.php

class AbjsExperienceForm in A/B Test JS 8

Same name and namespace in other branches
  1. 2.0.x src/Form/AbjsExperienceForm.php \Drupal\abjs\Form\AbjsExperienceForm

Class for build experience form.

Hierarchy

Expanded class hierarchy of AbjsExperienceForm

1 string reference to 'AbjsExperienceForm'
abjs.routing.yml in ./abjs.routing.yml
abjs.routing.yml

File

src/Form/AbjsExperienceForm.php, line 15

Namespace

Drupal\abjs\Form
View source 
class AbjsExperienceForm extends FormBase {

  /**
   * Current account user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $account;

  /**
   * Database connection service.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * Provides a class for obtaining system time.
   *
   * @var \Drupal\Component\Datetime\Time
   */
  protected $time;

  /**
   * Class constructor.
   */
  public function __construct(AccountInterface $account, Connection $database, Time $time) {
    $this->account = $account;
    $this->database = $database;
    $this->time = $time;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_user'), $container
      ->get('database'), $container
      ->get('datetime.time'));
  }

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

  /**
   * Building form.
   *
   * @param array $form
   *   The form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The state of forms.
   * @param int $eid
   *   The ID of the item to be deleted.
   */
  public function buildForm(array $form, FormStateInterface $form_state, $eid = NULL) {
    $form = [];
    $experience_name_default = "";
    $experience_script_default = "";
    if (!empty($eid)) {
      $experience_result = $this->database
        ->query('SELECT name, script FROM {abjs_experience} WHERE eid = :eid', [
        ':eid' => $eid,
      ]);
      $experience = $experience_result
        ->fetchObject();
      if (empty($experience)) {
        $this
          ->messenger()
          ->addMessage($this
          ->t('The requested experience does not exist.'), 'error');
        return $form;
      }
      $experience_name_default = $experience->name;
      $experience_script_default = $experience->script;
      $form['eid'] = [
        '#type' => 'value',
        '#value' => $eid,
      ];
    }
    $form['name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Experience Name'),
      '#default_value' => $experience_name_default,
      '#size' => 30,
      '#maxlength' => 50,
      '#required' => TRUE,
    ];
    $form['script'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Experience Script'),
      '#default_value' => $experience_script_default,
      '#description' => $this
        ->t('Any valid javascript to load in head. Leave empty for a Control. Read the documentation for more examples.'),
      '#rows' => 3,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['save'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#weight' => 5,
      '#submit' => [
        '::saveExperience',
      ],
      '#attributes' => [
        'class' => [
          "button button-action button--primary",
        ],
      ],
    ];
    $form['actions']['cancel'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Cancel'),
      '#weight' => 10,
      '#submit' => [
        '::cancelExperience',
      ],
      '#limit_validation_errors' => [],
    ];
    if (!empty($eid)) {
      $form['actions']['delete'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Delete'),
        '#weight' => 15,
        '#submit' => [
          '::deleteExperience',
        ],
      ];
    }

    // Add ace code editor for syntax highlighting on the script field.
    if ($this
      ->configFactory()
      ->get('abjs.settings')
      ->get('ace') == 1) {
      $form['#attached']['library'][] = 'abjs/ace-editor';
    }
    return $form;
  }

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

  /**
   * Save data.
   *
   * @param array $form
   *   The form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The state of forms.
   */
  public function saveExperience(array &$form, FormStateInterface $form_state) {
    $user = $this->account;
    if ($form_state
      ->hasValue('eid')) {

      // This is a modified experience, so use update.
      $this->database
        ->update('abjs_experience')
        ->fields([
        'name' => $form_state
          ->getValue('name'),
        'script' => $form_state
          ->getValue('script'),
        'changed' => $this->time
          ->getRequestTime(),
        'changed_by' => $user
          ->id(),
      ])
        ->condition('eid', $form_state
        ->getValue('eid'), '=')
        ->execute();
      $this
        ->messenger()
        ->addMessage($this
        ->t("Successfully updated experience"));
    }
    else {

      // This is a new experience, so use insert.
      $this->database
        ->insert('abjs_experience')
        ->fields([
        'name' => $form_state
          ->getValue('name'),
        'script' => $form_state
          ->getValue('script'),
        'created' => $this->time
          ->getRequestTime(),
        'created_by' => $user
          ->id(),
        'changed' => $this->time
          ->getRequestTime(),
        'changed_by' => $user
          ->id(),
      ])
        ->execute();
      $this
        ->messenger()
        ->addMessage($this
        ->t("Successfully saved new experience"));
    }
    $form_state
      ->setRedirect('abjs.experience_admin');
  }

  /**
   * Cancel the action.
   *
   * @param array $form
   *   The form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The state of forms.
   */
  public function cancelExperience(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('abjs.experience_admin');
  }

  /**
   * Delete item.
   *
   * @param array $form
   *   The form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The state of forms.
   */
  public function deleteExperience(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('abjs.experience_delete_confirm_form', [
      'eid' => $form_state
        ->getValue('eid'),
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AbjsExperienceForm::$account protected property Current account user.
AbjsExperienceForm::$database protected property Database connection service.
AbjsExperienceForm::$time protected property Provides a class for obtaining system time.
AbjsExperienceForm::buildForm public function Building form. Overrides FormInterface::buildForm
AbjsExperienceForm::cancelExperience public function Cancel the action.
AbjsExperienceForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
AbjsExperienceForm::deleteExperience public function Delete item.
AbjsExperienceForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AbjsExperienceForm::saveExperience public function Save data.
AbjsExperienceForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AbjsExperienceForm::__construct public function Class constructor.
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::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.