class ManageSortFieldsForm in Search API sorts 8

Provides a form for managing sort fields for a search api display.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\search_api_sorts\Form\ManageSortFieldsForm uses ConfigIdEscapeTrait

Expanded class hierarchy of ManageSortFieldsForm

1 string reference to 'ManageSortFieldsForm'

search_api_sorts.routing.yml in ./search_api_sorts.routing.yml: search_api_sorts.routing.yml

File

src/Form/ManageSortFieldsForm.php, line 22

Namespace

Drupal\search_api_sorts\Form

View source

class ManageSortFieldsForm extends FormBase {
  use ConfigIdEscapeTrait;

  /**
   * The search_api display plugin manager.
   *
   * @var \Drupal\search_api\Display\DisplayPluginManagerInterface
   */
  protected $displayPluginManager;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The search api sorts field storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $searchApiSortsFieldStorage;

  /**
   * The index this search api display is attached to.
   *
   * @var string
   */
  protected $index;

  /**
   * The search api display used by the form.
   *
   * @var string
   */
  protected $display;

  /**
   * Constructs the DisplaySortsForm object.
   *
   * @param \Drupal\search_api\Display\DisplayPluginManagerInterface $display_plugin_manager
   *   The search_api display plugin manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager.
   * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
   *   The language manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler.
   */
  public function __construct(DisplayPluginManagerInterface $display_plugin_manager, EntityTypeManagerInterface $entity_type_manager, LanguageManagerInterface $languageManager, ModuleHandlerInterface $moduleHandler) {
    $this->displayPluginManager = $display_plugin_manager;
    $this->languageManager = $languageManager;
    $this->moduleHandler = $moduleHandler;
    $this->searchApiSortsFieldStorage = $entity_type_manager
      ->getStorage('search_api_sorts_field');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.search_api.display'), $container
      ->get('entity_type.manager'), $container
      ->get('language_manager'), $container
      ->get('module_handler'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, IndexInterface $search_api_index = NULL, $search_api_display = NULL) {
    $original_search_api_display = $this
      ->getOriginalConfigId($search_api_display);
    $this->display = $this->displayPluginManager
      ->createInstance($original_search_api_display);
    $this->index = $search_api_index;
    if ($disabled = empty($this->index
      ->status())) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Since the index for this display is at the moment disabled, no sorts can be activated.'));
    }
    $form['#title'] = $this
      ->t('Manage sort fields for %label', [
      '%label' => $this->display
        ->label(),
    ]);
    $form['description'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Select the available sorts'),
      '#description' => $this
        ->t('<p>Only index single-value strings or numbers can be used as sorts. See the Fields tab to change indexed fields.</p>'),
    ];
    if ($this->languageManager
      ->getDefaultLanguage()
      ->getId() !== $this->languageManager
      ->getCurrentLanguage()
      ->getId()) {
      $form['translation_message'] = [
        '#theme' => 'status_messages',
        '#message_list' => [
          MessengerInterface::TYPE_WARNING => [
            $this
              ->t('You are currently editing the %language version of the search api sorts fields.', [
              '%language' => $this->languageManager
                ->getDefaultLanguage()
                ->getName(),
            ]),
          ],
        ],
      ];
    }
    $header = [
      $this
        ->t('Weight'),
      $this
        ->t('Enabled'),
      $this
        ->t('Default sort'),
      $this
        ->t('Default order'),
      $this
        ->t('Field'),
      $this
        ->t('Type'),
      $this
        ->t('Label'),
    ];
    $sort_fields_are_translatable = $this->moduleHandler
      ->moduleExists('config_translation') && $this->languageManager
      ->isMultilingual();
    if ($sort_fields_are_translatable) {
      $header[] = $this
        ->t('Translate');
    }
    $form['sorts'] = [
      '#type' => 'table',
      '#header' => $header,
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'search-api-sort-order-weight',
        ],
      ],
      '#empty' => $this
        ->t('There are currently no fields for which sorts can be displayed.'),
    ];
    $fields = $this
      ->getSearchApiSortsFieldsValues();
    foreach ($fields as $key => $field) {
      $form['sorts'][$key]['#attributes']['class'][] = 'draggable';
      $form['sorts'][$key]['weight'] = [
        '#type' => 'weight',
        '#default_value' => $field['weight'],
        '#delta' => 100,
        '#attributes' => [
          'class' => [
            'search-api-sort-order-weight',
          ],
        ],
      ];
      $form['sorts'][$key]['status'] = [
        '#type' => 'checkbox',
        '#default_value' => $field['status'],
        '#disabled' => $disabled,
      ];
      $form['sorts'][$key]['default_sort'] = [
        '#type' => 'radio',
        '#return_value' => $key,
        '#tree' => FALSE,
        '#default_value' => $field['default_sort'] === TRUE ? $key : NULL,
        '#states' => [
          'enabled' => [
            ':input[name="sorts[' . $key . '][status]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      $form['sorts'][$key]['default_order'] = [
        '#type' => 'select',
        '#default_value' => $field['default_order'],
        '#options' => [
          'asc' => $this
            ->t('Ascending'),
          'desc' => $this
            ->t('Descending'),
        ],
        '#states' => [
          'visible' => [
            ':input[name="sorts[' . $key . '][status]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      $form['sorts'][$key]['field'] = [
        '#markup' => Html::escape($field['field']),
      ];
      $form['sorts'][$key]['type'] = [
        '#markup' => $field['type'],
      ];
      $form['sorts'][$key]['label'] = [
        '#type' => 'textfield',
        '#maxlength' => max(strlen($field['label']), 80),
        '#size' => 30,
        '#default_value' => $field['label'],
      ];
      if ($sort_fields_are_translatable && $field['status'] === TRUE) {
        $form['sorts'][$key]['translate'] = [
          '#type' => 'link',
          '#title' => $this
            ->t('Translate'),
          '#url' => Url::fromRoute('entity.search_api_sorts_field.config_translation_overview', [
            'search_api_sorts_field' => $this
              ->getEscapedConfigId($this->display
              ->getPluginId()) . '_' . $key,
          ]),
        ];
      }
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save settings'),
    ];
    return $form;
  }

  /**
   * Returns an array of all saved search api sorts fields.
   *
   * @return array
   *   An array of fields, filled with values from the index.
   */
  protected function getSearchApiSortsFieldsValues() {
    $fields = $this
      ->buildSearchApiSortsFieldsDefaultValues();
    $this
      ->fillSearchApiSortsFieldsValues($fields);
    return $fields;
  }

  /**
   * An array of sortable fields with default values.
   *
   * @return array
   *   An array of fields.
   */
  private function buildSearchApiSortsFieldsDefaultValues() {

    // Add our dummy relevance field.
    $fields = [
      'search_api_relevance' => [
        'status' => FALSE,
        'default_sort' => FALSE,
        'default_order' => 'desc',
        'field' => 'Relevance',
        'type' => 'decimal',
        'label' => $this
          ->t('Relevance'),
        'weight' => 0,
      ],
    ];
    foreach ($this->index
      ->getFields() as $field) {

      // Skip fulltext or multi-value, you cannot sort them.
      if ($field
        ->getType() == 'text' || strpos($field
        ->getType(), 'list<') !== FALSE) {
        continue;
      }
      $fields[$field
        ->getFieldIdentifier()] = [
        'status' => FALSE,
        'default_sort' => FALSE,
        'default_order' => 'asc',
        'field' => $field
          ->getLabel(),
        'type' => $field
          ->getType(),
        'label' => $field
          ->getLabel(),
        'weight' => 0,
      ];
    }
    return $fields;
  }

  /**
   * Fills the array build by buildDefaultFieldValues().
   *
   * @param array $fields
   *   An array of fields, filled with data from the index.
   */
  private function fillSearchApiSortsFieldsValues(array &$fields) {
    $search_api_sorts_fields = $this->searchApiSortsFieldStorage
      ->loadByProperties([
      'display_id' => $this
        ->getEscapedConfigId($this->display
        ->getPluginId()),
    ]);
    foreach ($search_api_sorts_fields as $search_api_sorts_field) {
      if (isset($fields[$search_api_sorts_field
        ->getFieldIdentifier()])) {
        $fields[$search_api_sorts_field
          ->getFieldIdentifier()]['status'] = $search_api_sorts_field
          ->getStatus();
        $fields[$search_api_sorts_field
          ->getFieldIdentifier()]['default_sort'] = $search_api_sorts_field
          ->getDefaultSort();
        $fields[$search_api_sorts_field
          ->getFieldIdentifier()]['default_order'] = $search_api_sorts_field
          ->getDefaultOrder();
        $fields[$search_api_sorts_field
          ->getFieldIdentifier()]['label'] = $search_api_sorts_field
          ->getLabel();
        $fields[$search_api_sorts_field
          ->getFieldIdentifier()]['weight'] = $search_api_sorts_field
          ->getWeight();
      }
    }

    // Sort the fields by the weight element.
    uasort($fields, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    foreach ($form_state
      ->getValue('sorts') as $key => $v) {
      if ($v['status']) {
        if (!$v['label']) {
          $form_state
            ->setErrorByName("sorts][{$key}][label", $this
            ->t("You can't set an empty label."));
        }
        elseif (strlen($v['label']) > 80) {
          $form_state
            ->setErrorByName("sorts][{$key}][label", $this
            ->t('Labels cannot be longer than 80 characters, but "@label" is @count characters long.', [
            '@label' => $v['label'],
            '@count' => strlen($v['label']),
          ]));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $search_api_sorts_fields = $this->searchApiSortsFieldStorage
      ->loadByProperties([
      'display_id' => $this
        ->getEscapedConfigId($this->display
        ->getPluginId()),
    ]);
    foreach ($form_state
      ->getValue('sorts') as $key => $v) {
      $config_id = $this
        ->getEscapedConfigId($this->display
        ->getPluginId()) . '_' . $key;
      $search_api_sorts_field = NULL;
      if (isset($search_api_sorts_fields[$this
        ->getEscapedConfigId($config_id)])) {

        // If the field sort is not enabled, delete the config if it exists.
        if ($v['status'] == 0) {
          $search_api_sorts_fields[$config_id]
            ->delete();
        }
        else {
          $search_api_sorts_field = $search_api_sorts_fields[$config_id];
        }
      }
      else {

        // Create configs only for enabled sort fields.
        if ($v['status'] == 1) {
          $search_api_sorts_field = SearchApiSortsField::create([
            'langcode' => $this->languageManager
              ->getDefaultLanguage()
              ->getId(),
          ]);
          $search_api_sorts_field
            ->set('id', $config_id);
          $search_api_sorts_field
            ->set('field_identifier', $key);
          $search_api_sorts_field
            ->set('display_id', $this
            ->getEscapedConfigId($this->display
            ->getPluginId()));
        }
      }

      // Set all fields from the form to enabled configs only and save the
      // config.
      if ($v['status'] == 1) {
        $search_api_sorts_field
          ->set('status', $v['status']);
        $search_api_sorts_field
          ->set('default_sort', $form_state
          ->getValue('default_sort') == $key);
        $search_api_sorts_field
          ->set('default_order', $v['default_order']);
        $search_api_sorts_field
          ->set('label', $v['label']);
        $search_api_sorts_field
          ->set('weight', $v['weight']);
        $search_api_sorts_field
          ->save();
      }
    }
    $this
      ->messenger()
      ->addStatus($this
      ->t('The changes were successfully saved.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigIdEscapeTrait::getEscapedConfigId	protected	function	Escape a config id which can be used to save as a config entity.
ConfigIdEscapeTrait::getOriginalConfigId	protected	function	Get original config id after loading a config entity using an escaped id.
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::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.
ManageSortFieldsForm::$display	protected	property	The search api display used by the form.
ManageSortFieldsForm::$displayPluginManager	protected	property	The search_api display plugin manager.
ManageSortFieldsForm::$index	protected	property	The index this search api display is attached to.
ManageSortFieldsForm::$languageManager	protected	property	The language manager.
ManageSortFieldsForm::$moduleHandler	protected	property	The module handler.
ManageSortFieldsForm::$searchApiSortsFieldStorage	protected	property	The search api sorts field storage.
ManageSortFieldsForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ManageSortFieldsForm::buildSearchApiSortsFieldsDefaultValues	private	function	An array of sortable fields with default values.
ManageSortFieldsForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ManageSortFieldsForm::fillSearchApiSortsFieldsValues	private	function	Fills the array build by buildDefaultFieldValues().
ManageSortFieldsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ManageSortFieldsForm::getSearchApiSortsFieldsValues	protected	function	Returns an array of all saved search api sorts fields.
ManageSortFieldsForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ManageSortFieldsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ManageSortFieldsForm::__construct	public	function	Constructs the DisplaySortsForm object.
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.
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 ManageSortFieldsForm in Search API sorts 8

Hierarchy

File

Namespace

Members

API Navigation