class SimpleConfigUpdate

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/SimpleConfigUpdate.php \Drupal\Core\Config\Action\Plugin\ConfigAction\SimpleConfigUpdate

@internal This API is experimental.

Attributes

#[ConfigAction(id: 'simpleConfigUpdate', admin_label: new TranslatableMarkup('Simple configuration update'))]

Hierarchy

Expanded class hierarchy of SimpleConfigUpdate

1 string reference to 'SimpleConfigUpdate'
ConfigActionTest::testSimpleConfigUpdate in core/tests/Drupal/KernelTests/Core/Config/Action/ConfigActionTest.php

File

core/lib/Drupal/Core/Config/Action/Plugin/ConfigAction/SimpleConfigUpdate.php, line 19

Namespace

Drupal\Core\Config\Action\Plugin\ConfigAction
View source
final class SimpleConfigUpdate implements ConfigActionPluginInterface, ContainerFactoryPluginInterface {
  
  /**
   * Constructs a SimpleConfigUpdate object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory.
   */
  public function __construct(protected readonly ConfigFactoryInterface $configFactory) {
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : static {
    return new static($container->get('config.factory'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function apply(string $configName, mixed $value) : void {
    $config = $this->configFactory
      ->getEditable($configName);
    // @todo https://www.drupal.org/i/3439713 Should we error if this is a
    //   config entity?
    if ($config->isNew()) {
      throw new ConfigActionException(sprintf('Config %s does not exist so can not be updated', $configName));
    }
    // Expect $value to be an array whose keys are the config keys to update.
    if (!is_array($value)) {
      throw new ConfigActionException(sprintf('Config %s can not be updated because $value is not an array', $configName));
    }
    foreach ($value as $key => $value) {
      $config->set($key, $value);
    }
    $config->save();
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
SimpleConfigUpdate::apply public function Applies the config action. Overrides ConfigActionPluginInterface::apply
SimpleConfigUpdate::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SimpleConfigUpdate::__construct public function Constructs a SimpleConfigUpdate object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.