aleph1.co.uk Git - yaffs-website/blob - web/core/modules/search/src/Annotation/SearchPlugin.php

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