Same name and namespace in other branches
- 8.9.x core/modules/search/src/Form/SearchPageForm.php \Drupal\search\Form\SearchPageForm
- 9 core/modules/search/src/Form/SearchPageForm.php \Drupal\search\Form\SearchPageForm
Provides a search form for site wide search.
Search plugins can define method searchFormAlter() to alter the form. If they have additional or substitute fields, they will need to override the form submit, making sure to redirect with a GET parameter of 'keys' included, to trigger the search being processed by the controller, and adding in any additional query parameters they need to execute search.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\search\Form\SearchPageForm
Expanded class hierarchy of SearchPageForm
1 file declares its use of SearchPageForm
- SearchController.php in core/
modules/ search/ src/ Controller/ SearchController.php
File
- core/
modules/ search/ src/ Form/ SearchPageForm.php, line 21
Namespace
Drupal\search\FormView source
class SearchPageForm extends FormBase {
/**
* The search page entity.
*
* @var \Drupal\search\SearchPageInterface
*/
protected $entity;
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'search_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, SearchPageInterface $search_page = NULL) {
$this->entity = $search_page;
$plugin = $this->entity
->getPlugin();
$form_state
->set('search_page_id', $this->entity
->id());
$form['basic'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'container-inline',
],
],
];
$form['basic']['keys'] = [
'#type' => 'search',
'#title' => $this
->t('Enter your keywords'),
'#default_value' => $plugin
->getKeywords(),
'#size' => 30,
'#maxlength' => 255,
];
// processed_keys is used to coordinate keyword passing between other forms
// that hook into the basic search form.
$form['basic']['processed_keys'] = [
'#type' => 'value',
'#value' => '',
];
$form['basic']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Search'),
];
$form['help_link'] = [
'#type' => 'link',
'#url' => new Url('search.help_' . $this->entity
->id()),
'#title' => $this
->t('About searching'),
'#options' => [
'attributes' => [
'class' => 'search-help-link',
],
],
];
// Allow the plugin to add to or alter the search form.
$plugin
->searchFormAlter($form, $form_state);
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Redirect to the search page with keywords in the GET parameters.
// Plugins with additional search parameters will need to provide their
// own form submit handler to replace this, so they can put their values
// into the GET as well. If so, make sure to put 'keys' into the GET
// parameters so that the search results generation is triggered.
$query = $this->entity
->getPlugin()
->buildSearchUrlQuery($form_state);
$route = 'search.view_' . $form_state
->get('search_page_id');
$form_state
->setRedirect($route, [], [
'query' => $query,
]);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
SearchPageForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
SearchPageForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
51 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 2 |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
MessengerTrait:: |
public | function | Gets the messenger. | 10 |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
89 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
SearchPageForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
FormBase:: |
protected | property | The config factory. | 2 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
MessengerTrait:: |
protected | property | The messenger. | 10 |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
SearchPageForm:: |
protected | property | The search page entity. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |