You are here

FacetsFacetSource.php in Facets 8

File

src/Annotation/FacetsFacetSource.php
View source
<?php

namespace Drupal\facets\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines a Facets facet source annotation.
 *
 * @see \Drupal\facets\FacetSource\FacetSourcePluginManager
 * @see \Drupal\facets\FacetSource\FacetSourcePluginInterface
 * @see \Drupal\facets\FacetSource\FacetSourcePluginBase
 * @see plugin_api
 *
 * @Annotation
 */
class FacetsFacetSource extends Plugin {

  /**
   * The facet source plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the facet source plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The facet source description.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The id of the search api display, if one is used.
   *
   * @var string
   */

  // @codingStandardsIgnoreStart
  public $display_id;

}

Classes

Namesort descending Description
FacetsFacetSource Defines a Facets facet source annotation.