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

Plugin annotation

@Analyzer(
 id = "info",
 description = @Translation("Analyzes Drupal 7 info files."),
 documentation = {
   {
     "url" = "https://www.drupal.org/node/1935708",
     "title" = @Translation("`.info` files are now `.info.yml` files")
   }
 }
)

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\InfoFile

File

src/Plugin/DMU/Analyzer/InfoFile.php, line 22

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Analyzer

class InfoFile extends AnalyzerBase {

  /**
   * {@inheritdoc}
   */
  public function analyze(TargetInterface $target) {
    $issues = [];
    $info_file = $target
      ->getPath('.info');
    if (!file_exists($info_file)) {
      return $issues;
    }
    $info = InfoToYAML::parseInfo($info_file);
    if (empty($info)) {
      throw new \RuntimeException('Cannot parse info file ' . $info_file);
    }
    $doc = $this->pluginDefinition['documentation'][0];
    if ($info['core'] != '8.x') {
      $issues['core'] = new Issue($target, $this
        ->t("Module info files' `core` key must have a value of `8.x`."));
      $issues['core']
        ->addDocumentation($doc['url'], $doc['title']);
    }
    if (empty($info['type'])) {
      $issues['type'] = new Issue($target, $this
        ->t('Info files must contain a `type` key.'));
      $issues['type']
        ->addDocumentation($doc['url'] . '#type', $doc['title']);
    }
    if (isset($info['dependencies'])) {
      $issues['dependencies'] = new Issue($target, $this
        ->t('Many common dependencies have moved into core.'));
      $issues['dependencies']
        ->addDocumentation($doc['url'], $doc['title']);
    }
    if (isset($info['files'])) {
      $issues['files'] = new Issue($target, $this
        ->t('Modules no longer declare classes in their info file.'));
      $issues['files']
        ->addDocumentation($doc['url'] . '#files', $doc['title']);
    }
    if (isset($info['configure'])) {
      $issues['configure'] = new Issue($target, $this
        ->t("Module info files' `configure` key must be a route name, not a path."));
      $issues['configure']
        ->addDocumentation($doc['url'] . '#configure', $doc['title']);
    }

    /** @var \Drupal\drupalmoduleupgrader\IssueInterface $issue */
    foreach ($issues as $key => $issue) {
      $issue
        ->setTag('error_level', 'error');
      $issue
        ->setTag('category', [
        'info',
      ]);
      $issue
        ->addAffectedFile($info_file, $this);
    }
    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.
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
InfoFile::analyze	public	function	Analyzes a target module and flags any issues found. Overrides AnalyzerInterface::analyze
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.