You are here

Home » API reference » Search API Saved Searches 8 » SavedSearchController.php

class SavedSearchController in Search API Saved Searches 8

Provides routes related to saved searches.

Hierarchy

Expanded class hierarchy of SavedSearchController

1 file declares its use of SavedSearchController
EmailActivationTest.php in tests/src/Kernel/EmailActivationTest.php

File

src/Controller/SavedSearchController.php, line 14

Namespace

Drupal\search_api_saved_searches\Controller
View source 
class SavedSearchController extends ControllerBase {

  /**
   * Redirects to the search page for the given saved search.
   *
   * @param \Drupal\search_api_saved_searches\SavedSearchInterface $search_api_saved_search
   *   The saved search.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect to the search page.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   Thrown if the search didn't specify a search page path.
   */
  public function viewSearch(SavedSearchInterface $search_api_saved_search) {
    $path = $search_api_saved_search
      ->getPath();
    if (!$path) {
      throw new NotFoundHttpException();
    }
    $url = Url::fromUserInput($path, [
      'absolute' => TRUE,
    ]);
    return new RedirectResponse($url
      ->toString(), 302);
  }

  /**
   * Activates a (currently disabled) saved search.
   *
   * @param \Drupal\search_api_saved_searches\SavedSearchInterface $search_api_saved_search
   *   The saved search to activate.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect to either the search page or the site's front page.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   *   Thrown if saving the saved search failed.
   */
  public function activateSearch(SavedSearchInterface $search_api_saved_search) {

    // Not possible for saved searches that are already active.
    if ($search_api_saved_search
      ->get('status')->value) {
      throw new NotFoundHttpException();
    }
    $search_api_saved_search
      ->set('status', TRUE)
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('Your saved search was successfully activated.'));
    $path = $search_api_saved_search
      ->getPath();
    if (!$path) {
      $url = Url::fromUri('internal:/', [
        'absolute' => TRUE,
      ]);
    }
    else {
      $url = Url::fromUserInput($path, [
        'absolute' => TRUE,
      ]);
    }
    return new RedirectResponse($url
      ->toString(), 302);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
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.
SavedSearchController::activateSearch public function Activates a (currently disabled) saved search.
SavedSearchController::viewSearch public function Redirects to the search page for the given saved search.
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.