public function SearchApiDisplayDeriver::getDerivativeDefinitions in Facets 8

Gets the definition of all derivatives of a base plugin.

Parameters

array $base_plugin_definition: The definition array of the base plugin.

Return value

array An array of full derivative definitions keyed on derivative id.

Overrides DeriverInterface::getDerivativeDefinitions

See also

getDerivativeDefinition()

File

src/Plugin/facets/facet_source/SearchApiDisplayDeriver.php, line 21

Class

SearchApiDisplayDeriver

Derives a facet source plugin definition for every Search API display plugin.

Namespace

Drupal\facets\Plugin\facets\facet_source

Code

public function getDerivativeDefinitions($base_plugin_definition) {
  $base_plugin_id = $base_plugin_definition['id'];
  $plugin_derivatives = [];
  $display_plugin_manager = $this
    ->getSearchApiDisplayPluginManager();
  foreach ($display_plugin_manager
    ->getDefinitions() as $display_id => $display_definition) {

    // If 'index' is not set on the plugin, we can't load the index.
    if (!isset($display_definition['index'])) {
      continue;
    }

    /** @var \Drupal\search_api\Display\DisplayInterface $display */
    $display = $display_plugin_manager
      ->createInstance($display_id);
    $index = $display
      ->getIndex();

    // If we can't reliably load the index, we should just cancel trying to
    // create a derivative for this display.
    if (!$index instanceof IndexInterface) {
      continue;
    }

    // Get the server linked to the index.
    $server = $index
      ->getServerInstance();

    // If facets are not supported by the server, don't actually add this to
    // the list of plugins.
    if (empty($server) || !$server
      ->supportsFeature('search_api_facets')) {
      continue;
    }
    $machine_name = str_replace(':', '__', $display
      ->getPluginId());
    $plugin_derivatives[$machine_name] = [
      'id' => $base_plugin_id . PluginBase::DERIVATIVE_SEPARATOR . $machine_name,
      'display_id' => $display_id,
      'label' => $display
        ->label(),
      'description' => $display
        ->getDescription(),
    ] + $base_plugin_definition;
  }
  uasort($plugin_derivatives, [
    $this,
    'compareDerivatives',
  ]);
  $this->derivatives[$base_plugin_id] = $plugin_derivatives;
  return $this->derivatives[$base_plugin_id];
}