class SolrUploadConfigsetForm in Search API Solr 4.x

The upload configset form.

@package Drupal\search_api_solr_admin\Form

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\search_api_solr_admin\Form\SolrAdminFormBase uses \Drupal\search_api\LoggerTrait
    • class \Drupal\search_api_solr_admin\Form\SolrUploadConfigsetForm

1 string reference to 'SolrUploadConfigsetForm'

search_api_solr_admin.routing.yml in modules/search_api_solr_admin/search_api_solr_admin.routing.yml

modules/search_api_solr_admin/search_api_solr_admin.routing.yml

File

modules/search_api_solr_admin/src/Form/SolrUploadConfigsetForm.php, line 19

Namespace

Drupal\search_api_solr_admin\Form

class SolrUploadConfigsetForm extends SolrAdminFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'solr_upload_configset_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, ServerInterface $search_api_server = NULL) {
    $this->search_api_server = $search_api_server;
    $connector = Utility::getSolrCloudConnector($this->search_api_server);
    $configset = $connector
      ->getConfigSetName();
    if (!$configset) {
      $this->messenger
        ->addWarning($this
        ->t('No existing configset name could be detected on the Solr server for this collection. That\'s fine if you just create a new collection. Otherwise you should check the logs.'));
    }
    $form['#title'] = $this
      ->t('Upload Configset for %collection?', [
      '%collection' => $connector
        ->getCollectionName(),
    ]);
    $form['accept'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Upload (and overwrite) configset %configset to Solr Server.', [
        '%configset' => $configset,
      ]),
      '#decrtiption' => $configset ? $this
        ->t("The collection will be reloaded using the new configset") : $this
        ->t('A new collection will be created from the configset.'),
      '#default_value' => FALSE,
    ];
    if (!$configset) {
      $form['num_shards'] = [
        '#type' => 'number',
        '#title' => $this
          ->t('Number of shards'),
        '#description' => $this
          ->t('The number of shards to be created for the collection.'),
        '#default_value' => 3,
      ];
    }
    else {
      $form['num_shards'] = [
        '#type' => 'value',
        '#default_value' => 3,
      ];
    }
    $form['actions'] = [
      'submit' => [
        '#type' => 'submit',
        '#value' => $this
          ->t('Upload'),
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (!$form_state
      ->getValue('accept')) {
      $form_state
        ->setError($form['accept'], $this
        ->t('You must accept the action that will be taken after the configset is uploaded.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    try {
      $this->commandHelper
        ->uploadConfigset($this->search_api_server
        ->id(), (int) $form_state
        ->getValue('num_shards'), TRUE);
    } catch (\Exception $e) {
      $this->messenger
        ->addError($e
        ->getMessage());
      $this
        ->logException($e);
    }
    $form_state
      ->setRedirect('entity.search_api_server.canonical', [
      'search_api_server' => $this->search_api_server
        ->id(),
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.
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::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.
SolrAdminFormBase::$commandHelper	protected	property	The Search API server entity.
SolrAdminFormBase::$messenger	protected	property	Overrides MessengerTrait::$messenger
SolrAdminFormBase::$search_api_server	protected	property	The Search API server entity.
SolrAdminFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
SolrAdminFormBase::getLogger	protected	function	Gets the logger for a specific channel. Overrides LoggerChannelTrait::getLogger
SolrAdminFormBase::__construct	public	function	SolrDeleteCollectionForm constructor.
SolrUploadConfigsetForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
SolrUploadConfigsetForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SolrUploadConfigsetForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
SolrUploadConfigsetForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.