class GoogleCSESearchBoxForm in Google Custom Search Engine 8.2
Same name and namespace in other branches
- 8.3 src/Form/GoogleCSESearchBoxForm.php \Drupal\google_cse\Form\GoogleCSESearchBoxForm
Class GoogleCSESearchBoxForm.
@package Drupal\google_cse\Form
Form builder for the searchbox forms.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\google_cse\Form\GoogleCSESearchBoxForm
Expanded class hierarchy of GoogleCSESearchBoxForm
File
- src/
Form/ GoogleCSESearchBoxForm.php, line 18
Namespace
Drupal\google_cse\FormView source
class GoogleCSESearchBoxForm extends FormBase {
/**
* The object for Google CSE services.
*
* @var \Drupal\google_cse\GoogleCSEServices
*/
protected $googleCSEServices;
/**
* RequestStack object for getting requests.
*
* @var \Symfony\Component\HttpFoundation\RequestStack
*/
protected $requestStack;
/**
* GoogleCSESearchBoxForm constructor.
*
* @param \Drupal\google_cse\GoogleCSEServices $googleCSEServices
* The google cse services.
* @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
* The request object.
*/
public function __construct(GoogleCSEServices $googleCSEServices, RequestStack $requestStack) {
$this->googleCSEServices = $googleCSEServices;
$this->requestStack = $requestStack;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('google_cse.services'), $container
->get('request_stack'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'google_cse_search_box_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$config = $this
->config('search.page.google_cse_search');
if ($config
->get('configuration')['results_display'] == 'here') {
$cof = $config
->get('configuration')['cof_here'];
}
else {
$form['#action'] = 'http://' . $config
->get('configuration')['domain'] . '/cse';
$cof = $config
->get('configuration')['cof_google'];
}
$form['#method'] = 'get';
$form['cx'] = [
'#type' => 'hidden',
'#value' => $config
->get('configuration')['cx'],
];
$form['cof'] = [
'#type' => 'hidden',
'#value' => $cof,
];
$form['query'] = [
'#type' => 'textfield',
'#default_value' => $this->requestStack
->getCurrentRequest()->query
->has('query') ? $this->requestStack
->getCurrentRequest()->query
->get('query') : '',
];
$form['sa'] = [
'#type' => 'submit',
'#value' => $this
->t('Search'),
];
foreach ($this->googleCSEServices
->advancedSettings() as $parameter => $setting) {
$form[$parameter] = [
'#type' => 'hidden',
'#value' => $setting,
];
}
$form['query']['#size'] = intval($config
->get('configuration')['results_searchbox_width']);
$form['query']['#title'] = $this
->t('Enter your keywords');
$this->googleCSEServices
->siteSearchForm($form);
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// We leave it blank intentionally.
}
}
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 | |
FormBase:: |
protected | property | The config factory. | 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:: |
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 |
GoogleCSESearchBoxForm:: |
protected | property | The object for Google CSE services. | |
GoogleCSESearchBoxForm:: |
protected | property |
RequestStack object for getting requests. Overrides FormBase:: |
|
GoogleCSESearchBoxForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
GoogleCSESearchBoxForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
GoogleCSESearchBoxForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
GoogleCSESearchBoxForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
GoogleCSESearchBoxForm:: |
public | function | GoogleCSESearchBoxForm constructor. | |
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. |