www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/drupalmoduleupgrader/src/Annotation/Converter.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 converter plugins.
   9  *
  10  * Converters take Drupal 7 code and do what they can to rewrite it for Drupal 8.
  11  * When a converter cannot convert something, it can leave a FIXME notice at the
  12  * affected code informing the developer what still needs to be done. Converters
  13  * may generate ugly code, but refactoring is not their job. Converts modify the
  14  * target module in place.
  15  *
  16  * Plugin Namespace: Plugin\DMU\Converter
  17  *
  18  * @Annotation
  19  */
  20 class Converter extends Plugin {
  21
  22   /**
  23    * The plugin ID.
  24    *
  25    * @var string
  26    */
  27   public $id;
  28
  29   /**
  30    * A short description of the conversion the plugin performs.
  31    *
  32    * @var string
  33    */
  34   public $description;
  35
  36   /**
  37    * If the plugin converts a hook (or several hooks), the hook(s) it converts
  38    * (without the hook_ prefix).
  39    *
  40    * @var string|string[]
  41    */
  42   public $hook;
  43
  44   /**
  45    * Optional FIXME notice the converter should leave at code that it cannot convert.
  46    *
  47    * @var string
  48    */
  49   public $fixme;
  50
  51   /**
  52    * Optional documentation links to be included in the FIXME notice.
  53    *
  54    * @var string[]
  55    */
  56   public $documentation = [];
  57
  58 }