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()->events->triggerResults('plugin_setting', $this->getType(), [
            'entity' => $this,
            'plugin_id' => $plugin_id,
            'name' => $name,
            'value' => $value,
        ], $value);
        
        $name = $this->getNamespacedPluginSettingName($plugin_id, $name);
        
        return elgg_call(ELGG_DISABLE_SYSTEM_LOG, function() use ($name, $value) {
            return $this->setMetadata($name, $value);
        });
    }
    
    public function getPluginSetting(string $plugin_id, string $name, $default = null) {
        $plugin = _elgg_services()->plugins->get($plugin_id);
        if (!$plugin instanceof \ElggPlugin || !$plugin->isActive()) {
            return $default;
        }
        
        $name = $this->getNamespacedPluginSettingName($plugin_id, $name);
        
        return $this->getMetadata($name) ?? $default;
    }
    
    public function removePluginSetting(string $plugin_id, string $name): bool {
        $name = $this->getNamespacedPluginSettingName($plugin_id, $name);
        
        return elgg_call(ELGG_DISABLE_SYSTEM_LOG, function() use ($name) {
            return $this->deleteMetadata($name);
        });
    }
    
    final public function getNamespacedPluginSettingName(string $plugin_id, string $name): string {
        return "plugin:{$this->getType()}_setting:{$plugin_id}:{$name}";
    }
}