class PluginSettingsBase

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/PluginSettingsBase.php \Drupal\Core\Field\PluginSettingsBase
  2. 10 core/lib/Drupal/Core/Field/PluginSettingsBase.php \Drupal\Core\Field\PluginSettingsBase
  3. 11.x core/lib/Drupal/Core/Field/PluginSettingsBase.php \Drupal\Core\Field\PluginSettingsBase

Base class for the Field API plugins.

This class handles lazy replacement of default settings values.

Hierarchy

Expanded class hierarchy of PluginSettingsBase

1 file declares its use of PluginSettingsBase
PluginSettingsBaseTest.php in core/tests/Drupal/Tests/Core/Field/PluginSettingsBaseTest.php
Contains \Drupal\Tests\Core\Field\PluginSettingsBaseTest.

File

core/lib/Drupal/Core/Field/PluginSettingsBase.php, line 13

Namespace

Drupal\Core\Field
View source
abstract class PluginSettingsBase extends PluginBase implements PluginSettingsInterface, DependentPluginInterface {
    
    /**
     * The plugin settings.
     *
     * @var array
     */
    protected $settings = [];
    
    /**
     * The plugin settings injected by third party modules.
     *
     * @see hooks
     *
     * @var array
     */
    protected $thirdPartySettings = [];
    
    /**
     * Whether default settings have been merged into the current $settings.
     *
     * @var bool
     */
    protected $defaultSettingsMerged = FALSE;
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSettings() {
        // Merge defaults before returning the array.
        if (!$this->defaultSettingsMerged) {
            $this->mergeDefaults();
        }
        return $this->settings;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSetting($key) {
        // Merge defaults if we have no value for the key.
        if (!$this->defaultSettingsMerged && !array_key_exists($key, $this->settings)) {
            $this->mergeDefaults();
        }
        return $this->settings[$key] ?? NULL;
    }
    
    /**
     * Merges default settings values into $settings.
     */
    protected function mergeDefaults() {
        $this->settings += static::defaultSettings();
        $this->defaultSettingsMerged = TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setSettings(array $settings) {
        $this->settings = $settings;
        $this->defaultSettingsMerged = FALSE;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setSetting($key, $value) {
        $this->settings[$key] = $value;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getThirdPartySettings($module = NULL) {
        if ($module) {
            return $this->thirdPartySettings[$module] ?? [];
        }
        return $this->thirdPartySettings;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getThirdPartySetting($module, $key, $default = NULL) {
        return $this->thirdPartySettings[$module][$key] ?? $default;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setThirdPartySetting($module, $key, $value) {
        $this->thirdPartySettings[$module][$key] = $value;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function unsetThirdPartySetting($module, $key) {
        unset($this->thirdPartySettings[$module][$key]);
        // If the third party is no longer storing any information, completely
        // remove the array holding the settings for this module.
        if (empty($this->thirdPartySettings[$module])) {
            unset($this->thirdPartySettings[$module]);
        }
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getThirdPartyProviders() {
        return array_keys($this->thirdPartySettings);
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        if (!empty($this->thirdPartySettings)) {
            // Create dependencies on any modules providing third party settings.
            return [
                'module' => array_keys($this->thirdPartySettings),
            ];
        }
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function onDependencyRemoval(array $dependencies) {
        $changed = FALSE;
        if (!empty($this->thirdPartySettings) && !empty($dependencies['module'])) {
            $old_count = count($this->thirdPartySettings);
            $this->thirdPartySettings = array_diff_key($this->thirdPartySettings, array_flip($dependencies['module']));
            $changed = $old_count != count($this->thirdPartySettings);
        }
        return $changed;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$settings protected property The plugin settings. 2
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 43
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting

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