You are here

Home » API reference » Search File Attachments 8 » SearchFileAttachmentsSettingsForm.php

class SearchFileAttachmentsSettingsForm in Search File Attachments 8

Configure search file attachments settings.

Hierarchy

Expanded class hierarchy of SearchFileAttachmentsSettingsForm

1 string reference to 'SearchFileAttachmentsSettingsForm'
search_file_attachments.routing.yml in ./search_file_attachments.routing.yml
search_file_attachments.routing.yml

File

src/Form/SearchFileAttachmentsSettingsForm.php, line 12

Namespace

Drupal\search_file_attachments\Form
View source 
class SearchFileAttachmentsSettingsForm extends ConfigFormBase {
  protected $javaService;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
    $this->javaService = \Drupal::service('search_file_attachments.java');
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'search_file_attachments.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('search_file_attachments.settings');

    // Apache Tika configuration.
    $form['tika'] = array(
      '#type' => 'fieldset',
      '#title' => t('Apache Tika'),
    );
    $form['tika']['search_file_attachments_tika_path'] = array(
      '#type' => 'textfield',
      '#title' => t('Tika directory path'),
      '#default_value' => $config
        ->get('tika.path'),
      '#description' => t('The full path to tika directory.'),
      '#required' => TRUE,
    );
    $form['tika']['search_file_attachments_tika_jar'] = array(
      '#type' => 'textfield',
      '#title' => t('Tika jar file'),
      '#default_value' => $config
        ->get('tika.jar'),
      '#description' => t('The name of the tika CLI application jar file, e.g. tika-app-1.xx.jar.'),
      '#required' => TRUE,
    );
    if (!$this->javaService
      ->checkJava()) {
      $form['tika']['search_file_attachments_java_path'] = array(
        '#type' => 'textfield',
        '#title' => t('Java path'),
        '#default_value' => $config
          ->get('java_path'),
        '#description' => t('The full path to the Java binary. This setting is only needed if Java could not automatically detected.'),
        '#required' => TRUE,
      );
    }

    // File settings.
    $form['files'] = array(
      '#type' => 'fieldset',
      '#title' => t('File settings'),
    );
    $form['files']['search_file_attachments_include'] = array(
      '#type' => 'textfield',
      '#title' => t('Included file extensions or mimetypes'),
      '#description' => t('A comma-separated list of file extensions or mimetypes that will be included to the file search index.'),
      '#default_value' => $config
        ->get('files.include'),
      '#required' => TRUE,
    );

    // Advanced settings.
    $form['advanced'] = array(
      '#type' => 'details',
      '#title' => t('Advanced settings'),
      '#open' => FALSE,
    );
    $form['advanced']['search_file_attachments_debug'] = array(
      '#type' => 'checkbox',
      '#title' => t('Activate Debugging'),
      '#description' => t('Activate this option only for development and not on production sites.'),
      '#default_value' => $config
        ->get('debug'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $tika_path = rtrim($form_state
      ->getValue('search_file_attachments_tika_path'), '/');
    $tika_path = realpath($tika_path);
    if (!file_exists($tika_path . '/' . $form_state
      ->getValue('search_file_attachments_tika_jar'))) {
      $form_state
        ->setErrorByName('search_file_attachments_tika_path', $this
        ->t('Tika jar file not found at this path.'));
    }
    $java_path = $form_state
      ->getValue('search_file_attachments_java_path');
    $this->javaService
      ->setJavaPath($java_path);
    if (!empty($java_path) && !$this->javaService
      ->checkJava()) {
      $form_state
        ->setErrorByName('search_file_attachments_java_path', $this
        ->t('Java was not found or is executable at the specified path.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('search_file_attachments.settings')
      ->set('tika.path', rtrim($form_state
      ->getValue('search_file_attachments_tika_path'), '/'))
      ->set('tika.jar', $form_state
      ->getValue('search_file_attachments_tika_jar'))
      ->set('java_path', $form_state
      ->getValue('search_file_attachments_java_path'))
      ->set('files.include', $form_state
      ->getValue('search_file_attachments_include'))
      ->set('debug', $form_state
      ->getValue('search_file_attachments_debug'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::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.
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.
SearchFileAttachmentsSettingsForm::$javaService protected property
SearchFileAttachmentsSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SearchFileAttachmentsSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SearchFileAttachmentsSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SearchFileAttachmentsSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SearchFileAttachmentsSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
SearchFileAttachmentsSettingsForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.