class ServerStatusForm in Search API 8

Provides a form for performing common actions on a server.

View source

class ServerStatusForm extends FormBase {

  /**
   * The server task manager.
   *
   * @var \Drupal\search_api\Task\ServerTaskManagerInterface|null
   */
  protected $serverTaskManager;

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

    /** @var static $form */
    $form = parent::create($container);
    $form
      ->setServerTaskManager($container
      ->get('search_api.server_task_manager'));
    return $form;
  }

  /**
   * Retrieves the server task manager.
   *
   * @return \Drupal\search_api\Task\ServerTaskManagerInterface
   *   The server task manager.
   */
  public function getServerTaskManager() {
    return $this->serverTaskManager ?: \Drupal::service('search_api.server_task_manager');
  }

  /**
   * Sets the server task manager.
   *
   * @param \Drupal\search_api\Task\ServerTaskManagerInterface $server_task_manager
   *   The new server task manager.
   *
   * @return $this
   */
  public function setServerTaskManager(ServerTaskManagerInterface $server_task_manager) {
    $this->serverTaskManager = $server_task_manager;
    return $this;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, ServerInterface $server = NULL) {
    $form['#server'] = $server;
    $pending_tasks = $this
      ->getServerTaskManager()
      ->getCount($server);
    if ($pending_tasks) {
      $status = $this
        ->formatPlural($pending_tasks, 'There is currently @count task pending for this server.', 'There are currently @count tasks pending for this server.');
      $form['tasks'] = [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Pending server tasks'),
      ];
      $form['tasks']['help'] = [
        '#type' => 'item',
        '#title' => $status,
        '#description' => $this
          ->t('Pending tasks are created when operations on the server, such as deleting one or more items, cannot be executed because the server is currently unavailable (which will usually also create an entry in the Drupal logs). They are automatically tried again before any other operation is executed and the operation is aborted if the tasks could still not be executed, or if there are too many pending tasks to be executed in a single page request. In the latter case, you can use this form to manually execute all tasks and thus unblock the server again.'),
      ];
      $form['tasks']['execute'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Execute tasks now'),
        '#disabled' => !$server
          ->isAvailable(),
        '#submit' => [
          '::executeTasks',
        ],
      ];
    }
    $form['actions']['#type'] = 'actions';
    $form['actions']['clear'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Delete all indexed data on this server'),
      '#button_type' => 'danger',
    ];
    return $form;
  }

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

    /** @var \Drupal\search_api\ServerInterface $server */
    $server = $form['#server'];
    $this
      ->getServerTaskManager()
      ->setExecuteBatch($server);
  }

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

    // Redirect to the "Clear server" confirmation form.

    /** @var \Drupal\search_api\ServerInterface $server */
    $server = $form['#server'];
    $form_state
      ->setRedirect('entity.search_api_server.clear', [
      'search_api_server' => $server
        ->id(),
    ]);
  }

}

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.
ServerStatusForm::$serverTaskManager	protected	property	The server task manager.
ServerStatusForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ServerStatusForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ServerStatusForm::executeTasks	public	function
ServerStatusForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ServerStatusForm::getServerTaskManager	public	function	Retrieves the server task manager.
ServerStatusForm::setServerTaskManager	public	function	Sets the server task manager.
ServerStatusForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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 ServerStatusForm in Search API 8

Hierarchy

File

Namespace

Members

API Navigation