class DB in Drupal 7 to 8/9 Module Upgrader 8

Plugin annotation

@Analyzer(
  id = "_db",
  message = @Translation("Certain database tables have been removed."),
  tags = {
    "category" = { "db" }
  },
  deriver = "\Drupal\drupalmoduleupgrader\Plugin\DMU\Analyzer\DBDeriver"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\drupalmoduleupgrader\PluginBase implements ContainerFactoryPluginInterface
      • class \Drupal\drupalmoduleupgrader\AnalyzerBase implements AnalyzerInterface
        • class \Drupal\drupalmoduleupgrader\Plugin\DMU\Analyzer\DB

File

src/Plugin/DMU/Analyzer/DB.php, line 20

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Analyzer

class DB extends AnalyzerBase {

  /**
   * Tables which will cause the function call to be commented out.
   *
   * @var string[]
   */
  protected static $forbiddenTables = [
    'variable',
  ];

  /**
   * {@inheritdoc}
   */
  public function analyze(TargetInterface $target) {
    $function_calls = $target
      ->getIndexer('function_call')
      ->get($this->pluginDefinition['function'] ?: $this
      ->getPluginId())
      ->filter(function (FunctionCallNode $function_call) {
      $arguments = $function_call
        ->getArguments();
      return $arguments[0] instanceof StringNode && in_array($arguments[0]
        ->toValue(), self::$forbiddenTables);
    });
    $issues = [];
    if ($function_calls
      ->count() > 0) {
      $issue = $this
        ->buildIssue($target);
      $function_calls
        ->each(function (FunctionCallNode $function_call) use ($issue) {
        $issue
          ->addViolation($function_call, $this);
      });
      $issues[] = $issue;
    }
    return $issues;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AnalyzerBase::buildIssue	protected	function	Creates an issue with title, summary, documentation and tags pulled from the plugin definition.
DB::$forbiddenTables	protected static	property	Tables which will cause the function call to be commented out.
DB::analyze	public	function	Analyzes a target module and flags any issues found. Overrides AnalyzerInterface::analyze
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$log	protected	property
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	11
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.