class TextExtractorFormSettings in Search API attachments 8

Same name and namespace in other branches

9.0.x src/Form/TextExtractorFormSettings.php \Drupal\search_api_attachments\Form\TextExtractorFormSettings

Configuration form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\search_api_attachments\Form\TextExtractorFormSettings

Expanded class hierarchy of TextExtractorFormSettings

1 string reference to 'TextExtractorFormSettings'

search_api_attachments.routing.yml in ./search_api_attachments.routing.yml: search_api_attachments.routing.yml

File

src/Form/TextExtractorFormSettings.php, line 18

Namespace

Drupal\search_api_attachments\Form

View source

class TextExtractorFormSettings extends ConfigFormBase {

  /**
   * Name of the config being edited.
   */
  const CONFIGNAME = 'search_api_attachments.admin_config';

  /**
   * Text extractor plugin Manager.
   *
   * @var \Drupal\search_api_attachments\TextExtractorPluginManager
   */
  private $textExtractorPluginManager;

  /**
   * Entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, TextExtractorPluginManager $text_extractor_plugin_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($config_factory);
    $this->textExtractorPluginManager = $text_extractor_plugin_manager;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('plugin.manager.search_api_attachments.text_extractor'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      static::CONFIGNAME,
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config(static::CONFIGNAME);
    $form['extraction_method'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Extraction method'),
      '#description' => $this
        ->t('Select the extraction method you want to use.'),
      '#empty_value' => '',
      '#options' => $this
        ->getExtractionPluginInformations()['labels'],
      '#default_value' => $config
        ->get('extraction_method'),
      '#required' => TRUE,
      '#ajax' => [
        'callback' => [
          get_class($this),
          'buildAjaxTextExtractorConfigForm',
        ],
        'wrapper' => 'search-api-attachments-extractor-config-form',
        'method' => 'replace',
        'effect' => 'fade',
      ],
    ];
    $this
      ->buildTextExtractorConfigForm($form, $form_state);
    $trigger = $form_state
      ->getTriggeringElement();
    if (!empty($trigger['#is_button'])) {
      $this
        ->buildTextExtractorTestResultForm($form, $form_state);
    }
    $url = Url::fromRoute('system.performance_settings')
      ->toString();
    $form['preserve_cache'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Preserve cached extractions across cache clears.'),
      '#default_value' => $config
        ->get('preserve_cache'),
      '#description' => $this
        ->t('When checked, <a href=":url">clearing the sitewide cache</a> will not clear the cache of extracted files.', [
        ':url' => $url,
      ]),
    ];
    $form['read_text_files_directly'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Get contents of text attachments directly using file_get_contents.'),
      '#default_value' => $config
        ->get('read_text_files_directly'),
      '#description' => $this
        ->t('When checked, get contents of text files directly using file_get_contents, rather than sending the whole file to Solr. This may cause problems when reading non-UTF-8 text files.'),
    ];
    $form['actions']['submit']['#value'] = $this
      ->t('Submit and test extraction');
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::CONFIGNAME);

    // If it is from the configuration.
    $extractor_plugin_id = $form_state
      ->getValue('extraction_method');
    if ($extractor_plugin_id) {
      $configuration = $config
        ->get($extractor_plugin_id . '_configuration');
      $extractor_plugin = $this
        ->getTextExtractorPluginManager()
        ->createInstance($extractor_plugin_id, $configuration);

      // Validate the text_extractor_config part of the form only if it
      // corresponds to the current $extractor_plugin_id.
      if (!empty($form['text_extractor_config']['extraction_method']['#value']) && $form['text_extractor_config']['extraction_method']['#value'] == $extractor_plugin_id) {
        $extractor_plugin
          ->validateConfigurationForm($form, $form_state);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::CONFIGNAME);

    // It is due to the ajax.
    $extractor_plugin_id = $form_state
      ->getValue('extraction_method');
    if ($extractor_plugin_id) {
      $configuration = $config
        ->get($extractor_plugin_id . '_configuration');
      $extractor_plugin = $this
        ->getTextExtractorPluginManager()
        ->createInstance($extractor_plugin_id, $configuration);
      $extractor_plugin
        ->submitConfigurationForm($form, $form_state);
    }
    $config = $this
      ->configFactory()
      ->getEditable(static::CONFIGNAME);

    // Set the extraction method variable.
    $config
      ->set('extraction_method', $extractor_plugin_id);

    // Set the redad text files directly option.
    $config
      ->set('read_text_files_directly', $form_state
      ->getValue('read_text_files_directly'));

    // Set the preserving cache option.
    $config
      ->set('preserve_cache', $form_state
      ->getValue('preserve_cache'));
    $config
      ->save();

    // Test the extraction.
    $file = $this
      ->getTestFile();
    $error = '';
    $extracted_data = NULL;
    try {
      $extracted_data = $extractor_plugin
        ->extract($file);
    } catch (\Exception $e) {
      $error = $e
        ->getMessage();
    }
    $file
      ->delete();
    if (empty($extracted_data)) {
      if (empty($error)) {
        $error = $this
          ->t('No error message was catched');
      }
      $data = [
        'message' => $this
          ->t("Unfortunately, the extraction doesn't seem to work with this configuration! (@error)", [
          '@error' => $error,
        ]),
        'type' => 'error',
      ];
    }
    else {
      $data = [
        'message' => $this
          ->t('Extracted data: %extracted_data', [
          '%extracted_data' => $extracted_data,
        ]),
        'type' => 'ok',
      ];
    }
    $storage = [
      'extracted_test_text' => $data,
    ];
    $form_state
      ->setStorage($storage);
    $form_state
      ->setRebuild();
  }

  /**
   * Get definition of Extraction plugins from their annotation definition.
   *
   * @return array
   *   Array with 'labels' and 'descriptions' as keys containing plugin ids
   *   and their labels or descriptions.
   */
  public function getExtractionPluginInformations() {
    $options = [
      'labels' => [],
      'descriptions' => [],
    ];
    foreach ($this
      ->getTextExtractorPluginManager()
      ->getDefinitions() as $plugin_id => $plugin_definition) {
      $options['labels'][$plugin_id] = Html::escape($plugin_definition['label']);
      $options['descriptions'][$plugin_id] = Html::escape($plugin_definition['description']);
    }
    return $options;
  }

  /**
   * Subform.
   *
   * It will be updated with Ajax to display the configuration of an
   * extraction plugin method.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   */
  public function buildTextExtractorConfigForm(array &$form, FormStateInterface $form_state) {
    $form['text_extractor_config'] = [
      '#type' => 'container',
      '#attributes' => [
        'id' => 'search-api-attachments-extractor-config-form',
      ],
      '#tree' => TRUE,
    ];
    $config = $this
      ->config(static::CONFIGNAME);
    if ($form_state
      ->getValue('extraction_method') != '') {

      // It is due to the ajax.
      $extractor_plugin_id = $form_state
        ->getValue('extraction_method');
    }
    else {
      $extractor_plugin_id = $config
        ->get('extraction_method');
      $ajax_submitted_empty_value = $form_state
        ->getValue('form_id');
    }
    $form['text_extractor_config']['#type'] = 'details';
    $form['text_extractor_config']['#open'] = TRUE;

    // If the form is submitted with ajax and the empty value is chosen or if
    // there is no configuration yet and no extraction method was chosen in the
    // form.
    if (isset($ajax_submitted_empty_value) || $extractor_plugin_id == '') {
      $form['text_extractor_config']['#title'] = $this
        ->t('Please make a choice');
      $form['text_extractor_config']['#description'] = $this
        ->t('Please choose an extraction method in the list above.');
    }
    else {
      $configuration = $config
        ->get($extractor_plugin_id . '_configuration');
      $extractor_plugin = $this
        ->getTextExtractorPluginManager()
        ->createInstance($extractor_plugin_id, $configuration);
      $form['text_extractor_config']['#title'] = $this
        ->t('@extractor_plugin_label configuration', [
        '@extractor_plugin_label' => $this
          ->getExtractionPluginInformations()['labels'][$extractor_plugin_id],
      ]);
      $text_extractor_form = $extractor_plugin
        ->buildConfigurationForm([], $form_state);
      $form['text_extractor_config']['extraction_method'] = [
        '#type' => 'value',
        '#value' => $extractor_plugin_id,
      ];
      $form['text_extractor_config'] += $text_extractor_form;
    }
  }

  /**
   * Subform to test the configuration of an extraction plugin method.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   */
  public function buildTextExtractorTestResultForm(array &$form, FormStateInterface $form_state) {
    if (isset($form['text_extractor_config'])) {
      $extractor_plugin_id = $form_state
        ->getValue('extraction_method');
      $form['text_extractor_config']['test_result']['#type'] = 'details';
      $form['text_extractor_config']['test_result']['#title'] = $this
        ->t('Test extractor %plugin', [
        '%plugin' => $this
          ->getExtractionPluginInformations()['labels'][$extractor_plugin_id],
      ]);
      $form['text_extractor_config']['test_result']['#open'] = TRUE;
      $storage = $form_state
        ->getStorage();
      if (empty($storage)) {

        // Put the initial thing into the storage.
        $storage = [
          'extracted_test_text' => [
            'message' => $this
              ->t("Extraction doesn't seem to work."),
            'type' => 'error',
          ],
        ];
        $form_state
          ->setStorage($storage);
      }
      $form['text_extractor_config']['test_result']['test_file_path_result'] = [
        '#theme' => 'saa',
        '#message' => $storage['extracted_test_text']['message'],
        '#type' => $storage['extracted_test_text']['type'],
        '#attached' => [
          'library' => [
            'search_api_attachments/extractor_status',
          ],
        ],
      ];
    }
  }

  /**
   * Ajax callback.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @return array
   *   subform
   */
  public static function buildAjaxTextExtractorConfigForm(array $form, FormStateInterface $form_state) {

    // We just need to return the relevant part of the form here.
    return $form['text_extractor_config'];
  }

  /**
   * Helper method to get/create a pdf test file and extract its data.
   *
   * The file created is then deleted after successful extraction.
   *
   * @return object
   *   $file
   */
  public function getTestFile() {
    $filepath = 'public://search_api_attachments_test_extraction.pdf';
    $values = [
      'uri' => $filepath,
    ];
    $file = $this->entityTypeManager
      ->getStorage('file')
      ->loadByProperties($values);
    if (empty($file)) {

      // Copy the source file to public directory.
      $source = drupal_get_path('module', 'search_api_attachments');
      $source .= '/data/search_api_attachments_test_extraction.pdf';
      copy($source, $filepath);

      // Create the file object.
      $file = File::create([
        'uri' => $filepath,
        'uid' => $this
          ->currentUser()
          ->id(),
      ]);
      $file
        ->save();
    }
    else {
      $file = reset($file);
    }
    return $file;
  }

  /**
   * Returns the text extractor plugin manager.
   *
   * @return \Drupal\search_api_attachments\TextExtractorPluginManager
   *   The text extractor plugin manager.
   */
  protected function getTextExtractorPluginManager() {
    return $this->textExtractorPluginManager ?: \Drupal::service('plugin.manager.search_api_attachments.text_extractor');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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.
TextExtractorFormSettings::$entityTypeManager	protected	property	Entity type manager service.
TextExtractorFormSettings::$textExtractorPluginManager	private	property	Text extractor plugin Manager.
TextExtractorFormSettings::buildAjaxTextExtractorConfigForm	public static	function	Ajax callback.
TextExtractorFormSettings::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
TextExtractorFormSettings::buildTextExtractorConfigForm	public	function	Subform.
TextExtractorFormSettings::buildTextExtractorTestResultForm	public	function	Subform to test the configuration of an extraction plugin method.
TextExtractorFormSettings::CONFIGNAME		constant	Name of the config being edited.
TextExtractorFormSettings::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
TextExtractorFormSettings::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
TextExtractorFormSettings::getExtractionPluginInformations	public	function	Get definition of Extraction plugins from their annotation definition.
TextExtractorFormSettings::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
TextExtractorFormSettings::getTestFile	public	function	Helper method to get/create a pdf test file and extract its data.
TextExtractorFormSettings::getTextExtractorPluginManager	protected	function	Returns the text extractor plugin manager.
TextExtractorFormSettings::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
TextExtractorFormSettings::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
TextExtractorFormSettings::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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 TextExtractorFormSettings in Search API attachments 8

Hierarchy

File

Namespace

Members

API Navigation