class BetterSearchSettingsForm in Better Search Block 8

Displays the better_search settings form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\better_search\Form\BetterSearchSettingsForm

Expanded class hierarchy of BetterSearchSettingsForm

1 string reference to 'BetterSearchSettingsForm'

better_search.routing.yml in ./better_search.routing.yml: better_search.routing.yml

File

src/Form/BetterSearchSettingsForm.php, line 11

Namespace

Drupal\better_search\Form

View source

class BetterSearchSettingsForm extends ConfigFormBase {

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

  /**
   * Implements \Drupal\Core\Form\FormInterface::getFormID().
   */
  public function getFormId() {
    return 'better_search_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['text'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Better Search Text Options'),
    ];
    $placeholder_text = $this
      ->config('better_search.settings')
      ->get('placeholder_text');
    $form['text']['placeholder_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Placeholder Text'),
      '#description' => $this
        ->t('Enter the text to be displayed in the search field (placeholder text)'),
      '#default_value' => $this
        ->t($placeholder_text),
      '#size' => 30,
      '#maxlength' => 60,
      '#required' => TRUE,
    ];
    $form['theme'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Better Search Theme Options'),
    ];
    $options = [
      0 => $this
        ->t('Background Fade'),
      1 => $this
        ->t('Expand on Hover'),
      2 => $this
        ->t('Expand Icon on Hover'),
      3 => $this
        ->t('Slide Icon on Hover'),
    ];
    $form['theme']['theme'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Select Theme'),
      '#default_value' => $this
        ->config('better_search.settings')
        ->get('theme'),
      '#options' => $options,
      '#description' => $this
        ->t('Select the theme to use for the search block.'),
    ];
    $options = [
      10 => '10',
      12 => '12',
      14 => '14',
      16 => '16',
      18 => '18',
      20 => '20',
      22 => '22',
      24 => '24',
      26 => '26',
      28 => '28',
      30 => '30',
    ];
    $form['theme']['size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Search Box Size'),
      '#default_value' => $this
        ->config('better_search.settings')
        ->get('size'),
      '#options' => $options,
    ];
    $form['searchpage'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Better Search options for search pages'),
    ];
    $form['searchpage']['searchpage_enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable Better Search on search pages'),
      '#default_value' => $this
        ->config('better_search.settings')
        ->get('searchpage_enable'),
      '#description' => $this
        ->t('If true, the Drupal search pages will be altered by this module.'),
    ];
    $form['searchpage']['searchpage_submit_not_visible'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide the submit button on search pages'),
      '#description' => $this
        ->t('A form_alter adds a visually-hidden class to the Submit button.'),
      '#default_value' => $this
        ->config('better_search.settings')
        ->get('searchpage_submit_not_visible'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('better_search.settings')
      ->set('placeholder_text', $form_state
      ->getValue('placeholder_text'));
    $config
      ->set('theme', $form_state
      ->getValue('theme'));
    $config
      ->set('size', $form_state
      ->getValue('size'));
    $config
      ->set('searchpage_enable', $form_state
      ->getValue('searchpage_enable'));
    $config
      ->set('searchpage_submit_not_visible', $form_state
      ->getValue('searchpage_submit_not_visible'));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BetterSearchSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
BetterSearchSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BetterSearchSettingsForm::getFormId	public	function	Implements \Drupal\Core\Form\FormInterface::getFormID(). Overrides FormInterface::getFormId
BetterSearchSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
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.
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.

You are here

class BetterSearchSettingsForm in Better Search Block 8

Hierarchy

File

Namespace

Members

API Navigation