public function FilesExtractor::buildConfigurationForm in Search API attachments 9.0.x

Same name and namespace in other branches

8 src/Plugin/search_api/processor/FilesExtractor.php \Drupal\search_api_attachments\Plugin\search_api\processor\FilesExtractor::buildConfigurationForm()

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides PluginFormInterface::buildConfigurationForm

File

src/Plugin/search_api/processor/FilesExtractor.php, line 526

Class

FilesExtractor: Provides file fields processor.

Namespace

Drupal\search_api_attachments\Plugin\search_api\processor

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  if (isset($this->configuration['excluded_extensions'])) {
    $default_excluded_extensions = $this->configuration['excluded_extensions'];
  }
  else {
    $default_excluded_extensions = ExtractFileValidator::DEFAULT_EXCLUDED_EXTENSIONS;
  }
  $form['excluded_extensions'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Excluded file extensions'),
    '#default_value' => $default_excluded_extensions,
    '#size' => 80,
    '#maxlength' => 255,
    '#description' => $this
      ->t('File extensions that are excluded from indexing. Separate extensions with a space and do not include the leading dot.<br />Example: "aif art avi bmp gif ico mov oga ogv png psd ra ram rgb flv"<br />Extensions are internally mapped to a MIME type, so it is not necessary to put variations that map to the same type (e.g. tif is sufficient for tif and tiff)'),
  ];
  $form['number_indexed'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Number of files indexed per file field'),
    '#default_value' => isset($this->configuration['number_indexed']) ? $this->configuration['number_indexed'] : '0',
    '#size' => 5,
    '#min' => 0,
    '#max' => 999999,
    '#description' => $this
      ->t('The number of files to index per file field.<br />The order of indexation is the weight in the widget.<br /> 0 for no restriction.'),
  ];
  $form['number_first_bytes'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Limit size of the extracted string before indexing.'),
    '#default_value' => isset($this->configuration['number_first_bytes']) ? $this->configuration['number_first_bytes'] : '1 MB',
    '#size' => 5,
    '#min' => 0,
    '#max' => 99999,
    '#description' => $this
      ->t('Enter a value like "1000", "10 KB", "10 MB" or "10 GB" in order to restrict the size of the content after extraction.<br /> "0" to index the full extracted content without bytes limitation.'),
  ];
  $form['max_filesize'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Maximum upload size'),
    '#default_value' => isset($this->configuration['max_filesize']) ? $this->configuration['max_filesize'] : '0',
    '#description' => $this
      ->t('Enter a value like "10 KB", "10 MB" or "10 GB" in order to restrict the max file size of files that should be indexed.<br /> Enter "0" for no limit restriction.'),
    '#size' => 10,
  ];
  $form['excluded_private'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Exclude private files'),
    '#default_value' => isset($this->configuration['excluded_private']) ? $this->configuration['excluded_private'] : TRUE,
    '#description' => $this
      ->t('Check this box if you want to exclude private files from being indexed.'),
  ];
  return $form;
}

You are here