You are here

Home » API reference » Autocomplete Search Suggestions 8.2 » SuggestionSearchForm.php

class SuggestionSearchForm in Autocomplete Search Suggestions 8.2

Same name and namespace in other branches
  1. 8 src/Form/SuggestionSearchForm.php \Drupal\suggestion\Form\SuggestionSearchForm
  2. 3.0.x src/Form/SuggestionSearchForm.php \Drupal\suggestion\Form\SuggestionSearchForm

Ngram search form.

Hierarchy

Expanded class hierarchy of SuggestionSearchForm

1 string reference to 'SuggestionSearchForm'
suggestion.routing.yml in ./suggestion.routing.yml
suggestion.routing.yml

File

src/Form/SuggestionSearchForm.php, line 20

Namespace

Drupal\suggestion\Form
View source 
class SuggestionSearchForm extends FormBase {
  protected $dbh;
  protected $langMgr;
  protected $pagerMgr;
  protected $redirect;

  /**
   * Class constructor.
   *
   * @param \Drupal\Core\Routing\RedirectDestinationInterface $redirect
   *   The redirect destination.
   * @param \Drupal\Core\Language\LanguageManager $lang_mgr
   *   The language manager dependency injection.
   * @param \Drupal\Core\Pager\PagerManagerInterface $pager_mgr
   *   The language manager dependency injection.
   * @param \Drupal\Core\Database\Connection $dbh
   *   The language manager dependency injection.
   */
  public function __construct(RedirectDestinationInterface $redirect, LanguageManager $lang_mgr, PagerManagerInterface $pager_mgr, Connection $dbh) {
    $this->dbh = $dbh;
    $this->langMgr = $lang_mgr;
    $this->pagerMgr = $pager_mgr;
    $this->redirect = $redirect;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('redirect.destination'), $container
      ->get('language_manager'), $container
      ->get('pager.manager'), $container
      ->get('database'));
  }

  /**
   * The suggestion search form.
   *
   * @param array $form
   *   A drupal form array.
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   A Drupal form state object.
   * @param string $ngram
   *   The search string.
   *
   * @return array
   *   A Drupal form array.
   */
  public function buildForm(array $form, FormStateInterface $form_state, $ngram = '') {
    $langcode = $this->langMgr
      ->getCurrentLanguage()
      ->getId();
    $languages = $this->langMgr
      ->getLanguages();
    $ngram = trim($ngram);
    $opts = [
      'query' => $this->redirect
        ->getAsArray(),
    ];
    $rows = [];
    $rpp = Helper::getConfig('rpp');
    $header = [
      $this
        ->t('N-Gram'),
      $this
        ->t('Source'),
      $this
        ->t('Atoms'),
      $this
        ->t('Language'),
      $this
        ->t('Quantity'),
      $this
        ->t('Density'),
      $this
        ->t('Edit'),
    ];
    if ($ngram) {
      $pattern = '%' . $this->dbh
        ->escapeLike($ngram) . '%';
      $page = $this->pagerMgr
        ->createPager(Storage::getCount($langcode, $pattern), $rpp);
      $suggestions = Storage::search($pattern, $langcode, $page * $rpp, $rpp);
    }
    else {
      $page = $this->pagerMgr
        ->createPager(Storage::getCount($langcode), $rpp);
      $suggestions = Storage::getAllSuggestions($langcode, $page * $rpp, $rpp);
    }
    foreach ($suggestions as $obj) {
      $rows[$obj->ngram] = [
        $obj->ngram,
        $obj->src,
        $obj->atoms,
        !empty($languages[$obj->langcode]) ? $languages[$obj->langcode]
          ->getName() : $this
          ->t('Undefined'),
        $obj->qty,
        $obj->density,
        Link::fromTextAndUrl($this
          ->t('Edit'), Url::fromUri("internal:/admin/config/suggestion/edit/{$obj->ngram}", $opts)),
      ];
    }
    if ($this->langMgr
      ->isMultilingual()) {
      $form += $this
        ->multiLinks($languages);
    }
    $form['ngram'] = [
      '#type' => 'textfield',
      '#autocomplete_route_name' => 'suggestion.autocomplete',
      '#default_value' => $ngram,
      '#weight' => 10,
    ];
    $form['search'] = [
      '#type' => 'submit',
      '#name' => 'search',
      '#value' => $this
        ->t('Search'),
      '#submit' => [
        '::submitForm',
      ],
      '#weight' => 20,
    ];
    $form['list'] = [
      '#type' => 'tableselect',
      '#header' => $header,
      '#options' => $rows,
      '#empty' => $this
        ->t('Nothing found.'),
      '#weight' => 60,
    ];
    if (count($rows)) {
      $form['src'] = [
        '#title' => $this
          ->t('Source'),
        '#type' => 'select',
        '#options' => Storage::getSrcOptions(),
        '#multiple' => TRUE,
        '#weight' => 30,
      ];
      $form['update'] = [
        '#type' => 'submit',
        '#name' => 'update',
        '#value' => $this
          ->t('Update'),
        '#submit' => [
          '::submitUpdateForm',
          '::submitForm',
        ],
        '#validate' => [
          '::validateUpdateForm',
        ],
        '#weight' => 40,
      ];
      $form['pager_head'] = [
        '#type' => 'pager',
        '#weight' => 50,
      ];
      $form['pager_foot'] = [
        '#type' => 'pager',
        '#weight' => 70,
      ];
    }
    return $form;
  }

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

  /**
   * Ngram search submission function.
   *
   * @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) {
    $form_state
      ->setRedirectUrl(Url::fromUri('internal:/admin/config/suggestion/search/' . $form_state
      ->getValue('ngram')));
  }

  /**
   * Ngram update submission function.
   *
   * @param array $form
   *   A drupal form array.
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   A Drupal form state object.
   */
  public function submitUpdateForm(array &$form, FormStateInterface $form_state) {
    $src = Helper::optionBits((array) $form_state
      ->getValue('src'));
    foreach ((array) $form_state
      ->getValue('list') as $ngram => $val) {
      if (!$val) {
        continue;
      }
      Helper::updateSrc($ngram, $src, $this->langMgr
        ->getCurrentLanguage()
        ->getId());
      $this
        ->messenger()
        ->addStatus($this
        ->t('Updated: “@ngram”', [
        '@ngram' => $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 validateUpdateForm(array &$form, FormStateInterface $form_state) {
    $suxs = FALSE;
    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.'));
    }
    foreach ((array) $form_state
      ->getValue('list') as $val) {
      if ($val) {
        $suxs = TRUE;
        break;
      }
    }
    if (!$suxs) {
      $form_state
        ->setErrorByName('list', $this
        ->t('You must select an ngram to perform the update to.'));
    }
  }

  /**
   * Build a renderable array of language links.
   *
   * @param array $languages
   *   An array of language objects.
   *
   * @return array
   *   An array of renderable language links.
   */
  protected function multiLinks(array $languages = []) {
    $langcode = $this->langMgr
      ->getCurrentLanguage()
      ->getId();
    $prototype = [
      '#prefix' => '<li>',
      '#suffix' => '</li>',
    ];
    $form['suggestion_multi'] = [
      '#type' => 'markup',
      '#markup' => '',
      '#prefix' => '<ul>',
      '#suffix' => '</ul>',
      '#weight' => 0,
    ];
    foreach (array_keys($languages) as $id) {
      if ($id != $langcode) {
        $form['suggestion_multi']["language_{$id}"] = $prototype + Link::createFromRoute($languages[$id]
          ->getName(), 'suggestion.search', [], [
          'language' => $languages[$id],
        ])
          ->toRenderable();
      }
      else {
        $form['suggestion_multi']["language_{$id}"] = $prototype + [
          '#markup' => $languages[$id]
            ->getName(),
        ];
      }
    }
    return $form;
  }

}

Members

Namesort descending 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.
SuggestionSearchForm::$dbh protected property
SuggestionSearchForm::$langMgr protected property
SuggestionSearchForm::$pagerMgr protected property
SuggestionSearchForm::$redirect protected property
SuggestionSearchForm::buildForm public function The suggestion search form. Overrides FormInterface::buildForm
SuggestionSearchForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SuggestionSearchForm::getFormId public function The form ID. Overrides FormInterface::getFormId
SuggestionSearchForm::multiLinks protected function Build a renderable array of language links.
SuggestionSearchForm::submitForm public function Ngram search submission function. Overrides FormInterface::submitForm
SuggestionSearchForm::submitUpdateForm public function Ngram update submission function.
SuggestionSearchForm::validateUpdateForm public function Validation function for the suggestion edit form.
SuggestionSearchForm::__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.