class FacetsUrlGenerator in Facets 8

Facets Url Generator service.

Hierarchy

• class \Drupal\facets\Utility\FacetsUrlGenerator

3 files declare their use of FacetsUrlGenerator

DisplayGeneratedLinkBlock.php in tests/facets_query_processor/src/Plugin/Block/DisplayGeneratedLinkBlock.php

FacetsUrlGeneratorTest.php in tests/src/Unit/Utility/FacetsUrlGeneratorTest.php

RangeSliderProcessorTest.php in modules/facets_range_widget/tests/src/Unit/Plugin/processor/RangeSliderProcessorTest.php

1 string reference to 'FacetsUrlGenerator'

facets.services.yml in ./facets.services.yml

facets.services.yml

1 service uses FacetsUrlGenerator

facets.utility.url_generator in ./facets.services.yml

Drupal\facets\Utility\FacetsUrlGenerator

File

src/Utility/FacetsUrlGenerator.php, line 12

Namespace

Drupal\facets\Utility

class FacetsUrlGenerator {

  /**
   * The url processor plugin manager.
   *
   * @var \Drupal\facets\UrlProcessor\UrlProcessorPluginManager
   */
  protected $urlProcessorPluginManager;

  /**
   * The entity storage for facets.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $facetStorage;

  /**
   * Constructs a new instance of the FacetsUrlGenerator.
   *
   * @param \Drupal\facets\UrlProcessor\UrlProcessorPluginManager $urlProcessorPluginManager
   *   The url processor plugin manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   */
  public function __construct(UrlProcessorPluginManager $urlProcessorPluginManager, EntityTypeManagerInterface $entityTypeManager) {
    $this->urlProcessorPluginManager = $urlProcessorPluginManager;
    $this->facetStorage = $entityTypeManager
      ->getStorage('facets_facet');
  }

  /**
   * Returns an URL object for a facet path.
   *
   * Example implementations:
   * @code
   * // 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);
   * @endcode
   *
   * @param array $active_filters
   *   An array containing the active filters with key being the facet id and
   *   value being an array of raw values.
   * @param 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 \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
   */
  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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FacetsUrlGenerator::$facetStorage	protected	property	The entity storage for facets.
FacetsUrlGenerator::$urlProcessorPluginManager	protected	property	The url processor plugin manager.
FacetsUrlGenerator::getUrl	public	function	Returns an URL object for a facet path.
FacetsUrlGenerator::__construct	public	function	Constructs a new instance of the FacetsUrlGenerator.