class FederatedSearchPageBlockForm in Search API Federated Solr 8
Same name and namespace in other branches
- 8.3 src/Form/FederatedSearchPageBlockForm.php \Drupal\search_api_federated_solr\Form\FederatedSearchPageBlockForm
- 8.2 src/Form/FederatedSearchPageBlockForm.php \Drupal\search_api_federated_solr\Form\FederatedSearchPageBlockForm
- 4.x src/Form/FederatedSearchPageBlockForm.php \Drupal\search_api_federated_solr\Form\FederatedSearchPageBlockForm
Class FederatedSearchPageForm.
@package Drupal\search_api_federated_solr\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\search_api_federated_solr\Form\FederatedSearchPageBlockForm
Expanded class hierarchy of FederatedSearchPageBlockForm
File
- src/
Form/ FederatedSearchPageBlockForm.php, line 18 - Contains \Drupal\search_api_solr_federated\Form\FederatedSearchPageBlockForm.
Namespace
Drupal\search_api_federated_solr\FormView source
class FederatedSearchPageBlockForm extends FormBase {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'federated_search_page_block_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$renderer = \Drupal::service('renderer');
$app_config = \Drupal::config('search_api_federated_solr.search_app.settings');
$form['search'] = [
'#type' => 'search',
'#name' => 'search',
'#title' => $this
->t('Search'),
'#title_display' => 'invisible',
'#size' => 15,
'#default_value' => '',
'#attributes' => [
'title' => $this
->t('Enter the terms you wish to search for.'),
'placeholder' => 'Search',
],
'#prefix' => '<div class="container-inline">',
];
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Search'),
'#name' => '',
'#suffix' => '</div>',
];
// Send site name as qs param if app is configured to load w/default site.
if ($app_config
->get('facet.site_name.set_default')) {
$search_index = $app_config
->get('index.id');
$index_config = \Drupal::config('search_api.index.' . $search_index);
$site_name = $index_config
->get('field_settings.site_name.configuration.site_name');
$form['sm_site_name'] = [
'#type' => 'hidden',
'#name' => 'sm_site_name',
'#default_value' => $site_name,
];
// Ensure that this form's render cache is invalidated when search app
// config is updated.
$renderer
->addCacheableDependency($form, $index_config);
}
$form['#action'] = $this
->getUrlGenerator()
->generateFromRoute('search_api_federated_solr.search');
$form['#method'] = 'get';
// Ensure that this form's render cache is invalidated when search app
// config is updated.
$renderer
->addCacheableDependency($form, $app_config);
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// This form submits to the search page, so processing happens there.
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FederatedSearchPageBlockForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
FederatedSearchPageBlockForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
FederatedSearchPageBlockForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
87 |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |