class SearchController
Same name in other branches
- 9 core/modules/search/src/Controller/SearchController.php \Drupal\search\Controller\SearchController
- 10 core/modules/search/src/Controller/SearchController.php \Drupal\search\Controller\SearchController
- 11.x core/modules/search/src/Controller/SearchController.php \Drupal\search\Controller\SearchController
Route controller for search.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\Routing\LinkGeneratorTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\Routing\UrlGeneratorTrait
- class \Drupal\search\Controller\SearchController extends \Drupal\Core\Controller\ControllerBase
Expanded class hierarchy of SearchController
File
-
core/
modules/ search/ src/ Controller/ SearchController.php, line 17
Namespace
Drupal\search\ControllerView source
class SearchController extends ControllerBase {
/**
* The search page repository.
*
* @var \Drupal\search\SearchPageRepositoryInterface
*/
protected $searchPageRepository;
/**
* A logger instance.
*
* @var \Psr\Log\LoggerInterface
*/
protected $logger;
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* Constructs a new search controller.
*
* @param \Drupal\search\SearchPageRepositoryInterface $search_page_repository
* The search page repository.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer.
*/
public function __construct(SearchPageRepositoryInterface $search_page_repository, RendererInterface $renderer) {
$this->searchPageRepository = $search_page_repository;
$this->logger = $this->getLogger('search');
$this->renderer = $renderer;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('search.search_page_repository'), $container->get('renderer'));
}
/**
* Creates a render array for the search page.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request object.
* @param \Drupal\search\SearchPageInterface $entity
* The search page entity.
*
* @return array
* The search form and search results build array.
*/
public function view(Request $request, SearchPageInterface $entity) {
$build = [];
$plugin = $entity->getPlugin();
// Build the form first, because it may redirect during the submit,
// and we don't want to build the results based on last time's request.
$build['#cache']['contexts'][] = 'url.query_args:keys';
if ($request->query
->has('keys')) {
$keys = trim($request->query
->get('keys'));
$plugin->setSearch($keys, $request->query
->all(), $request->attributes
->all());
}
$build['#title'] = $plugin->suggestedTitle();
$build['search_form'] = $this->formBuilder()
->getForm(SearchPageForm::class, $entity);
// Build search results, if keywords or other search parameters are in the
// GET parameters. Note that we need to try the search if 'keys' is in
// there at all, vs. being empty, due to advanced search.
$results = [];
if ($request->query
->has('keys')) {
if ($plugin->isSearchExecutable()) {
// Log the search.
if ($this->config('search.settings')
->get('logging')) {
$this->logger
->notice('Searched %type for %keys.', [
'%keys' => $keys,
'%type' => $entity->label(),
]);
}
// Collect the search results.
$results = $plugin->buildResults();
}
else {
// The search not being executable means that no keywords or other
// conditions were entered.
$this->messenger()
->addError($this->t('Please enter some keywords.'));
}
}
if (count($results)) {
$build['search_results_title'] = [
'#markup' => '<h2>' . $this->t('Search results') . '</h2>',
];
}
$build['search_results'] = [
'#theme' => [
'item_list__search_results__' . $plugin->getPluginId(),
'item_list__search_results',
],
'#items' => $results,
'#empty' => [
'#markup' => '<h3>' . $this->t('Your search yielded no results.') . '</h3>',
],
'#list_type' => 'ol',
'#context' => [
'plugin' => $plugin->getPluginId(),
],
];
$this->renderer
->addCacheableDependency($build, $entity);
if ($plugin instanceof CacheableDependencyInterface) {
$this->renderer
->addCacheableDependency($build, $plugin);
}
// If this plugin uses a search index, then also add the cache tag tracking
// that search index, so that cached search result pages are invalidated
// when necessary.
if ($plugin->getType()) {
$build['search_results']['#cache']['tags'][] = 'search_index';
$build['search_results']['#cache']['tags'][] = 'search_index:' . $plugin->getType();
}
$build['pager'] = [
'#type' => 'pager',
];
return $build;
}
/**
* Creates a render array for the search help page.
*
* @param \Drupal\search\SearchPageInterface $entity
* The search page entity.
*
* @return array
* The search help page.
*/
public function searchHelp(SearchPageInterface $entity) {
$build = [];
$build['search_help'] = $entity->getPlugin()
->getHelp();
return $build;
}
/**
* Redirects to a search page.
*
* This is used to redirect from /search to the default search page.
*
* @param \Drupal\search\SearchPageInterface $entity
* The search page entity.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A redirect to the search page.
*/
public function redirectSearchPage(SearchPageInterface $entity) {
return $this->redirect('search.view_' . $entity->id());
}
/**
* Route title callback.
*
* @param \Drupal\search\SearchPageInterface $search_page
* The search page entity.
*
* @return string
* The title for the search page edit form.
*/
public function editTitle(SearchPageInterface $search_page) {
return $this->t('Edit %label search page', [
'%label' => $search_page->label(),
]);
}
/**
* Performs an operation on the search page entity.
*
* @param \Drupal\search\SearchPageInterface $search_page
* The search page entity.
* @param string $op
* The operation to perform, usually 'enable' or 'disable'.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A redirect back to the search settings page.
*/
public function performOperation(SearchPageInterface $search_page, $op) {
$search_page->{$op}()
->save();
if ($op == 'enable') {
$this->messenger()
->addStatus($this->t('The %label search page has been enabled.', [
'%label' => $search_page->label(),
]));
}
elseif ($op == 'disable') {
$this->messenger()
->addStatus($this->t('The %label search page has been disabled.', [
'%label' => $search_page->label(),
]));
}
$url = $search_page->toUrl('collection');
return $this->redirect($url->getRouteName(), $url->getRouteParameters(), $url->getOptions());
}
/**
* Sets the search page as the default.
*
* @param \Drupal\search\SearchPageInterface $search_page
* The search page entity.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A redirect to the search settings page.
*/
public function setAsDefault(SearchPageInterface $search_page) {
// Set the default page to this search page.
$this->searchPageRepository
->setDefaultSearchPage($search_page);
$this->messenger()
->addStatus($this->t('The default search page is now %label. Be sure to check the ordering of your search pages.', [
'%label' => $search_page->label(),
]));
return $this->redirect('entity.search_page.collection');
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | 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::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. | 17 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | ||
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. | |||
SearchController::$logger | protected | property | A logger instance. | |||
SearchController::$renderer | protected | property | The renderer. | |||
SearchController::$searchPageRepository | protected | property | The search page repository. | |||
SearchController::create | public static | function | Instantiates a new instance of this class. | Overrides ControllerBase::create | ||
SearchController::editTitle | public | function | Route title callback. | |||
SearchController::performOperation | public | function | Performs an operation on the search page entity. | |||
SearchController::redirectSearchPage | public | function | Redirects to a search page. | |||
SearchController::searchHelp | public | function | Creates a render array for the search help page. | |||
SearchController::setAsDefault | public | function | Sets the search page as the default. | |||
SearchController::view | public | function | Creates a render array for the search page. | |||
SearchController::__construct | public | function | Constructs a new search controller. | |||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | |||
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.