You are here

class SolrConfigForm in Search API Solr 4.x

Same name and namespace in other branches
  1. 8.3 src/Form/SolrConfigForm.php \Drupal\search_api_solr\Form\SolrConfigForm
  2. 8 src/Form/SolrConfigForm.php \Drupal\search_api_solr\Form\SolrConfigForm
  3. 8.2 src/Form/SolrConfigForm.php \Drupal\search_api_solr\Form\SolrConfigForm

A basic form with a passed entity with an interface.

Hierarchy

Expanded class hierarchy of 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 19

Namespace

Drupal\search_api_solr\Form
View source
class SolrConfigForm extends FormBase {

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Constructs a SolrConfigForm object.
   *
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   */
  public function __construct(DateFormatterInterface $date_formatter) {
    $this->dateFormatter = $date_formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('date.formatter'));
  }

  /**
   * {@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 = $search_api_server ? SearchApiSolrUtility::getServerFiles($search_api_server) : [];
      if (empty($files_list)) {
        $form['info']['#markup'] = $this
          ->t('No files found.');
        return $form;
      }
      $form['files_tabs'] = [
        '#type' => 'vertical_tabs',
      ];

      // Generate a fieldset for each file.
      foreach ($files_list as $file_name => $file_info) {
        $escaped_file_name = Html::escape($file_name);
        $form['files'][$file_name] = [
          '#type' => 'details',
          '#title' => $escaped_file_name,
          '#group' => 'files_tabs',
        ];
        $data = '<h3>' . $escaped_file_name . '</h3>';
        if (isset($file_info['modified'])) {
          $data .= '<p><em>' . $this
            ->t('Last modified: @time.', [
            '@time' => $this->dateFormatter
              ->format(strtotime($file_info['modified'])),
          ]) . '</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).', [
        '@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.
   *
   * @throws \Drupal\search_api\SearchApiException
   */
  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

Namesort descending 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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
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. 27
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.
SolrConfigForm::$dateFormatter protected property The date formatter service.
SolrConfigForm::access public function Checks access for the Solr config form.
SolrConfigForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SolrConfigForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SolrConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SolrConfigForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SolrConfigForm::__construct public function Constructs a SolrConfigForm object.
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.