You are here

Home » API reference » Search API Solr 8.3 » IndexSolrMultisiteUpdateForm.php

class IndexSolrMultisiteUpdateForm in Search API Solr 8.3

Same name and namespace in other branches
  1. 4.x src/Form/IndexSolrMultisiteUpdateForm.php \Drupal\search_api_solr\Form\IndexSolrMultisiteUpdateForm

Provides a form for the Index entity.

Hierarchy

Expanded class hierarchy of IndexSolrMultisiteUpdateForm

1 file declares its use of IndexSolrMultisiteUpdateForm
search_api_solr.module in ./search_api_solr.module

File

src/Form/IndexSolrMultisiteUpdateForm.php, line 11

Namespace

Drupal\search_api_solr\Form
View source 
class IndexSolrMultisiteUpdateForm extends IndexSolrMultisiteCloneForm {

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function form(array $form, FormStateInterface $form_state) {

    // If the form is being rebuilt, rebuild the entity with the current form
    // values.
    if ($form_state
      ->isRebuilding()) {

      // When the form is being built for an AJAX response the ID is not present
      // in $form_state. To ensure our entity is always valid, we're adding the
      // ID back.
      if (!$this->entity
        ->isNew()) {
        $form_state
          ->setValue('id', $this->entity
          ->id());
      }
      $this->entity = $this
        ->buildEntity($form, $form_state);
    }
    if (!$this->entity
      ->isNew()) {

      /** @var \Drupal\search_api\ServerInterface $server */
      $server = $this->entity
        ->getServerInstance();

      /** @var \Drupal\search_api_solr\SolrBackendInterface $backend */
      $backend = $server
        ->getBackend();

      /** @var \Drupal\search_api\Datasource\DatasourceInterface $datasource */
      $datasource = $this->entity
        ->getDatasource('solr_multisite_document');

      /** @var \Drupal\search_api\IndexInterface $target_index */
      $target_index = $this->entityTypeManager
        ->getStorage('search_api_index')
        ->load($datasource
        ->getConfiguration()['target_index_machine_name']);
      $fields = $target_index
        ->getFields();
      $solr_field_names = $backend
        ->getSolrFieldNames($target_index);
      foreach ($fields as $field_id => $field) {
        $field
          ->setDatasourceId('solr_multisite_document');
        $field
          ->setConfiguration([]);
        $field
          ->setPropertyPath($solr_field_names[$field_id]);
      }
      $this->entity
        ->setFields($fields);
      $this->entity
        ->setProcessors($target_index
        ->getProcessors());
      $target_index_prefixed = $backend
        ->getTargetedIndexId($target_index);
    }
    $form = IndexForm::form($form, $form_state);
    $arguments = [
      '%label' => $this->entity
        ->label(),
    ];
    $form['#title'] = $this
      ->t('Update multisite search index %label', $arguments);
    $this
      ->buildEntityForm($form, $form_state, $this->entity);
    $form['datasource_configs']['solr_multisite_document']['target_index']['#default_value'] = $target_index_prefixed;
    return $form;
  }

}

Members

Namesort descending 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
EntityForm::$entity protected property The entity being used by this form. 7
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
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.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 10
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
EntityForm::getOperation public function Gets the operation identifying the form. 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 Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::__get public function
EntityForm::__set public function
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.
IndexForm::$entityTypeManager protected property The entity type manager. Overrides EntityForm::$entityTypeManager
IndexForm::$messenger protected property The messenger. Overrides MessengerTrait::$messenger
IndexForm::$originalEntity protected property The index before the changes.
IndexForm::$pluginHelper protected property The plugin helper.
IndexForm::actions public function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
IndexForm::buildAjaxDatasourceConfigForm public function Handles changes to the selected datasources.
IndexForm::buildAjaxTrackerConfigForm public function Handles switching the selected tracker plugin.
IndexForm::buildDatasourcesConfigForm public function Builds the configuration forms for all selected datasources.
IndexForm::buildEntityForm public function Builds the form for the basic index properties.
IndexForm::buildTrackerConfigForm public function Builds the tracker configuration form.
IndexForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
IndexForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
IndexForm::submitAjaxDatasourceConfigForm public function Form submission handler for buildEntityForm().
IndexForm::submitAjaxTrackerConfigForm public function Form submission handler for buildEntityForm().
IndexForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
IndexForm::__construct public function Constructs an IndexForm object.
IndexSolrMultisiteCloneForm::getServerOptions protected function Retrieves all available servers as an options list. Overrides IndexForm::getServerOptions
IndexSolrMultisiteCloneForm::submitForm public function Overrides IndexForm::submitForm
IndexSolrMultisiteUpdateForm::form public function Overrides IndexSolrMultisiteCloneForm::form
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 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.