class SearchApiPageBlockForm in Search API Pages 8

Builds the search form for the search api page block.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\search_api_page\Form\SearchApiPageBlockForm implements BaseFormIdInterface

Expanded class hierarchy of SearchApiPageBlockForm

1 file declares its use of SearchApiPageBlockForm

SearchApiPageBlock.php in src/Plugin/Block/SearchApiPageBlock.php

1 string reference to 'SearchApiPageBlockForm'

search_api_page.services.yml in ./search_api_page.services.yml: search_api_page.services.yml

1 service uses SearchApiPageBlockForm

block_form.search_api_page in ./search_api_page.services.yml: Drupal\search_api_page\Form\SearchApiPageBlockForm

File

src/Form/SearchApiPageBlockForm.php, line 18

Namespace

Drupal\search_api_page\Form

View source

class SearchApiPageBlockForm extends FormBase implements BaseFormIdInterface {

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The page id.
   *
   * @var string
   */
  protected $pageId = 'uninitialized';

  /**
   * The storage for Search API Page entities.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $pageStorage;

  /**
   * Constructs a new SearchBlockForm.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Drupal\Core\Entity\EntityStorageInterface $pageStorage
   *   The search API page storage
   */
  public function __construct(LanguageManagerInterface $language_manager, RendererInterface $renderer, EntityStorageInterface $pageStorage) {
    $this->languageManager = $language_manager;
    $this->renderer = $renderer;
    $this->pageStorage = $pageStorage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager */
    $entityTypeManager = $container
      ->get('entity_type.manager');
    return new static($container
      ->get('language_manager'), $container
      ->get('renderer'), $entityTypeManager
      ->getStorage('search_api_page'));
  }

  /**
   * Sets the search API page id.
   *
   * @param string $pageId
   *   Search API page ID.
   */
  public function setPageId($pageId) {
    $this->pageId = $pageId;
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseFormId() {
    return 'search_api_page_block_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'search_api_page_block_form_' . $this->pageId;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $args = []) {

    /* @var $search_api_page \Drupal\search_api_page\SearchApiPageInterface */
    $search_api_page = $this->pageStorage
      ->load($this->pageId);
    $langcode = $this->languageManager
      ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
      ->getId();
    $form['search_api_page'] = [
      '#type' => 'value',
      '#value' => $search_api_page
        ->id(),
    ];
    $default_value = '';
    if (isset($args['keys'])) {
      $default_value = $args['keys'];
    }
    if ($default_value === '') {
      $request = $this
        ->getRequest();
      if (trim($search_api_page
        ->getPath(), '/') === trim($request
        ->getPathInfo(), '/')) {
        $default_value = $this
          ->getRequest()
          ->get('keys');
      }
    }
    $keys_title = $this
      ->t('Enter the terms you wish to search for.', [], [
      'langcode' => $langcode,
    ]);
    $form['keys'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Search', [], [
        'langcode' => $langcode,
      ]),
      '#title_display' => 'invisible',
      '#size' => 15,
      '#default_value' => $default_value,
      '#attributes' => [
        'title' => $keys_title,
      ],
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Search', [], [
        'langcode' => $langcode,
      ]),
    ];
    if (!$search_api_page
      ->getCleanUrl()) {
      $route = 'search_api_page.' . $langcode . '.' . $search_api_page
        ->id();
      $form['#action'] = Url::fromRoute($route)
        ->toString();
      $form['#method'] = 'get';
      $form['actions']['submit']['#name'] = '';
    }

    // Dependency on search api config entity.
    $this->renderer
      ->addCacheableDependency($form, $search_api_page
      ->getConfigDependencyName());
    $this->renderer
      ->addCacheableDependency($form, $langcode);

    // Match the search form styling of Drupal core.
    $form['#attributes']['class'][] = 'search-form';
    $form['#attributes']['class'][] = 'search-block-form';
    $form['#attributes']['class'][] = 'container-inline';
    $form['actions']['submit']['#attributes']['class'][] = 'search-form__submit';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // This form submits to the search page, so processing happens there.
    $langcode = $this->languageManager
      ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
      ->getId();
    $route = 'search_api_page.' . $langcode . '.' . $form_state
      ->getValue('search_api_page');
    $routeArguments = [
      'keys' => $form_state
        ->getValue('keys'),
    ];
    $form_state
      ->setRedirectUrl(Url::fromRoute($route, $routeArguments));
  }

}

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::$requestStack	protected	property	The request stack.	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
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.
SearchApiPageBlockForm::$languageManager	protected	property	The language manager.
SearchApiPageBlockForm::$pageId	protected	property	The page id.
SearchApiPageBlockForm::$pageStorage	protected	property	The storage for Search API Page entities.
SearchApiPageBlockForm::$renderer	protected	property	The renderer.
SearchApiPageBlockForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
SearchApiPageBlockForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
SearchApiPageBlockForm::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId
SearchApiPageBlockForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SearchApiPageBlockForm::setPageId	public	function	Sets the search API page id.
SearchApiPageBlockForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
SearchApiPageBlockForm::__construct	public	function	Constructs a new SearchBlockForm.
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 SearchApiPageBlockForm in Search API Pages 8

Hierarchy

File

Namespace

Members

API Navigation