You are here

class AdminController in Search API sorts 8

Class AdminController.

@package Drupal\search_api_sorts\Controller

Hierarchy

Expanded class hierarchy of AdminController

File

src/Controller/AdminController.php, line 19

Namespace

Drupal\search_api_sorts\Controller
View source
class AdminController extends ControllerBase {
  use ConfigIdEscapeTrait;

  /**
   * The current request object.
   *
   * @var \Symfony\Component\HttpFoundation\Request|null
   */
  protected $currentRequest;

  /**
   * The Search API display manager.
   *
   * @var \Drupal\search_api\Display\DisplayPluginManagerInterface
   */
  protected $searchApiDisplayManager;

  /**
   * AdminController constructor.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
   *   The request stack.
   * @param \Drupal\search_api\Display\DisplayPluginManagerInterface $search_api_display_manager
   *   The Search API display manager.
   */
  public function __construct(RequestStack $requestStack, DisplayPluginManagerInterface $search_api_display_manager) {
    $this->currentRequest = $requestStack
      ->getCurrentRequest();
    $this->searchApiDisplayManager = $search_api_display_manager;
  }

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

  /**
   * Overview of search api displays to choose to manage sort fields for.
   */
  public function displayListing(IndexInterface $search_api_index) {
    $rows = [];
    foreach ($this->searchApiDisplayManager
      ->getInstances() as $display) {
      if ($display
        ->getIndex() instanceof IndexInterface && $search_api_index
        ->id() === $display
        ->getIndex()
        ->id()) {
        $row = [];
        $row['display'] = $display
          ->label();
        $row['description'] = $display
          ->getDescription();
        $search_api_display = $display
          ->getPluginId();
        $escaped_search_api_display = $this
          ->getEscapedConfigId($search_api_display);
        $links['configure'] = [
          'title' => $this
            ->t('Manage sort fields'),
          'url' => Url::fromRoute('search_api_sorts.search_api_display.sorts', [
            'search_api_index' => $search_api_index
              ->id(),
            'search_api_display' => $escaped_search_api_display,
          ]),
        ];
        $row['operations']['data'] = [
          '#type' => 'operations',
          '#links' => $links,
        ];
        $rows[] = $row;
      }
    }
    $build['table'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Display'),
        $this
          ->t('Description'),
        $this
          ->t('Operations'),
      ],
      '#title' => $this
        ->t('Sorts configuration.'),
      '#rows' => $rows,
      '#empty' => $this
        ->t('You have no search displays defined yet. An example of a display is a views page using this index, or a search api pages page.'),
    ];
    return $build;
  }

  /**
   * Callback for search_api_sorts_field edit form.
   *
   * Redirect the user to the ManageSortsFieldsForm.
   *
   * @see \Drupal\search_api_sorts\Form\ManageSortFieldsForm
   */
  public function redirectEditForm(SearchApiSortsField $search_api_sorts_field) {

    // When accessing this page from the config_translation overview,
    // a destination parameter is added, which prevents the redirect added in
    // this route method.
    $this->currentRequest->query
      ->remove('destination');
    $display_id = $this
      ->getOriginalConfigId($search_api_sorts_field
      ->getDisplayId());

    /** @var \Drupal\search_api\Display\DisplayInterface $display */
    $display = $this->searchApiDisplayManager
      ->createInstance($display_id);
    return $this
      ->redirect('search_api_sorts.search_api_display.sorts', [
      'search_api_index' => $display
        ->getIndex()
        ->id(),
      'search_api_display' => $search_api_sorts_field
        ->getDisplayId(),
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdminController::$currentRequest protected property The current request object.
AdminController::$searchApiDisplayManager protected property The Search API display manager.
AdminController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
AdminController::displayListing public function Overview of search api displays to choose to manage sort fields for.
AdminController::redirectEditForm public function Callback for search_api_sorts_field edit form.
AdminController::__construct public function AdminController constructor.
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.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
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.
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.