ConfigTable.php

Go to the documentation of this file.

<?php
namespace Elgg\Database;

class ConfigTable {
        
    private $CONFIG;

    public function __construct() {
        global $CONFIG;
        $this->CONFIG = $CONFIG;
    }

    function remove($name, $site_guid = 0) {
        
    
        $name = trim($name);
    
        $site_guid = (int) $site_guid;
        if ($site_guid == 0) {
            $site_guid = (int) $this->CONFIG->site_guid;
        }
    
        if ($site_guid == $this->CONFIG->site_guid && isset($this->CONFIG->$name)) {
            unset($this->CONFIG->$name);
        }
    
        $escaped_name = sanitize_string($name);
        $query = "DELETE FROM {$this->CONFIG->dbprefix}config WHERE name = '$escaped_name' AND site_guid = $site_guid";
    
        return _elgg_services()->db->deleteData($query) !== false;
    }
    
    function set($name, $value, $site_guid = 0) {
        
    
        $name = trim($name);
    
        // cannot store anything longer than 255 characters in db, so catch before we set
        if (elgg_strlen($name) > 255) {
            _elgg_services()->logger->error("The name length for configuration variables cannot be greater than 255");
            return false;
        }
    
        $site_guid = (int) $site_guid;
        if ($site_guid == 0) {
            $site_guid = (int) $this->CONFIG->site_guid;
        }
    
        if ($site_guid == $this->CONFIG->site_guid) {
            $this->CONFIG->$name = $value;
        }
    
        $escaped_name = sanitize_string($name);
        $escaped_value = sanitize_string(serialize($value));
        $result = _elgg_services()->db->insertData("INSERT INTO {$this->CONFIG->dbprefix}config
            SET name = '$escaped_name', value = '$escaped_value', site_guid = $site_guid
            ON DUPLICATE KEY UPDATE value = '$escaped_value'");
    
        return $result !== false;
    }
    
    function get($name, $site_guid = 0) {
        
    
        $name = trim($name);
    
        $site_guid = (int) $site_guid;
    
        // check for deprecated values.
        // @todo might be a better spot to define this?
        $new_name = false;
        switch($name) {
            case 'viewpath':
                $new_name = 'view_path';
                break;
    
            case 'pluginspath':
                $new_name = 'plugins_path';
                break;
    
            case 'sitename':
                $new_name = 'site_name';
                break;
        }
    
        // @todo these haven't really been implemented in Elgg 1.8. Complete in 1.9.
        // show dep message
        if ($new_name) {
            //  $msg = "Config value $name has been renamed as $new_name";
            $name = $new_name;
            //  elgg_deprecated_notice($msg, $dep_version);
        }
    
        if ($site_guid == 0) {
            $site_guid = (int) $this->CONFIG->site_guid;
        }
    
        // decide from where to return the value
        if ($site_guid == $this->CONFIG->site_guid && isset($this->CONFIG->$name)) {
            return $this->CONFIG->$name;
        }
    
        $escaped_name = sanitize_string($name);
        $result = _elgg_services()->db->getDataRow("SELECT value FROM {$this->CONFIG->dbprefix}config
            WHERE name = '$escaped_name' AND site_guid = $site_guid");
    
        if ($result) {
            $result = unserialize($result->value);
    
            if ($site_guid == $this->CONFIG->site_guid) {
                $this->CONFIG->$name = $result;
            }
    
            return $result;
        }
    
        return null;
    }
    
    function loadAll($site_guid = 0) {
        
    
        $site_guid = (int) $site_guid;
    
        if ($site_guid == 0) {
            $site_guid = (int) $this->CONFIG->site_guid;
        }
    
        if ($result = _elgg_services()->db->getData("SELECT * FROM {$this->CONFIG->dbprefix}config WHERE site_guid = $site_guid")) {
            foreach ($result as $r) {
                $name = $r->name;
                $value = $r->value;
                $this->CONFIG->$name = unserialize($value);
            }
    
            return true;
        }
        return false;
    }
}