facets.module 13 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains facets.module.
6 7
 */

8
use Drupal\Component\Utility\Html;
9 10
use Drupal\Core\Breadcrumb\Breadcrumb;
use Drupal\Core\Link;
11
use Drupal\Core\Routing\RouteMatchInterface;
12
use Drupal\facets\Entity\Facet;
13
use Drupal\facets\Entity\FacetSource;
14
use Drupal\facets\FacetInterface;
Nick_vh's avatar
Nick_vh committed
15
use Drupal\search_api\Query\QueryInterface;
16
use Drupal\views\Entity\View;
17
use Drupal\Core\Entity\EntityInterface;
18
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
19
use Drupal\Core\Logger\RfcLogLevel;
20 21 22 23

/**
 * Implements hook_help().
 */
24
function facets_help($route_name, RouteMatchInterface $route_match) {
25
  switch ($route_name) {
26 27
    // Main module help for the facets module.
    case 'help.page.facets':
28 29
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
30
      $output .= '<p>' . t('Facets test') . '</p>';
31
      return $output;
32

33
    case 'entity.facets_facet.collection':
34 35
      $output = '';
      $output .= '<p>' . t('Below is a list of facets grouped by facetsources they are associated with. A facetsource is the instance where the facet does the actual filtering, for example a View on a Search API index.') . '</p>';
36
      $output .= '<p>' . t('The facets weight can be changed with drag and drop within the same facet source. Although you can drag and drop a facet under any facet source, this change will not be performed on save.') . '</p>';
37
      return $output;
38 39 40
  }
}

41 42 43 44 45
/**
 * Implements hook_theme().
 */
function facets_theme($existing, $type, $theme, $path) {
  return [
46
    'facets_result_item' => [
47
      'base hook' => 'facets_result_item',
48
      'variables' => [
49 50
        'facet' => NULL,
        'raw_value' => '',
51 52 53 54 55 56 57 58
        'value' => '',
        'show_count' => FALSE,
        'count' => NULL,
        'is_active' => FALSE,
      ],
    ],
    'facets_item_list' => [
      'variables' => [
59
        'facet' => NULL,
60 61 62 63 64 65 66 67 68
        'items' => [],
        'title' => '',
        'list_type' => 'ul',
        'wrapper_attributes' => [],
        'attributes' => [],
        'empty' => NULL,
        'context' => [],
      ],
    ],
69 70 71
  ];
}

Nick_vh's avatar
Nick_vh committed
72
/**
73
 * Implements hook_search_api_query_alter().
Nick_vh's avatar
Nick_vh committed
74
 */
75
function facets_search_api_query_alter(QueryInterface &$query) {
76 77 78
  if ($query->getIndex()->getServerInstance()->supportsFeature('search_api_facets')) {
    /** @var \Drupal\facets\FacetManager\DefaultFacetManager $facet_manager */
    $facet_manager = \Drupal::service('facets.manager');
Nick_vh's avatar
Nick_vh committed
79

80 81 82 83 84
    // It's safe to hardcode this to the search api scheme because this is in a
    // search_api_query_alter method. If this generated source is not correct,
    // implementing the same alter and directly calling
    // $manager->alterQuery($query, $your_facetsource_id); will fix that.
    $facet_source = 'search_api:' . str_replace(':', '__', $query->getSearchId());
Nick_vh's avatar
Nick_vh committed
85

86
    // Add the active filters.
87
    $facet_manager->alterQuery($query, $facet_source);
88
  }
Nick_vh's avatar
Nick_vh committed
89
}
90 91 92 93 94 95 96

/**
 * Implements hook_entity_presave().
 *
 * We implement this to make sure that a facet gets removed on view updates, so
 * we don't get broken facet blocks.
 */
97
function facets_entity_presave(EntityInterface $entity) {
98 99 100 101 102 103 104 105 106 107 108 109 110
  // Make sure that we only react on view entities with changed displays.
  if ($entity instanceof View && !empty($entity->original)) {
    if ($entity->original->get('display') != $entity->get('display')) {

      /** @var \Drupal\facets\FacetSource\FacetSourcePluginManager $facet_source_plugin_manager */
      $facet_source_plugin_manager = \Drupal::getContainer()
        ->get('plugin.manager.facets.facet_source');
      $definitions = $facet_source_plugin_manager->getDefinitions();

      // Setup an array of sources that are deleted.
      $sources = [];
      foreach ($entity->original->get('display') as $k => $display) {
        // Check if the current display is also a facet source plugin and that
111 112
        // is removed from the view. We use the double underscore here to make
        // sure that we use core convention of "plugin:derived_plugin".
113
        $facets_source_plugin_id = 'search_api:views_' . $display['display_plugin'] . '__' . $entity->id() . '__' . $display['id'];
114 115
        if (array_key_exists($facets_source_plugin_id, $definitions) && !array_key_exists($k, $entity->get('display'))) {
          $entity_id = str_replace(':', '__', $facets_source_plugin_id);
116
          $source_entity = FacetSource::load($entity_id);
117
          $sources[] = $facets_source_plugin_id;
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
          if (!is_null($source_entity)) {
            $source_entity->delete();
          }
        }
      }

      // Loop over all deleted sources and delete the facets that were linked to
      // that source.
      if (count($sources) > 0) {
        /** @var \Drupal\facets\FacetManager\DefaultFacetManager $fm */
        $fm = \Drupal::getContainer()->get('facets.manager');
        foreach ($sources as $source) {
          $facets = $fm->getFacetsByFacetSourceId($source);
          foreach ($facets as $facet) {
            $facet->delete();
          }
        }
      }
      $facet_source_plugin_manager->clearCachedDefinitions();
    }
  }

}
141 142 143 144 145 146 147 148 149

/**
 * Implements hook_preprocess_block().
 *
 * Adds a class for the widget to the facet block to allow for more specific
 * styling.
 */
function facets_preprocess_block(&$variables) {
  if ($variables['configuration']['provider'] == 'facets') {
150 151 152 153
    if (!empty($variables['derivative_plugin_id'])) {
      $facet = Facet::load($variables['derivative_plugin_id']);
      $variables['attributes']['class'][] = 'block-facet--' . Html::cleanCssIdentifier($facet->getWidget()['type']);
    }
154 155
  }
}
156 157 158 159 160 161 162 163

/**
 * Implements hook_entity_predelete().
 *
 * We implement this hook to make sure that facet source plugins are cleared
 * when a view is deleted. It also deletes facets that are created on those
 * plugins.
 */
164
function facets_entity_predelete(EntityInterface $entity) {
165 166 167 168 169
  if ($entity instanceof View) {
    $facet_source_plugin_manager = \Drupal::getContainer()
      ->get('plugin.manager.facets.facet_source');

    $definitions = $facet_source_plugin_manager->getDefinitions();
170

171 172 173
    if (!is_array($definitions)) {
      return;
    }
174

175
    foreach ($definitions as $plugin_id => $definition) {
176
      if (strpos($plugin_id, 'search_api:' . $entity->id() . '__') !== FALSE) {
177 178
        try {
          $facetManager = \Drupal::getContainer()->get('facets.manager');
179 180
        }
        catch (ServiceNotFoundException $e) {
181
          \Drupal::logger('facets')->log(RfcLogLevel::DEBUG, 'Facet manager not found on trying to delete a view.');
182 183
          return;
        }
184

185 186 187 188 189 190 191 192 193 194 195 196
        $facets = $facetManager->getFacetsByFacetSourceId($plugin_id);
        foreach ($facets as $facet) {
          $facet->delete();
        }
      }
    }

    // Clear cached plugin definitions for facet source to make sure we don't
    // show stale data.
    $facet_source_plugin_manager->clearCachedDefinitions();
  }
}
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216

/**
 * Prepares variables for facets item list templates.
 *
 * Default template: facets-item-list.html.twig.
 *
 * @param array $variables
 *   An associative array containing:
 *   - items: An array of items to be displayed in the list. Each item can be
 *     either a string or a render array. If #type, #theme, or #markup
 *     properties are not specified for child render arrays, they will be
 *     inherited from the parent list, allowing callers to specify larger
 *     nested lists without having to explicitly specify and repeat the
 *     render properties for all nested child lists.
 *   - title: A title to be prepended to the list.
 *   - list_type: The type of list to return (e.g. "ul", "ol").
 *   - wrapper_attributes: HTML attributes to be applied to the list wrapper.
 *
 * @see https://www.drupal.org/node/1842756
 */
217
function facets_preprocess_facets_item_list(array &$variables) {
218 219
  template_preprocess_item_list($variables);
}
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259

/**
 * Implements hook_system_breadcrumb_alter().
 */
function facets_system_breadcrumb_alter(Breadcrumb &$breadcrumb, RouteMatchInterface $route_match, array $context) {
  /** @var \Drupal\facets\FacetSource\FacetSourcePluginManager $facet_source_manager */
  $facet_source_manager = \Drupal::service('plugin.manager.facets.facet_source');

  /** @var \Drupal\facets\FacetManager\DefaultFacetManager $facet_manager */
  $facet_manager = \Drupal::service('facets.manager');

  /** @var \Drupal\Core\Entity\EntityTypeManager $entity_type_manager */
  $entity_type_manager = \Drupal::service('entity_type.manager');

  /** @var \Drupal\Core\Entity\EntityStorageInterface $facet_source_storage */
  $facet_source_storage = $entity_type_manager->getStorage('facets_facet_source');

  $facet_sources_definitions = $facet_source_manager->getDefinitions();

  // No facet sources found, so don't do anything.
  if (empty($facet_sources_definitions)) {
    return;
  }

  foreach ($facet_sources_definitions as $definition) {
    /* @var \Drupal\facets\FacetSource\FacetSourcePluginBase $facet_source_plugin */
    $facet_source_plugin = $facet_source_manager->createInstance($definition['id']);

    // If the current facet source is not being rendered, don't do anything with
    // these facet sources.
    if (!$facet_source_plugin->isRenderedInCurrentRequest()) {
      continue;
    }

    $source_id = str_replace(':', '__', $definition['id']);
    /** @var \Drupal\facets\FacetSourceInterface $facet_source */
    $facet_source = $facet_source_storage->load($source_id);

    // If the facet source is not loaded, or the facet source doesn't have
    // breadcrumbs enabled, don't do anything.
260
    if (!($facet_source && !empty($facet_source->getBreadcrumbSettings()['active']))) {
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
      continue;
    }

    // Add the required cacheability metadata.
    $breadcrumb->addCacheContexts(['url']);
    $breadcrumb->addCacheableDependency($facet_source);

    // Process the facets if they are not already processed.
    $facet_manager->processFacets();
    $facets = $facet_manager->getFacetsByFacetSourceId($definition['id']);

    // Sort facets by weight.
    uasort($facets, function (FacetInterface $a, FacetInterface $b) {
      if ($a->getWeight() == $b->getWeight()) {
        return 0;
      }
      return ($a->getWeight() < $b->getWeight()) ? -1 : 1;
    });

    /** @var \Drupal\facets\UrlProcessor\UrlProcessorPluginManager $url_processor_manager */
    $url_processor_manager = \Drupal::service('plugin.manager.facets.url_processor');

    // Get active facets and results to use them at building the crumbs.
    $active_results = [];
    $active_facets = [];
    foreach ($facets as $facet) {
287
      if (count($facet->getActiveItems()) > 0) {
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
        // Add the facet as a cacheable dependency.
        $breadcrumb->addCacheableDependency($facet);
        /** @var \Drupal\facets\UrlProcessor\UrlProcessorInterface $url_processor */
        $url_processor = $url_processor_manager->createInstance($facet_source->getUrlProcessorName(), ['facet' => $facet]);
        $facet_manager->build($facet);

        foreach ($facet->getResults() as $result) {
          if ($result->isActive()) {
            // Clone the result so we can mark it as inactive to be added to the
            // url parameters when calling buildUrls.
            $cloned_result = clone $result;
            $cloned_result->setActiveState(FALSE);
            $active_results[$facet->getUrlAlias()][] = $cloned_result;
          }
        }
303 304 305
        if (!empty($active_results[$facet->getUrlAlias()])) {
          $url_processor->buildUrls($facet, $active_results[$facet->getUrlAlias()]);
        }
306 307 308 309 310 311 312 313 314
        $active_facets[$facet->getUrlAlias()] = $facet;
      }
    }

    // TODO find a better way to construct the url for a crumb maybe url
    // processor will have a function to get params for a result
    // without all the other request parameters; with this we could implement:
    // @see https://www.drupal.org/node/2861586
    // TODO handle not grouped facets.
315
    /** @var \Drupal\facets\Result\ResultInterface[] $facet_results */
316 317 318 319 320 321 322 323
    foreach ($active_results as $facet_alias => $facet_results) {
      $facet_used_result[] = $facet_alias;
      $facet_crumb_items = [];
      reset($facet_results);
      $facet_url = clone current($facet_results)->getUrl();

      // Because we can't get the desired url trough a url processor method
      // we iterate each result url and remove the facet params that haven't
324
      // been used on previous crumbs.
325 326 327 328
      foreach ($facet_results as $res) {
        $facet_url = $res->getUrl();
        /** @var \Drupal\Core\Url $facet_url */
        $query = $facet_url->getOption('query');
329 330
        $filter_key = $facet_source->getFilterKey() ?: 'f';
        $source_filter = $query[$filter_key];
331 332 333
        $source_filter = array_unique($source_filter);
        $source_filter = array_filter($source_filter);
        $matches = preg_grep('/^' . implode('|^', $facet_used_result) . '/', $source_filter);
334
        $query[$filter_key] = $matches;
335 336 337
        $facet_crumb_items[] = $res->getDisplayValue();
      }

338 339
      sort($facet_crumb_items);

340 341 342 343 344 345 346 347
      // Set the new query and create the link.
      $facet_url->setOption('query', $query);
      $crumb_text = $active_facets[$facet_alias]->label() . ': ' . implode(', ', $facet_crumb_items);
      $link = Link::fromTextAndUrl($crumb_text, $facet_url);
      $breadcrumb->addLink($link);
    }
  }
}