annotate core/modules/search/src/Annotation/SearchPlugin.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\search\Annotation;
Chris@0 4
Chris@0 5 use Drupal\Component\Annotation\Plugin;
Chris@0 6
Chris@0 7 /**
Chris@0 8 * Defines a SearchPlugin type annotation object.
Chris@0 9 *
Chris@0 10 * SearchPlugin classes define search types for the core Search module. Each
Chris@0 11 * search type can be used to create search pages from the Search settings page.
Chris@0 12 *
Chris@0 13 * @see SearchPluginBase
Chris@0 14 *
Chris@0 15 * @ingroup search
Chris@0 16 *
Chris@0 17 * @Annotation
Chris@0 18 */
Chris@0 19 class SearchPlugin extends Plugin {
Chris@0 20
Chris@0 21 /**
Chris@0 22 * A unique identifier for the search plugin.
Chris@0 23 *
Chris@0 24 * @var string
Chris@0 25 */
Chris@0 26 public $id;
Chris@0 27
Chris@0 28 /**
Chris@0 29 * The title for the search page tab.
Chris@0 30 *
Chris@0 31 * @todo This will potentially be translated twice or cached with the wrong
Chris@0 32 * translation until the search tabs are converted to local task plugins.
Chris@0 33 *
Chris@0 34 * @ingroup plugin_translatable
Chris@0 35 *
Chris@0 36 * @var \Drupal\Core\Annotation\Translation
Chris@0 37 */
Chris@0 38 public $title;
Chris@0 39
Chris@0 40 }