class SearchBlockForm

Same name in other branches
  1. 9 core/modules/search/src/Form/SearchBlockForm.php \Drupal\search\Form\SearchBlockForm
  2. 8.9.x core/modules/search/src/Form/SearchBlockForm.php \Drupal\search\Form\SearchBlockForm
  3. 11.x core/modules/search/src/Form/SearchBlockForm.php \Drupal\search\Form\SearchBlockForm

Builds the search form for the search block.

@internal

Hierarchy

Expanded class hierarchy of SearchBlockForm

1 file declares its use of SearchBlockForm
SearchBlock.php in core/modules/search/src/Plugin/Block/SearchBlock.php

File

core/modules/search/src/Form/SearchBlockForm.php, line 19

Namespace

Drupal\search\Form
View source
class SearchBlockForm extends FormBase implements WorkspaceSafeFormInterface {
    
    /**
     * The search page repository.
     *
     * @var \Drupal\search\SearchPageRepositoryInterface
     */
    protected $searchPageRepository;
    
    /**
     * The config factory.
     *
     * @var \Drupal\Core\Config\ConfigFactoryInterface
     */
    protected $configFactory;
    
    /**
     * The renderer.
     *
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * Constructs a new SearchBlockForm.
     *
     * @param \Drupal\search\SearchPageRepositoryInterface $search_page_repository
     *   The search page repository.
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The config factory.
     * @param \Drupal\Core\Render\RendererInterface $renderer
     *   The renderer.
     */
    public function __construct(SearchPageRepositoryInterface $search_page_repository, ConfigFactoryInterface $config_factory, RendererInterface $renderer) {
        $this->searchPageRepository = $search_page_repository;
        $this->configFactory = $config_factory;
        $this->renderer = $renderer;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('search.search_page_repository'), $container->get('config.factory'), $container->get('renderer'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'search_block_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, $entity_id = NULL) {
        // Set up the form to submit using GET to the correct search page.
        if (!$entity_id) {
            $entity_id = $this->searchPageRepository
                ->getDefaultSearchPage();
            // SearchPageRepository::getDefaultSearchPage() depends on
            // search.settings.  The dependency needs to be added before the
            // conditional return, otherwise the block would get cached without the
            // necessary cacheability metadata in case there is no default search page
            // and would not be invalidated if that changes.
            $this->renderer
                ->addCacheableDependency($form, $this->configFactory
                ->get('search.settings'));
        }
        if (!$entity_id) {
            $form['message'] = [
                '#markup' => $this->t('Search is currently disabled'),
            ];
            return $form;
        }
        $route = 'search.view_' . $entity_id;
        $form['#action'] = Url::fromRoute($route)->toString();
        $form['#method'] = 'get';
        $form['keys'] = [
            '#type' => 'search',
            '#title' => $this->t('Search'),
            '#title_display' => 'invisible',
            '#size' => 15,
            '#default_value' => '',
            '#attributes' => [
                'title' => $this->t('Enter the terms you wish to search for.'),
            ],
        ];
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Search'),
            // Prevent op from showing up in the query string.
'#name' => '',
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        // This form submits to the search page, so processing happens there.
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
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. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user. 2
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.
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 57
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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.
SearchBlockForm::$configFactory protected property The config factory. Overrides FormBase::$configFactory
SearchBlockForm::$renderer protected property The renderer.
SearchBlockForm::$searchPageRepository protected property The search page repository.
SearchBlockForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SearchBlockForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SearchBlockForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SearchBlockForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SearchBlockForm::__construct public function Constructs a new SearchBlockForm.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.