SearchApiDisplay.php in Search API 8

Namespace

Drupal\search_api\Annotation

File

src/Annotation/SearchApiDisplay.php

<?php

namespace Drupal\search_api\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines a Search API display annotation object.
 *
 * @see \Drupal\search_api\Display\DisplayPluginManager
 * @see \Drupal\search_api\Display\DisplayInterface
 * @see \Drupal\search_api\Display\DisplayPluginBase
 * @see plugin_api
 *
 * @Annotation
 */
class SearchApiDisplay extends Plugin {

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

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

  /**
   * The human-readable description for the display plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * The ID of the display's index.
   *
   * @var string
   */
  public $index;

  /**
   * The path to the search display, if any.
   *
   * @var string|null
   */
  public $path;

}

Classes

Name	Description
SearchApiDisplay	Defines a Search API display annotation object.