PluginSettings.php

Go to the documentation of this file.

<?php

namespace Elgg\Traits\Entity;

trait PluginSettings {
    
    public function setPluginSetting(string $plugin_id, string $name, $value): bool {
        $value = _elgg_services()->hooks->trigger('plugin_setting', $this->getType(), [
            'entity' => $this,
            'plugin_id' => $plugin_id,
            'name' => $name,
            'value' => $value,
        ], $value);
        
        if (isset($value) && !is_scalar($value)) {
            elgg_log("Invalid value type provided to save plugin setting '{$name}' for plugin '{$plugin_id}' only scalars are allowed", 'ERROR');
            return false;
        }
        
        $name = $this->getNamespacedPluginSettingName($plugin_id, $name);
        
        return $this->setPrivateSetting($name, $value);
    }
    
    public function getPluginSetting(string $plugin_id, string $name, $default = null): string {
        $name = $this->getNamespacedPluginSettingName($plugin_id, $name);
        
        return (string) ($this->getPrivateSetting($name) ?? $default);
    }
    
    public function removePluginSetting(string $plugin_id, string $name): bool {
        $name = $this->getNamespacedPluginSettingName($plugin_id, $name);
        
        return $this->removePrivateSetting($name);
    }
    
    final public function getNamespacedPluginSettingName(string $plugin_id, string $name): string {
        return "plugin:{$this->getType()}_setting:{$plugin_id}:{$name}";
    }
}