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

Plugin annotation

@Converter(
 id = "grep",
 description = @Translation("Searches for and replaces commonly-used code that has changed in Drupal 8.")
)

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\ConverterBase implements ConverterInterface
        • class \Drupal\drupalmoduleupgrader\Plugin\DMU\Converter\Grep

File

src/Plugin/DMU/Converter/Grep.php, line 18

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Converter

class Grep extends ConverterBase {

  /**
   * @var string[]
   */
  private $targets = [];
  public function __construct(array $configuration, $plugin_id, $plugin_definition, TranslationInterface $translator, LoggerInterface $log) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $translator, $log);
    foreach ($configuration['globals'] as $variable => $replacement) {
      $this->targets['global $' . $variable . ';'] = '$' . $variable . ' = ' . $replacement . ';';
      $this->targets['$GLOBALS[\'' . $variable . '\']'] = $replacement;
      $this->targets['$GLOBALS["' . $variable . '"]'] = $replacement;
    }
    foreach ($configuration['constants'] as $constant => $replacement) {
      $this->targets[$constant] = $replacement;
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($container
      ->get('config.factory')
      ->get('drupalmoduleupgrader.grep')
      ->get('definitions'), $plugin_id, $plugin_definition, $container
      ->get('string_translation'), $container
      ->get('logger.factory')
      ->get('drupalmoduleupgrader'));
  }

  /**
   * {@inheritdoc}
   */
  public function convert(TargetInterface $target) {
    foreach ($this->configuration['function_calls'] as $function => $replace_with) {
      $function_calls = $target
        ->getIndexer('function_call')
        ->get($function);
      foreach ($function_calls as $function_call) {
        $rewritten = str_ireplace($function, $replace_with, $function_call
          ->getText());
        $node = Parser::parseExpression($rewritten);
        $function_call
          ->replaceWith($node);
        $target
          ->save($node);
      }
    }

    // Flush other open syntax trees to ensure that other plugins don't clobber
    // our changes later.
    $target
      ->flush();
    foreach ($target
      ->getFinder() as $file) {

      // Load in the entire contents of the module. This is criminally inefficient
      // and wasteful of memory and should eventually be refactored into something
      // a little more...I dunno, sustainable.

      /** @var \Symfony\Component\Finder\SplFileInfo $file */
      $search = array_keys($this->targets);
      $replace = array_values($this->targets);
      file_put_contents($file
        ->getPathname(), str_replace($search, $replace, $file
        ->getContents()));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConverterBase::buildFixMe	protected	function	Builds a FIXME notice using either the text in the plugin definition, or passed-in text.
ConverterBase::DOC_COMMENT		constant
ConverterBase::executeHook	protected	function	Executes the target module's implementation of the specified hook, and returns the result.
ConverterBase::implement	protected	function	Creates an empty implementation of a hook.
ConverterBase::isExecutable	public	function	Returns if this conversion applies to the target module. If FALSE, the convert() method will not be called. Overrides ConverterInterface::isExecutable	4
ConverterBase::LINE_COMMENT		constant
ConverterBase::parse	protected	function	Parses a generated class into a syntax tree.
ConverterBase::rewriteFunction	protected	function	Parametrically rewrites a function.
ConverterBase::write	public	function	Writes a file to the target module's directory.
ConverterBase::writeClass	public	function	Writes a class to the target module's PSR-4 root.
ConverterBase::writeInfo	protected	function	Writes out arbitrary data in YAML format.
ConverterBase::writeService	protected	function	Writes a service definition to the target module's services.yml file.
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
Grep::$targets	private	property
Grep::convert	public	function	Performs required conversions. Overrides ConverterInterface::convert
Grep::create	public static	function	Creates an instance of the plugin. Overrides PluginBase::create
Grep::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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::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.
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.