ConfigTable.php

Go to the documentation of this file.

<?php

namespace Elgg\Database;

use Elgg\BootService;
use Elgg\Database;
use Elgg\Exceptions\InvalidArgumentException;
use Elgg\Traits\Loggable;

class ConfigTable {
    
    use Loggable;
    
    public const TABLE_NAME = 'config';
    
    protected Database $db;
    
    protected BootService $boot;
    
    public function __construct(
        Database $db,
        BootService $boot
    ) {
        $this->db = $db;
        $this->boot = $boot;
    }

    public function remove(string $name): bool {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('name', '=', $name, ELGG_VALUE_STRING));
        
        $this->boot->clearCache();
        
        return $this->db->deleteData($delete) !== false;
    }
    
    public function set(string $name, $value): bool {
        if ($value === null) {
            // don't save null values to the DB
            throw new InvalidArgumentException(__METHOD__ . ' $value needs to be set');
        }
        
        if ($this->get($name) === null) {
            // $name doesn't exist yet
            $insert = Insert::intoTable(self::TABLE_NAME);
            $insert->values([
                'name' => $insert->param($name, ELGG_VALUE_STRING),
                'value' => $insert->param(serialize($value), ELGG_VALUE_STRING),
            ]);
            
            $result = $this->db->insertData($insert);
        } else {
            // $name already exist, so update
            $update = Update::table(self::TABLE_NAME);
            $update->set('value', $update->param(serialize($value), ELGG_VALUE_STRING))
                ->where($update->compare('name', '=', $name, ELGG_VALUE_STRING));
            
            $result = $this->db->updateData($update);
        }
        
        $this->boot->clearCache();
        
        return $result !== false;
    }
    
    public function get(string $name) {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('*')
            ->where($select->compare('name', '=', $name, ELGG_VALUE_STRING));
        
        $result = $this->db->getDataRow($select);
        if (!empty($result)) {
            return unserialize($result->value);
        }
        
        return null;
    }

    public function getAll(): array {
        $values = [];
        
        $qb = Select::fromTable(self::TABLE_NAME);
        $qb->select('*');
        
        $data = $this->db->getData($qb);
        foreach ($data as $row) {
            $values[$row->name] = unserialize($row->value);
        }
        
        // don't pull in old config values
        unset($values['path']);
        unset($values['dataroot']);
        unset($values['default_site']);
        
        return $values;
    }
}