class SuggestionAdminForm in Autocomplete Search Suggestions 8.2

Same name and namespace in other branches

8 src/Form/SuggestionAdminForm.php \Drupal\suggestion\Form\SuggestionAdminForm
3.0.x src/Form/SuggestionAdminForm.php \Drupal\suggestion\Form\SuggestionAdminForm

Suggestion configuration form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\suggestion\Form\SuggestionAdminForm

Expanded class hierarchy of SuggestionAdminForm

1 string reference to 'SuggestionAdminForm'

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

File

src/Form/SuggestionAdminForm.php, line 16

Namespace

Drupal\suggestion\Form

View source

class SuggestionAdminForm extends FormBase {
  protected $langMgr;

  /**
   * Class constructor.
   *
   * @param \Drupal\Core\Language\LanguageManager $langMgr
   *   The language manager dependency injection.
   */
  public function __construct(LanguageManager $langMgr) {
    $this->langMgr = $langMgr;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('language_manager'));
  }

  /**
   * The suggestion configuration form.
   *
   * @param array $form
   *   A drupal form array.
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   A Drupal form state object.
   *
   * @return array
   *   A Drupal form array.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $cfg = Helper::getConfig();
    $languages = $this->langMgr
      ->getLanguages();
    $form['entry_style'] = [
      '#title' => $this
        ->t('Entry Choices'),
      '#description' => $this
        ->t('Simple supports one autocomplete suggestion box, Advanced supports unlimited instances of autocomplete'),
      '#type' => 'radios',
      '#options' => [
        'simple' => $this
          ->t('Simple'),
        'advanced' => $this
          ->t('Advanced'),
      ],
      'advanced' => [
        '#description' => $this
          ->t('Advanced supports unlimited instances of autocomplete.'),
      ],
      'simple' => [
        '#description' => $this
          ->t('Simple supports one autocomplete suggestion box.'),
      ],
      '#default_value' => $cfg->entry_style == 'advanced' ? 'advanced' : 'simple',
      '#weight' => 0,
    ];
    $form['autocomplete'] = [
      '#title' => $this
        ->t('Form ID, field name K/V pairs'),
      '#description' => $this
        ->t('A list of colon delimited form_id and field name pairs. One pre line, (search_form:keys).'),
      '#type' => 'textarea',
      '#default_value' => $this
        ->getAutocomplete(),
      '#states' => [
        'visible' => [
          'input[name="entry_style"]' => [
            'value' => 'advanced',
          ],
        ],
      ],
      '#weight' => 10,
    ];
    $form['simple'] = [
      '#type' => 'container',
      '#tree' => FALSE,
      '#states' => [
        'visible' => [
          'input[name="entry_style"]' => [
            'value' => 'simple',
          ],
        ],
      ],
      '#weight' => 20,
    ];
    $form['simple']['form_key'] = [
      '#title' => $this
        ->t('Form ID'),
      '#type' => 'textfield',
      '#default_value' => $cfg->form_key,
    ];
    $form['simple']['field_name'] = [
      '#title' => $this
        ->t('Field Name'),
      '#type' => 'textfield',
      '#default_value' => $cfg->field_name,
    ];
    $form['min'] = [
      '#title' => $this
        ->t('Minimum Characters in a Suggestion'),
      '#type' => 'select',
      '#options' => array_combine(range(3, 10), range(3, 10)),
      '#default_value' => $cfg->min,
      '#required' => TRUE,
      '#weight' => 30,
    ];
    $form['max'] = [
      '#title' => $this
        ->t('Maximum Characters in a Suggestion'),
      '#type' => 'select',
      '#options' => array_combine(range(20, 60), range(20, 60)),
      '#default_value' => $cfg->max,
      '#required' => TRUE,
      '#weight' => 40,
    ];
    $form['atoms_min'] = [
      '#title' => $this
        ->t('Minimum Words in a Suggestion'),
      '#type' => 'select',
      '#options' => array_combine(range(1, 10), range(1, 10)),
      '#default_value' => $cfg->atoms_min,
      '#required' => TRUE,
      '#weight' => 50,
    ];
    $form['atoms_max'] = [
      '#title' => $this
        ->t('Maximum Words in a Suggestion'),
      '#type' => 'select',
      '#options' => array_combine(range(1, 10), range(1, 10)),
      '#default_value' => $cfg->atoms_max,
      '#required' => TRUE,
      '#weight' => 50,
    ];
    $form['limit'] = [
      '#title' => $this
        ->t('Maximum Suggestions Returned'),
      '#type' => 'select',
      '#options' => array_combine(range(10, 100), range(10, 100)),
      '#default_value' => $cfg->limit,
      '#required' => TRUE,
      '#weight' => 60,
    ];
    $form['types'] = [
      '#title' => $this
        ->t('Content Types'),
      '#type' => 'checkboxes',
      '#options' => $this
        ->getContentTypes(),
      '#default_value' => $cfg->types,
      '#required' => TRUE,
      '#weight' => 70,
    ];
    $form['keywords'] = [
      '#type' => 'container',
      '#tree' => TRUE,
      '#weight' => 80,
    ];

    // Language keywords.
    foreach ($languages as $language) {
      $form['keywords'][$language
        ->getId()] = [
        '#title' => $this
          ->t('Priority Suggestions (:lang)', [
          ':lang' => $language
            ->getName(),
        ]),
        '#description' => $this
          ->t('Suggestions entered here take priority.'),
        '#type' => 'textarea',
        '#default_value' => $this
          ->getKeywords($language
          ->getId()),
        '#rows' => 10,
        '#required' => FALSE,
      ];
    }
    $form['stopwords'] = [
      '#title' => $this
        ->t('Stopwords'),
      '#description' => $this
        ->t('Stopwords are not indexed.'),
      '#type' => 'textarea',
      '#default_value' => $this
        ->getStopwords(),
      '#rows' => 10,
      '#required' => FALSE,
      '#weight' => 90,
    ];
    $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_admin';
  }

  /**
   * Submit function for the suggestion configuration 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) {
    $current = Helper::getConfig();

    // Set synced to false if any indexing fields change.
    if ($current->atoms_max != $form_state
      ->getValue('atoms_max')) {
      $this
        ->setSynced(FALSE);
    }
    if ($current->atoms_max != $form_state
      ->getValue('atoms_min')) {
      $this
        ->setSynced(FALSE);
    }
    elseif ($current->limit != $form_state
      ->getValue('limit')) {
      $this
        ->setSynced(FALSE);
    }
    elseif ($current->max != $form_state
      ->getValue('max')) {
      $this
        ->setSynced(FALSE);
    }
    elseif ($current->min != $form_state
      ->getValue('min')) {
      $this
        ->setSynced(FALSE);
    }
    elseif ($current->types != $form_state
      ->getValue('types')) {
      $this
        ->setSynced(FALSE);
    }

    // Set config fields.
    Helper::setConfig('atoms_max', $form_state
      ->getValue('atoms_max'));
    Helper::setConfig('atoms_min', $form_state
      ->getValue('atoms_min'));
    Helper::setConfig('entry_style', $form_state
      ->getValue('entry_style'));
    Helper::setConfig('limit', $form_state
      ->getValue('limit'));
    Helper::setConfig('max', $form_state
      ->getValue('max'));
    Helper::setConfig('min', $form_state
      ->getValue('min'));
    Helper::setConfig('field_name', trim($form_state
      ->getValue('field_name')));
    Helper::setConfig('form_key', trim($form_state
      ->getValue('form_key')));
    Helper::setConfig('types', $form_state
      ->getValue('types'));

    // Form ID to field name hash.
    $this
      ->setAutocomplete($form_state);

    // Priority suggestions.
    $this
      ->setKeywords($form_state);

    // Stopwords.
    $this
      ->setStopwords($form_state);
  }

  /**
   * Build an autocomplete form ID to field name hash.
   *
   * @return string
   *   A colon delimited list of form_id to field name.
   */
  protected function getAutocomplete() {
    $txt = '';
    foreach ((array) Helper::getConfig('autocomplete') as $key => $val) {
      $txt .= "{$key}:{$val}\n";
    }
    return $txt;
  }

  /**
   * Build a content type to label hash.
   *
   * @return array
   *   A content type to label hash.
   */
  protected function getContentTypes() {
    $types = Storage::getContentTypes();
    foreach ($types as &$type) {
      $type = ucwords($type);
    }
    return !empty($types) ? $types : [];
  }

  /**
   * Build a list of priority suggestions.
   *
   * @param string $language
   *   The language code.
   *
   * @return string
   *   A newline delimited string of priority ngrams.
   */
  protected function getKeywords($language) {
    $keywords = Storage::getKeywords($language);
    return !empty($keywords) ? implode("\n", $keywords) : '';
  }

  /**
   * Build a list of stopwords.
   *
   * @return string
   *   A newline delimited string of stopwords.
   */
  protected function getStopwords() {
    $stopwords = Helper::getStops('stopwords');
    return $stopwords ? implode("\n", array_keys($stopwords)) : '';
  }

  /**
   * Build an autocomplete form ID to field name hash.
   *
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   A Drupal form state object.
   */
  protected function setAutocomplete(FormStateInterface $form_state) {
    $hash = [];
    if ($form_state
      ->getValue('entry_style') == 'simple') {
      $hash[trim($form_state
        ->getValue('form_key'))] = trim($form_state
        ->getValue('field_name'));
    }
    else {
      foreach (preg_split('/\\s*[\\n\\r]+\\s*/s', trim($form_state
        ->getValue('autocomplete'))) as $line) {
        if (preg_match('/^\\W*([a-z_0-9]+)\\W+([a-z_0-9]+)\\W*$/', $line, $m)) {
          $hash[$m[1]] = $m[2];
        }
      }
      ksort($hash);
    }
    Helper::setConfig('autocomplete', $hash);
  }

  /**
   * Process all the priority suggestions submitted.
   *
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   A Drupal form state object.
   */
  protected function setKeywords(FormStateInterface $form_state) {
    $language_keywords = $form_state
      ->getValue('keywords');
    foreach ($language_keywords as $language => $group) {
      foreach (preg_split('/\\s*[\\n\\r]+\\s*/su', trim($group)) as $txt) {
        Helper::insert($txt, $language, Storage::PRIORITY_BIT);
      }
    }
  }

  /**
   * Process all the stopwords submitted.
   *
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   A Drupal form state object.
   */
  protected function setStopwords(FormStateInterface $form_state) {
    $stopwords = [];
    foreach (preg_split('/\\s*[\\n\\r]+\\s*/s', trim($form_state
      ->getValue('stopwords'))) as $txt) {
      $stopwords += array_flip(preg_split('/\\s+/', Helper::tokenize($txt, 2)));
    }
    $stopwords = array_fill_keys(array_keys($stopwords), 1);
    ksort($stopwords);
    $hash = Crypt::hashBase64(implode("\n", array_keys($stopwords)));
    if ($hash != Helper::getStops('hash')) {
      Helper::setStops('hash', $hash);
      Helper::setStops('stopwords', $stopwords);
      Helper::setConfig('synced', FALSE);
    }
  }

  /**
   * Set the synced value.
   *
   * @param bool $synced
   *   The synced value.
   *
   * @return object
   *   A configuration object.
   */
  protected function setSynced($synced) {
    return Helper::setConfig('synced', (bool) $synced);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
SuggestionAdminForm::$langMgr	protected	property
SuggestionAdminForm::buildForm	public	function	The suggestion configuration form. Overrides FormInterface::buildForm
SuggestionAdminForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
SuggestionAdminForm::getAutocomplete	protected	function	Build an autocomplete form ID to field name hash.
SuggestionAdminForm::getContentTypes	protected	function	Build a content type to label hash.
SuggestionAdminForm::getFormId	public	function	The form ID. Overrides FormInterface::getFormId
SuggestionAdminForm::getKeywords	protected	function	Build a list of priority suggestions.
SuggestionAdminForm::getStopwords	protected	function	Build a list of stopwords.
SuggestionAdminForm::setAutocomplete	protected	function	Build an autocomplete form ID to field name hash.
SuggestionAdminForm::setKeywords	protected	function	Process all the priority suggestions submitted.
SuggestionAdminForm::setStopwords	protected	function	Process all the stopwords submitted.
SuggestionAdminForm::setSynced	protected	function	Set the synced value.
SuggestionAdminForm::submitForm	public	function	Submit function for the suggestion configuration form. Overrides FormInterface::submitForm
SuggestionAdminForm::__construct	public	function	Class constructor.
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.

You are here

class SuggestionAdminForm in Autocomplete Search Suggestions 8.2

Hierarchy

File

Namespace

Members

API Navigation