class SearchPageFormBase

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

Provides a base form for search pages.

Hierarchy

Expanded class hierarchy of SearchPageFormBase

File

core/modules/search/src/Form/SearchPageFormBase.php, line 14

Namespace

Drupal\search\Form
View source
abstract class SearchPageFormBase extends EntityForm {
    
    /**
     * The entity being used by this form.
     *
     * @var \Drupal\search\SearchPageInterface
     */
    protected $entity;
    
    /**
     * The search plugin being configured.
     *
     * @var \Drupal\search\Plugin\SearchInterface
     */
    protected $plugin;
    
    /**
     * The search page repository.
     *
     * @var \Drupal\search\SearchPageRepositoryInterface
     */
    protected $searchPageRepository;
    
    /**
     * Constructs a new search form.
     *
     * @param \Drupal\search\SearchPageRepositoryInterface $search_page_repository
     *   The search page repository.
     */
    public function __construct(SearchPageRepositoryInterface $search_page_repository) {
        $this->searchPageRepository = $search_page_repository;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('search.search_page_repository'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getBaseFormId() {
        return 'search_entity_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $this->plugin = $this->entity
            ->getPlugin();
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function form(array $form, FormStateInterface $form_state) {
        $form['label'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Label'),
            '#description' => $this->t('The label for this search page.'),
            '#default_value' => $this->entity
                ->label(),
            '#maxlength' => '255',
        ];
        $form['id'] = [
            '#type' => 'machine_name',
            '#default_value' => $this->entity
                ->id(),
            '#disabled' => !$this->entity
                ->isNew(),
            '#maxlength' => 64,
            '#machine_name' => [
                'exists' => [
                    $this,
                    'exists',
                ],
            ],
        ];
        $form['path'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Path'),
            '#field_prefix' => 'search/',
            '#default_value' => $this->entity
                ->getPath(),
            '#maxlength' => '255',
            '#required' => TRUE,
        ];
        $form['plugin'] = [
            '#type' => 'value',
            '#value' => $this->entity
                ->get('plugin'),
        ];
        if ($this->plugin instanceof PluginFormInterface) {
            $form += $this->plugin
                ->buildConfigurationForm($form, $form_state);
        }
        return parent::form($form, $form_state);
    }
    
    /**
     * Determines if the search page entity already exists.
     *
     * @param string $id
     *   The search configuration ID.
     *
     * @return bool
     *   TRUE if the search configuration exists, FALSE otherwise.
     */
    public function exists($id) {
        $entity = $this->entityTypeManager
            ->getStorage('search_page')
            ->getQuery()
            ->condition('id', $id)
            ->execute();
        return (bool) $entity;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        parent::validateForm($form, $form_state);
        // Ensure each path is unique.
        $path = $this->entityTypeManager
            ->getStorage('search_page')
            ->getQuery()
            ->condition('path', $form_state->getValue('path'))
            ->condition('id', $form_state->getValue('id'), '<>')
            ->execute();
        if ($path) {
            $form_state->setErrorByName('path', $this->t('The search page path must be unique.'));
        }
        if ($this->plugin instanceof PluginFormInterface) {
            $this->plugin
                ->validateConfigurationForm($form, $form_state);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        parent::submitForm($form, $form_state);
        if ($this->plugin instanceof PluginFormInterface) {
            $this->plugin
                ->submitConfigurationForm($form, $form_state);
        }
        return $this->entity;
    }
    
    /**
     * {@inheritdoc}
     */
    public function save(array $form, FormStateInterface $form_state) {
        $this->entity
            ->save();
        $form_state->setRedirectUrl($this->entity
            ->toUrl('collection'));
    }

}

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
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service. 2
EntityForm::$operation protected property The name of the current operation.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 36
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data. 1
EntityForm::buildEntity public function Overrides EntityFormInterface::buildEntity 5
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 11
EntityForm::getEntity public function Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Overrides FormInterface::getFormId 13
EntityForm::getOperation public function Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Overrides EntityFormInterface::setOperation
FormBase::$configFactory protected property The config factory. 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. 2
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.
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 &#039;destination&#039; 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.
SearchPageFormBase::$entity protected property The entity being used by this form. Overrides EntityForm::$entity
SearchPageFormBase::$plugin protected property The search plugin being configured.
SearchPageFormBase::$searchPageRepository protected property The search page repository.
SearchPageFormBase::buildForm public function Overrides EntityForm::buildForm 1
SearchPageFormBase::create public static function Overrides FormBase::create
SearchPageFormBase::exists public function Determines if the search page entity already exists.
SearchPageFormBase::form public function Overrides EntityForm::form
SearchPageFormBase::getBaseFormId public function Overrides EntityForm::getBaseFormId
SearchPageFormBase::save public function Overrides EntityForm::save 2
SearchPageFormBase::submitForm public function Overrides EntityForm::submitForm
SearchPageFormBase::validateForm public function Overrides FormBase::validateForm
SearchPageFormBase::__construct public function Constructs a new search form.
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.