public function FacetsUrlGenerator::getUrl in Facets 8

Returns an URL object for a facet path.

Example implementations:

// Example to generate URL for 1 facet with 1 value.
\Drupal::service('facets.utility.url_generator')
  ->getUrl([
  'tags' => [
    7,
  ],
]);

// Example with multiple active filters.
$active_filters = [
  'tags' => [
    5,
    7,
  ],
  'color' => [
    'blue',
  ],
];
\Drupal::service('facets.utility.url_generator')
  ->getUrl($active_filters);

Parameters

array $active_filters: An array containing the active filters with key being the facet id and value being an array of raw values.

bool $keep_active: TRUE if the currently active facets should be included to the URL or FALSE if they should be discarded. Defaults to TRUE.

Return value

\Drupal\Core\Url|null A Url object for the given facet/value combination or null if no Result was returned by the UrlProcessor.

Throws

\InvalidArgumentException

File

src/Utility/FacetsUrlGenerator.php, line 66

Class

FacetsUrlGenerator

Facets Url Generator service.

Namespace

Drupal\facets\Utility

Code

public function getUrl(array $active_filters, $keep_active = TRUE) {

  // We use the first defined facet to load the url processor. As all facets
  // should be from the same facet source, this is fine.
  // This is because we don't support generating a url over multiple facet
  // sources.
  if (empty($active_filters)) {
    throw new \InvalidArgumentException("The active filters passed in are invalid. They should look like: ['facet_id' => ['value1', 'value2']]");
  }
  $facet_id = key($active_filters);
  if (!is_array($active_filters[$facet_id])) {
    throw new \InvalidArgumentException("The active filters passed in are invalid. They should look like: [{$facet_id} => ['value1', 'value2']]");
  }
  $facet = $this->facetStorage
    ->load($facet_id);
  if ($facet === NULL) {
    throw new \InvalidArgumentException("The Facet {$facet_id} could not be loaded.");
  }

  // We need one raw value to build a Result. If we have the raw value in the
  // already active filters, it will be removed in the final result. So
  // instead we copy the value into a variable and unset it from the list.
  $raw_value = $active_filters[$facet_id][0];
  unset($active_filters[$facet_id][0]);

  /** @var \Drupal\facets\UrlProcessor\UrlProcessorInterface $url_processor */
  $url_processor = $this->urlProcessorPluginManager
    ->createInstance($facet
    ->getFacetSourceConfig()
    ->getUrlProcessorName(), [
    'facet' => $facet,
  ]);
  if ($keep_active) {
    $active_filters = array_merge_recursive($active_filters, $url_processor
      ->getActiveFilters());
  }
  $url_processor
    ->setActiveFilters($active_filters);

  // Use the url processor to create a result and return that item's url.
  $results = [
    new Result($facet, $raw_value, '', 0),
  ];
  $processed_results = $url_processor
    ->buildUrls($facet, $results);
  $result = reset($processed_results);
  if ($result) {
    return $result
      ->getUrl();
  }
  return NULL;
}