You are here

Home » API reference » Search Log 8 » SearchLogConfigurationForm.php

class SearchLogConfigurationForm in Search Log 8

Hierarchy

Expanded class hierarchy of SearchLogConfigurationForm

1 string reference to 'SearchLogConfigurationForm'
search_log.routing.yml in ./search_log.routing.yml
search_log.routing.yml

File

src/Form/SearchLogConfigurationForm.php, line 13

Namespace

Drupal\search_log\Form
View source 
class SearchLogConfigurationForm extends ConfigFormBase {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

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

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $moduleHandler, Connection $database) {
    parent::__construct($config_factory);
    $this->moduleHandler = $moduleHandler;
    $this->database = $database;
  }

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

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

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

  /**
   * {@inheritdoc}.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('search_log.settings');
    $form['logging'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Search log settings'),
    ];
    $terms_options = [
      'search_log_terms_lowercase' => $this
        ->t('lowercase (%1 stored as %2)', [
        '%1' => 'Apple iPod',
        '%2' => 'apple ipod',
      ]),
      'search_log_terms_uppercase_first' => $this
        ->t('uppercase first word (%1 stored as %2)', [
        '%1' => 'Apple iPod',
        '%2' => 'Apple ipod',
      ]),
      'search_log_terms_uppercase_words' => $this
        ->t('uppercase all words (%1 stored as %2)', [
        '%1' => 'Apple iPod',
        '%2' => 'Apple Ipod',
      ]),
    ];
    $form['logging']['search_log_terms'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Search term normalization'),
      '#description' => $this
        ->t('Search terms are normalized before they are stored in Search log. Changing this value may result in duplicate terms for the current day.'),
      '#options' => $terms_options,
      '#default_value' => $config
        ->get('search_log_terms'),
    ];
    $form['logging']['search_log_preprocess'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Collect search result with preprocess_search_results()'),
      '#description' => $this
        ->t('Search does not have a hook to obtain the number of search results. This theme function will work in certain circumstances. If enabled, the function will add one extra DB write for failed search results.'),
      '#default_value' => $config
        ->get('search_log_preprocess'),
    ];
    $form['status'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Search log status'),
    ];
    $query = $this->database
      ->select('search_log', 'sl')
      ->fields('sl', [
      'qid',
    ]);
    $results = $query
      ->execute()
      ->fetchAll();
    $num_of_results = count($results);
    $form['status']['search_log_count']['#markup'] = '<p>' . $this
      ->t('There are :count entries in the Search log table.', [
      ':count' => number_format($num_of_results),
    ]) . '</p>';
    $form['status']['search_log_cron'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Days to keep search log'),
      '#description' => $this
        ->t('Search log table can be automatically truncated by cron. Set to 0 to never truncate Search log table.'),
      '#size' => 4,
      '#default_value' => $config
        ->get('search_log_cron'),
    ];
    return parent::buildForm($form, $form_state);
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::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.
SearchLogConfigurationForm::$database protected property The database service.
SearchLogConfigurationForm::$moduleHandler protected property The module handler service.
SearchLogConfigurationForm::buildForm public function . Overrides ConfigFormBase::buildForm
SearchLogConfigurationForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SearchLogConfigurationForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SearchLogConfigurationForm::getFormId public function . Overrides FormInterface::getFormId
SearchLogConfigurationForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SearchLogConfigurationForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.