class SuggestionEditForm in Autocomplete Search Suggestions 3.0.x

Suggestion indexing form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\suggestion\Form\SuggestionEditForm

1 string reference to 'SuggestionEditForm'

suggestion.routing.yml in ./suggestion.routing.yml

suggestion.routing.yml

File

src/Form/SuggestionEditForm.php, line 13

Namespace

Drupal\suggestion\Form

class SuggestionEditForm extends FormBase {

  /**
   * The suggestion edit form.
   *
   * @param array $form
   *   A drupal form array.
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   A Drupal form state object.
   * @param string $ngram
   *   The ngram that is being edited.
   *
   * @return array
   *   A Drupal form array.
   */
  public function buildForm(array $form, FormStateInterface $form_state, $ngram = '') {
    if (!$ngram) {
      return $form;
    }
    $obj = SuggestionStorage::getSuggestion($ngram);
    $form['ngram'] = [
      '#type' => 'value',
      '#value' => $obj->ngram,
    ];
    $form['atoms'] = [
      '#type' => 'value',
      '#value' => $obj->atoms,
    ];
    $form['density'] = [
      '#type' => 'value',
      '#value' => $obj->density,
    ];
    $form['ngram_txt'] = [
      '#markup' => $this
        ->t('Suggestion: @ngram', [
        '@ngram' => $obj->ngram,
      ]),
      '#suffix' => '<br />',
      '#weight' => 10,
    ];
    $form['atoms_txt'] = [
      '#markup' => $this
        ->t('Words: @atoms', [
        '@atoms' => $obj->atoms,
      ]),
      '#suffix' => '<br />',
      '#weight' => 20,
    ];
    $form['density_txt'] = [
      '#markup' => $this
        ->t('Score: @density', [
        '@density' => $obj->density,
      ]),
      '#weight' => 30,
    ];
    $form['qty'] = [
      '#title' => $this
        ->t('Quantity'),
      '#type' => 'textfield',
      '#default_value' => $obj->qty,
      '#required' => TRUE,
      '#weight' => 40,
    ];
    $form['src'] = [
      '#title' => $this
        ->t('Source'),
      '#type' => 'select',
      '#options' => SuggestionStorage::getSrcOptions(),
      '#default_value' => SuggestionHelper::srcBits($obj->src),
      '#multiple' => TRUE,
      '#required' => TRUE,
      '#weight' => 50,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
      '#weight' => 100,
    ];
    return $form;
  }

  /**
   * The form ID.
   *
   * @return string
   *   The form ID.
   */
  public function getFormId() {
    return 'suggestion_edit';
  }

  /**
   * AJAX callback for the indexing form.
   *
   * @param array $form
   *   A drupal form array.
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   A Drupal form state object.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $src = 0;
    foreach ((array) $form_state
      ->getValue('src') as $bit) {
      $src |= intval($bit);
    }
    $key = [
      'ngram' => $form_state
        ->getValue('ngram'),
    ];
    $fields = [
      'atoms' => $form_state
        ->getValue('atoms'),
      'density' => SuggestionHelper::calculateDensity($src, $form_state
        ->getValue('atoms'), $form_state
        ->getValue('qty')),
      'qty' => $form_state
        ->getValue('qty'),
      'src' => $src,
    ];
    SuggestionStorage::mergeSuggestion($key, $fields);
    $this
      ->messenger()
      ->addStatus($this
      ->t('Updated: &ldquo;@ngram&rdquo;', [
      '@ngram' => $form_state
        ->getValue('ngram'),
    ]));
  }

  /**
   * Validation function for the suggestion edit form.
   *
   * @param array $form
   *   A drupal form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   A Drupal FormStateInterface object.
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (!is_numeric(trim($form_state
      ->getValue('qty')))) {
      $form_state
        ->setErrorByName('qty', $this
        ->t('The quantity must have a numeric value'));
    }
    if (!count((array) $form_state
      ->getValue('src'))) {
      $form_state
        ->setErrorByName('src', $this
        ->t('The source must have a value.'));
    }
    elseif (isset($form_state
      ->getValue('src')[0]) && count((array) $form_state
      ->getValue('src')) > 1) {
      $form_state
        ->setErrorByName('src', $this
        ->t('The disabled option cannot be combined with other options.'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	105
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.
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.
SuggestionEditForm::buildForm	public	function	The suggestion edit form. Overrides FormInterface::buildForm
SuggestionEditForm::getFormId	public	function	The form ID. Overrides FormInterface::getFormId
SuggestionEditForm::submitForm	public	function	AJAX callback for the indexing form. Overrides FormInterface::submitForm
SuggestionEditForm::validateForm	public	function	Validation function for the suggestion edit form. Overrides FormBase::validateForm