www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/drupalmoduleupgrader/src/Annotation/Indexer.php

   1 <?php
   2
   3 namespace Drupal\drupalmoduleupgrader\Annotation;
   4
   5 use Drupal\Component\Annotation\Plugin;
   6
   7 /**
   8  * Defines a Plugin annotation object for DMU indexer plugins.
   9  *
  10  * Indexers scan a target module to determine what's in it so that other plugins
  11  * can use that information. All available indexers are always run before any
  12  * other plugin type. Indexers are responsible for cataloguing things like:
  13  *
  14  * - What hooks a module implements, and where those implementations reside (i.e.,
  15  *   which files)
  16  * - Classes defined by a module
  17  * - Functions defined by a module
  18  * - Tests defined by a module, and what kind of tests they are
  19  * - Which functions are called by the module, and when
  20  *
  21  * Any information gathered by an indexer is available to other plugin types.
  22  * Essentially, indexers build a "map" of a target module, which is stored in
  23  * an index backend (by default, an SQLite database that lives only in memory).
  24  *
  25  * Plugin Namespace: Plugin\DMU\Indexer
  26  *
  27  * @Annotation
  28  */
  29 class Indexer extends Plugin {
  30
  31   /**
  32    * The plugin ID.
  33    *
  34    * @var string
  35    */
  36   public $id;
  37
  38 }