www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/drupalmoduleupgrader/src/Annotation/Analyzer.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 analyzer plugins.
   9  *
  10  * Analyzers scan a target module's code to determine if any problems exist. If
  11  * any do exist, it's the analyzer's job to file an issue detailing the nature
  12  * of the problem -- summarizing the issue, pointing out where the problem is
  13  * found, and referring the developer to documentation on drupal.org explaining
  14  * how to fix the problem.
  15  *
  16  * Plugin Namespace: Plugin\DMU\Analyzer
  17  *
  18  * @Annotation
  19  */
  20 class Analyzer extends Plugin {
  21
  22   /**
  23    * The plugin ID.
  24    *
  25    * @var string
  26    */
  27   public $id;
  28
  29   /**
  30    * A short description of the analysis the plugin performs.
  31    *
  32    * @var string
  33    */
  34   public $description;
  35
  36   /**
  37    * Documentation describing the changes covered by the plugin. Each item
  38    * in the array should be an array with 'url' and 'title' keys.
  39    *
  40    * @var array[]
  41    */
  42   public $documentation = [];
  43
  44   /**
  45    * The issue title. Markdown and HTML are allowed.
  46    *
  47    * @var string
  48    */
  49   public $title;
  50
  51   /**
  52    * An optional detailed summary of the issue. Markdown and HTML are allowed.
  53    *
  54    * @var string
  55    */
  56   public $summary;
  57
  58   /**
  59    * The default tags to be applied to flagged issues. Tags are fairly arbitrary and
  60    * can be any value. Tags are divided into groups (i.e., the keys of this here
  61    * array).
  62    *
  63    * @var array
  64    */
  65   public $tags = [];
  66
  67 }