SearchController.php 7.1 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\search\Controller\SearchController.
6 7 8 9
 */

namespace Drupal\search\Controller;

10
use Drupal\Core\Cache\Cache;
11
use Drupal\Core\Config\ConfigFactory;
12
use Drupal\Core\Controller\ControllerBase;
13 14
use Drupal\search\SearchPageInterface;
use Drupal\search\SearchPageRepositoryInterface;
15
use Psr\Log\LoggerInterface;
16 17 18
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

19 20 21
/**
 * Route controller for search.
 */
22
class SearchController extends ControllerBase {
23 24

  /**
25
   * The search page repository.
26
   *
27
   * @var \Drupal\search\SearchPageRepositoryInterface
28
   */
29
  protected $searchPageRepository;
30

31 32 33 34 35 36 37
  /**
   * A logger instance.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

38 39 40
  /**
   * Constructs a new search controller.
   *
41 42
   * @param \Drupal\search\SearchPageRepositoryInterface $search_page_repository
   *   The search page repository.
43 44
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
45
   */
46
  public function __construct(SearchPageRepositoryInterface $search_page_repository, LoggerInterface $logger) {
47
    $this->searchPageRepository = $search_page_repository;
48
    $this->logger = $logger;
49
  }
50 51

  /**
52
   * {@inheritdoc}
53
   */
54 55
  public static function create(ContainerInterface $container) {
    return new static(
56 57
      $container->get('search.search_page_repository'),
      $container->get('logger.factory')->get('search')
58
    );
59 60 61
  }

  /**
62 63 64 65
   * Creates a render array for the search page.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
66 67
   * @param \Drupal\search\SearchPageInterface $entity
   *   The search page entity.
68
   *
69 70
   * @return array
   *   The search form and search results build array.
71
   */
72 73 74 75 76 77 78 79 80
  public function view(Request $request, SearchPageInterface $entity) {
    $build = array();
    $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.
    if ($request->query->has('keys')) {
      $keys = trim($request->get('keys'));
      $plugin->setSearch($keys, $request->query->all(), $request->attributes->all());
81 82
    }

83
    $build['#title'] = $plugin->suggestedTitle();
84
    $build['search_form'] = $this->entityFormBuilder()->getForm($entity, 'search');
85

86 87 88 89 90
    // 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 = array();
    if ($request->query->has('keys')) {
91
      if ($plugin->isSearchExecutable()) {
92
        // Log the search.
93
        if ($this->config('search.settings')->get('logging')) {
94
          $this->logger->notice('Searched %type for %keys.', array('%keys' => $keys, '%type' => $entity->label()));
95
        }
96 97 98 99

        // Collect the search results.
        $results = $plugin->buildResults();
      }
100 101 102 103 104
      else {
        // The search not being executable means that no keywords or other
        // conditions were entered.
        drupal_set_message($this->t('Please enter some keywords.'), 'error');
      }
105
    }
106

107 108 109 110 111 112 113 114 115 116
    if (count($results)) {
      $build['search_results_title'] = array(
        '#markup' => '<h2>' . $this->t('Search results') . '</h2>',
      );
    }

    $build['search_results'] = array(
      '#theme' => array('item_list__search_results__' . $plugin->getPluginId(), 'item_list__search_results'),
      '#items' => $results,
      '#empty' => array(
117
        '#markup' => '<h3>' . $this->t('Your search yielded no results.') . '</h3>',
118 119
      ),
      '#list_type' => 'ol',
120
      '#cache' => array(
121
        'tags' => $entity->getCacheTags(),
122
      ),
123 124 125
      '#context' => array(
        'plugin' => $plugin->getPluginId(),
      ),
126 127
    );

128 129 130 131 132 133 134 135
    // 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();
    }

136
    $build['pager'] = array(
137
      '#type' => 'pager',
138 139
    );

140
    return $build;
141 142
  }

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
  /**
   * Creates a render array for the search help page.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param \Drupal\search\SearchPageInterface $entity
   *   The search page entity.
   *
   * @return array
   *   The search help page.
   */
  public function searchHelp(SearchPageInterface $entity) {
    $build = array();

    $build['search_help'] = $entity->getPlugin()->getHelp();

    return $build;
  }

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
  /**
   * 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', array('%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') {
      drupal_set_message($this->t('The %label search page has been enabled.', array('%label' => $search_page->label())));
    }
    elseif ($op == 'disable') {
      drupal_set_message($this->t('The %label search page has been disabled.', array('%label' => $search_page->label())));
    }

211 212
    $url = $search_page->urlInfo('collection');
    return $this->redirect($url->getRouteName(), $url->getRouteParameters(), $url->getOptions());
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
  }

  /**
   * 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);

    drupal_set_message($this->t('The default search page is now %label. Be sure to check the ordering of your search pages.', array('%label' => $search_page->label())));
229
    return $this->redirect('entity.search_page.collection');
230 231
  }

232
}