You are here

Home » API reference » Drupal 7 to 8/9 Module Upgrader 8 » FunctionCallModifier.php

abstract class FunctionCallModifier in Drupal 7 to 8/9 Module Upgrader 8

Base class for converters which modify individual function calls.

Hierarchy

Expanded class hierarchy of FunctionCallModifier

File

src/Plugin/DMU/Converter/Functions/FunctionCallModifier.php, line 12

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Converter\Functions
View source 
abstract class FunctionCallModifier extends ConverterBase {

  /**
   * Tries to rewrite the original function call.
   *
   * @param \Pharborist\Functions\FunctionCallNode $call
   *   The original function call.
   * @param \Drupal\drupalmoduleupgrader\TargetInterface $target
   *   The target module.
   *
   * @return \Pharborist\Node|null
   *   If the original function call is returned (determined by object identity),
   *   the function call is not replaced. If a different node is returned, it
   *   will replace the original call. And if nothing is returned, the original
   *   call is commented out with a FIXME.
   */
  public abstract function rewrite(FunctionCallNode $call, TargetInterface $target);

  /**
   * {@inheritdoc}
   */
  public function isExecutable(TargetInterface $target) {

    // Silence 'undefined index' notices if the 'function' key doesn't exist in
    // the plugin definition.
    $function = @($this->pluginDefinition['function'] ?: $this
      ->getPluginId());
    return $target
      ->getIndexer('function_call')
      ->has($function);
  }

  /**
   * {@inheritdoc}
   */
  public function convert(TargetInterface $target) {

    // Prevent stupid effing 'undefined index' notices.
    $function = @($this->pluginDefinition['function'] ?: $this
      ->getPluginId());
    $function_calls = $target
      ->getIndexer('function_call')
      ->get($function);
    foreach ($function_calls as $function_call) {

      // If the function call is no longer attached to a tree, don't even
      // try to rewrite it. This could happen when there are two calls to
      // the same function in a single statement, and the first one has
      // been commented out -- the second one will be attached to an orphaned
      // sub-tree, and this will result in fatal errors.
      if (!$function_call
        ->hasRoot()) {
        continue;
      }
      $rewritten = $this
        ->rewrite($function_call, $target);
      if (empty($rewritten)) {
        $statement = $function_call
          ->getStatement();
        $rewritten = $statement
          ->toComment();
        $statement
          ->replaceWith($rewritten);
        $this
          ->buildFixMe()
          ->insertBefore($rewritten);
      }
      elseif ($rewritten !== $function_call) {
        $function_call
          ->replaceWith($rewritten);
      }
      $target
        ->save($rewritten);
    }
  }

}

Members

Namesort descending 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::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
FunctionCallModifier::convert public function Performs required conversions. Overrides ConverterInterface::convert 1
FunctionCallModifier::isExecutable public function Returns if this conversion applies to the target module. If FALSE, the convert() method will not be called. Overrides ConverterBase::isExecutable
FunctionCallModifier::rewrite abstract public function Tries to rewrite the original function call. 52
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.