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

Plugin annotation

@Converter(
 id = "watchdog",
 description = @Translation("Converts calls to watchdog() to \Drupal::logger().")
)

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\Functions\FunctionCallModifier
          • class \Drupal\drupalmoduleupgrader\Plugin\DMU\Converter\Functions\Watchdog

File

src/Plugin/DMU/Converter/Functions/Watchdog.php, line 17

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Converter\Functions

class Watchdog extends FunctionCallModifier {
  protected static $severityConstants = [
    'WATCHDOG_EMERGENCY',
    'WATCHDOG_ALERT',
    'WATCHDOG_CRITICAL',
    'WATCHDOG_ERROR',
    'WATCHDOG_WARNING',
    'WATCHDOG_NOTICE',
    'WATCHDOG_INFO',
    'WATCHDOG_DEBUG',
  ];

  /**
   * {@inheritdoc}
   */
  public function rewrite(FunctionCallNode $call, TargetInterface $target) {
    $arguments = $call
      ->getArguments();

    // We'll call a specific method on the logger object, depending on the
    // severity passed in the original function call (if any). If there are
    // at least four arguments, a severity was passed. We check $arguments[3]
    // to ensure it's a valid severity constant, and if it's not, we default
    // to the notice() severity.
    //
    // @TODO Leave a FIXME for an invalid severity, since changing it to a
    // notice alters the intent of the original code.
    //
    if (sizeof($arguments) > 3 && $arguments[3] instanceof ConstantNode && in_array($arguments[3]
      ->getConstantName()
      ->getText(), static::$severityConstants)) {
      $method = strtolower(substr($arguments[3], 9));
    }
    else {
      $method = 'notice';
    }

    // If there is a third argument, and it's an array, a context array
    // was passed.
    $context = sizeof($arguments) > 2 && $arguments[2] instanceof ArrayNode ? clone $arguments[2] : ArrayNode::create([]);
    return ClassMethodCallNode::create('\\Drupal', 'logger')
      ->appendArgument(clone $arguments[0])
      ->appendMethodCall($method)
      ->appendArgument(clone $arguments[1])
      ->appendArgument($context);
  }

}

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::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
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.
Watchdog::$severityConstants	protected static	property
Watchdog::rewrite	public	function	Tries to rewrite the original function call. Overrides FunctionCallModifier::rewrite