You are here

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

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

Plugin annotation


@Converter(
 id = "variable_get",
 description = @Translation("Replaces variable_get() calls with Configuration API.")
)

Hierarchy

Expanded class hierarchy of VariableGet

File

src/Plugin/DMU/Converter/Functions/VariableGet.php, line 18

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Converter\Functions
View source 
class VariableGet extends VariableAPI {

  /**
   * Default configuration values extracted from rewritten calls to
   * variable_get().
   *
   * @var mixed[]
   */
  private $defaults = [];

  /**
   * The schema accompanying any extracted default values.
   *
   * @var array
   */
  private $schema = [];

  /**
   * {@inheritdoc}
   */
  public function rewrite(FunctionCallNode $call, TargetInterface $target) {
    if ($this
      ->tryRewrite($call, $target)) {
      $arguments = $call
        ->getArguments();
      $key = $arguments[0]
        ->toValue();
      if ($arguments[1] instanceof ScalarNode) {

        // @TODO Couldn't convert() derive the schema from $this->defaults?
        // That'd be preferable to having yet another state property ($schema)
        // on this class.
        $this->defaults[$key] = $arguments[1]
          ->toValue();
        $this->schema[$key]['type'] = gettype($this->defaults[$key]);
      }
      else {
        $comment = <<<END
Could not extract the default value because it is either indeterminate, or
not scalar. You'll need to provide a default value in
config/install/@module.settings.yml and config/schema/@module.schema.yml.
END;
        $variables = [
          '@module' => $target
            ->id(),
        ];
        $this
          ->buildFixMe($comment, $variables)
          ->prependTo($call
          ->getStatement());
      }
      return ClassMethodCallNode::create('\\Drupal', 'config')
        ->appendArgument($target
        ->id() . '.settings')
        ->appendMethodCall('get')
        ->appendArgument(clone $arguments[0]);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function convert(TargetInterface $target) {
    parent::convert($target);
    if ($this->defaults && $this->schema) {
      $group = $target
        ->id() . '.settings';
      $this
        ->write($target, InstallStorage::CONFIG_INSTALL_DIRECTORY . '/' . $group . '.yml', Yaml::encode($this->defaults));
      $this->defaults = [];
      $schema = [
        $group => [
          'type' => 'mapping',
          'label' => (string) $this
            ->t('Settings'),
          'mapping' => $this->schema,
        ],
      ];
      $this
        ->write($target, InstallStorage::CONFIG_SCHEMA_DIRECTORY . '/' . $target
        ->id() . '.schema.yml', Yaml::encode($schema));
      $this->schema = [];
    }
  }

}

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::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.
VariableAPI::tryRewrite protected function Helper for subclasses' rewrite() methods. This checks if the call can be rewritten at all and leaves a FIXME if it can't. If the variable's key is not a string starting with MODULE_, the call will not be considered rewritable.
VariableGet::$defaults private property Default configuration values extracted from rewritten calls to variable_get().
VariableGet::$schema private property The schema accompanying any extracted default values.
VariableGet::convert public function Performs required conversions. Overrides FunctionCallModifier::convert
VariableGet::rewrite public function Tries to rewrite the original function call. Overrides FunctionCallModifier::rewrite