class GoogleCSESearchBoxForm in Google Custom Search Engine 8.3

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

File

src/Form/GoogleCSESearchBoxForm.php, line 18

Namespace

Drupal\google_cse\Form

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'] = $this->googleCSEServices
        ->getProtocol() . $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['keys'] = [
      '#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['keys']['#size'] = intval($config
      ->get('configuration')['results_searchbox_width']);
    $form['keys']['#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::$_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::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
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
GoogleCSESearchBoxForm::$googleCSEServices	protected	property	The object for Google CSE services.
GoogleCSESearchBoxForm::$requestStack	protected	property	RequestStack object for getting requests. Overrides FormBase::$requestStack
GoogleCSESearchBoxForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
GoogleCSESearchBoxForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
GoogleCSESearchBoxForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
GoogleCSESearchBoxForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
GoogleCSESearchBoxForm::__construct	public	function	GoogleCSESearchBoxForm constructor.
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.