class SolrConfigForm in Search API Solr 8

A basic form with a passed entity with an interface.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\search_api_solr\Form\SolrConfigForm

1 string reference to 'SolrConfigForm'

search_api_solr.routing.yml in ./search_api_solr.routing.yml

search_api_solr.routing.yml

File

src/Form/SolrConfigForm.php, line 17

Namespace

Drupal\search_api_solr\Form

class SolrConfigForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, ServerInterface $search_api_server = NULL) {
    $form['#title'] = $this
      ->t('List of configuration files found');
    try {

      // Retrieve the list of available files.
      $files_list = SearchApiSolrUtility::getServerFiles($search_api_server);
      if (empty($files_list)) {
        $form['info']['#markup'] = $this
          ->t('No files found.');
        return $form;
      }
      $form['files_tabs'] = array(
        '#type' => 'vertical_tabs',
      );

      // Generate a fieldset for each file.
      foreach ($files_list as $file_name => $file_info) {
        $file_date = \Drupal::service('date.formatter')
          ->format(strtotime($file_info['modified']));
        $escaped_file_name = Html::escape($file_name);
        $form['files'][$file_name] = array(
          '#type' => 'details',
          '#title' => $escaped_file_name,
          '#group' => 'files_tabs',
        );
        $data = '<h3>' . $escaped_file_name . '</h3>';
        $data .= '<p><em>' . $this
          ->t('Last modified: @time.', array(
          '@time' => $file_date,
        )) . '</em></p>';
        if ($file_info['size'] > 0) {

          /** @var \Drupal\search_api_solr\SolrBackendInterface $backend */
          $backend = $search_api_server
            ->getBackend();
          $file_data = $backend
            ->getSolrConnector()
            ->getFile($file_name);
          $data .= '<pre><code>' . Html::escape($file_data
            ->getBody()) . '</code></pre>';
        }
        else {
          $data .= '<p><em>' . $this
            ->t('The file is empty.') . '</em></p>';
        }
        $form['files'][$file_name]['data']['#markup'] = $data;
      }
    } catch (SearchApiException $e) {
      watchdog_exception('search_api_solr', $e, '%type while retrieving config files of Solr server @server: @message in %function (line %line of %file).', array(
        '@server' => $search_api_server
          ->label(),
      ));
      $form['info']['#markup'] = $this
        ->t('An error occured while trying to load the list of files.');
    }
    return $form;
  }

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

  /**
   * Checks access for the Solr config form.
   *
   * @param \Drupal\search_api\ServerInterface $search_api_server
   *   The server for which access should be tested.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function access(ServerInterface $search_api_server) {
    return AccessResult::allowedIf($search_api_server
      ->hasValidBackend() && $search_api_server
      ->getBackend() instanceof SearchApiSolrBackend)
      ->addCacheableDependency($search_api_server);
  }

}

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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.
SolrConfigForm::access	public	function	Checks access for the Solr config form.
SolrConfigForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
SolrConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SolrConfigForm::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.