public function SearchController::content in Search API Federated Solr 8.3

Same name and namespace in other branches
8.2 src/Controller/SearchController.php \Drupal\search_api_federated_solr\Controller\SearchController::content()
4.x src/Controller/SearchController.php \Drupal\search_api_federated_solr\Controller\SearchController::content()
Returns content for a search page.
Return value

array A simple renderable array.
File

src/Controller/SearchController.php, line 18
Class

SearchController: Provides route responses for the search results page.
Namespace

Drupal\search_api_federated_solr\Controller
Code

public function content() {
  $renderer = \Drupal::service('renderer');
  $config = \Drupal::configFactory()
    ->get('search_api_federated_solr.search_app.settings');
  $config_editable = \Drupal::configFactory()
    ->getEditable('search_api_federated_solr.search_app.settings');
  $index_config = \Drupal::config('search_api.index.' . $config
    ->get('index.id'));

  // Define the federated search app configuration array.
  // The twig template will json_encode this array into the object expected by
  // the search app: https://github.com/palantirnet/federated-search-react/blob/master/src/.env.local.js.example
  $federated_search_app_config = [];

  // Determine the URL by calling get_endpoint with no direct_url option
  //   because we don't accept a custom direct endpoint for search.
  $proxy_is_disabled = $config
    ->get('proxy.isDisabled') || 0;
  $url = Helpers::getEndpointUrl($proxy_is_disabled, '');
  $federated_search_app_config['proxyIsDisabled'] = $proxy_is_disabled;
  $federated_search_app_config['url'] = $url;

  /*
   * OPTIONAL:
   * The username and password for Basic Authentication on the server.
   * The username and password will be
   * combined and base64 encoded as per the application.
   */
  $username = $config
    ->get('index.username');
  $pass = $config
    ->get('index.password');
  $federated_search_app_config['userpass'] = $username && $pass ? base64_encode($config
    ->get('index.username') . ':' . $config
    ->get('index.password')) : '';

  // Validate that there is still a site name property set for this index.
  // Determine if the index has a site name property, which could have been
  // added / removed since last form load.
  $site_name_property = $index_config
    ->get('field_settings.site_name.configuration.site_name');
  $use_system_site_name = $index_config
    ->get('field_settings.site_name.configuration.use_system_site_name');
  $is_site_name_property = $site_name_property || $use_system_site_name ? 'true' : '';

  // Determine if config option to set default site name is set.
  $set_default_site = $config
    ->get('facet.site_name.set_default');

  // Create an index property field map array to determine which fields
  // exist on the index and should be hidden in the app UI.
  $search_fields = [
    "sm_site_name" => [
      "property" => $is_site_name_property,
      "is_hidden" => $config
        ->get('facet.site_name.is_hidden'),
    ],
    "ss_federated_type" => [
      "property" => $config
        ->get('index.has_federated_type_property'),
      "is_hidden" => $config
        ->get('facet.federated_type.is_hidden'),
    ],
    "ds_federated_date" => [
      "property" => $config
        ->get('index.has_federated_date_property'),
      "is_hidden" => $config
        ->get('filter.federated_date.is_hidden'),
    ],
    "sm_federated_terms" => [
      "property" => $config
        ->get('index.has_federated_terms_property'),
      "is_hidden" => $config
        ->get('facet.federated_terms.is_hidden'),
    ],
  ];

  // Set hiddenSearchFields to an array of keys of those $search_fields items
  // which both exist as an index property and are set to be hidden.
  // OPTIONAL: Machine name of those search fields whose facets/filter and
  // current values should be hidden in UI.
  $federated_search_app_config['hiddenSearchFields'] = array_keys(array_filter($search_fields, function ($value) {
    return $value['property'] && $value['is_hidden'];
  }));

  // OPTIONAL: The text to display when the app loads with no search term.
  if ($search_prompt = $config
    ->get('content.search_prompt')) {
    $federated_search_app_config['searchPrompt'] = $search_prompt;
  }

  // OPTIONAL: The text to display when a search returns no results.
  if ($no_results = $config
    ->get('content.no_results')) {
    $federated_search_app_config['noResults'] = $no_results;
  }

  // OPTIONAL: The text to display when a search returns no results.
  if ($show_empty_search_results = $config
    ->get('content.show_empty_search_results')) {
    $federated_search_app_config['showEmptySearchResults'] = $show_empty_search_results;
  }

  // OPTIONAL: The number of search results to show per page.
  if ($rows = $config
    ->get('results.rows')) {
    $federated_search_app_config['rows'] = intval($rows);
  }

  // OPTIONAL: The number of page buttons to show for pagination.
  if ($pagination_buttons = $config
    ->get('pagination.buttons')) {
    $federated_search_app_config['paginationButtons'] = intval($pagination_buttons);
  }

  // OPTIONAL: The rendered title of the search page.
  if ($page_title = $config
    ->get('page_title')) {
    $federated_search_app_config['pageTitle'] = $page_title;
  }

  // OPTIONAL: Pre-select this site.
  if ($site_search = $config
    ->get('facet.site_name.set_default') && !$config
    ->get('facet.site_name.is_hidden')) {
    $federated_search_app_config['siteSearch'] = Helpers::getSiteName();
  }

  // OPTIONAL: The allowed list of sites for the search. Note that these are
  // stored as a keyed array with 0 as the default (unchecked) value. So we
  // must filter the list before setting the variable or our app breaks.
  $allowed_list = $config
    ->get('facet.site_name.allowed_sites');
  $allowed_sites = array_keys(array_filter($allowed_list));
  if (!empty($allowed_sites)) {
    $federated_search_app_config['sm_site_name'] = $allowed_sites;
  }
  $federated_search_app_config['autocomplete'] = FALSE;
  if ($autocomplete_is_enabled = $config
    ->get('autocomplete.isEnabled')) {
    $autocomplete_proxy_is_disabled = $config
      ->get('autocomplete.proxy.isDisabled') || 0;
    $federated_search_app_config['autocomplete']['proxyIsDisabled'] = $autocomplete_proxy_is_disabled;
    $autocomplete_direct_url = $config
      ->get('autocomplete.direct.url');
    $autocomplete_url = Helpers::getEndpointUrl($autocomplete_proxy_is_disabled, $autocomplete_direct_url);
    if ($autocomplete_url) {
      $federated_search_app_config['autocomplete']['url'] = $autocomplete_url;
    }
    if ($autocomplete_username = $config
      ->get('autocomplete.username') && ($autocomplete_password = $config
      ->get('autocomplete.password'))) {
      $federated_search_app_config['autocomplete']['userpass'] = base64_encode($autocomplete_username . ':' . $autocomplete_password);
    }

    // OPTIONAL: defaults to false, whether or not to append wildcard to query term
    if ($autocomplete_append_wildcard = $config
      ->get('autocomplete.appendWildcard')) {
      $federated_search_app_config['autocomplete']['appendWildcard'] = $autocomplete_append_wildcard;
    }

    // OPTIONAL: defaults to 5, max number of autocomplete results to return
    if ($autocomplete_suggestion_rows = $config
      ->get('autocomplete.suggestionRows')) {
      $federated_search_app_config['autocomplete']['suggestionRows'] = $autocomplete_suggestion_rows;
    }

    // OPTIONAL: defaults to 2, number of characters *after* which autocomplete results should appear
    if ($autocomplete_num_chars = $config
      ->get('autocomplete.numChars')) {
      $federated_search_app_config['autocomplete']['numChars'] = $autocomplete_num_chars;
    }

    // REQUIRED: show search-as-you-type results ('result', default) or search term ('term') suggestions
    if ($autocomplete_mode = $config
      ->get('autocomplete.mode')) {
      $federated_search_app_config['autocomplete']['mode'] = $autocomplete_mode;

      // OPTIONAL: default set, title to render above autocomplete results
      if ($autocomplete_mode_title_text = $config
        ->get('autocomplete.' . $autocomplete_mode . '.titleText')) {
        $federated_search_app_config['autocomplete'][$autocomplete_mode]['titleText'] = $autocomplete_mode_title_text;
      }

      // OPTIONAL: defaults to false, whether or not to hide the keyboard usage directions text
      if ($autocomplete_mode_hide_directions = $config
        ->get('autocomplete.' . $autocomplete_mode . '.hideDirectionsText')) {
        $federated_search_app_config['autocomplete'][$autocomplete_mode]['showDirectionsText'] = FALSE;
      }
    }
  }
  $element = [
    '#theme' => 'search_app',
    '#federated_search_app_config' => $federated_search_app_config,
    '#attached' => [
      'library' => [
        'search_api_federated_solr/search',
      ],
    ],
  ];

  // Ensure that this render element cache is invalidated when search app or
  // index config is updated.
  $renderer
    ->addCacheableDependency($element, $config);
  $renderer
    ->addCacheableDependency($element, $index_config);
  return $element;
}
You are here

public function SearchController::content in Search API Federated Solr 8.3

Return value

File

Class

Namespace

Code

API Navigation
