DbConfig.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Database;
 
use Elgg\Config;
 
class DbConfig {
 
    const READ = 'read';
    const WRITE = 'write';
    const READ_WRITE = 'readwrite';
    
    protected ?array $db;
    
    protected ?string $dbprefix;
    
    protected ?string $dbhost;
    
    protected ?int $dbport;
    
    protected ?string $dbuser;
    
    protected ?string $dbpass;
    
    protected ?string $dbname;
    
    protected ?string $dbencoding;
 
    public function __construct(\stdClass $config) {
        foreach (array_keys(get_class_vars(__CLASS__)) as $prop) {
            $this->{$prop} = $config->{$prop} ?? null;
        }
    }
 
    public static function fromElggConfig(Config $config): DbConfig {
        $obj = new \stdClass();
        foreach (array_keys(get_class_vars(__CLASS__)) as $prop) {
            $obj->{$prop} = $config->{$prop};
        }
        
        return new self($obj);
    }
 
    public function getTablePrefix(): string {
        return (string) $this->dbprefix;
    }
 
    public function isDatabaseSplit(): bool {
        return $this->db['split'] ?? false;
    }
 
    public function getConnectionConfig(string $type = self::READ_WRITE): array {
        switch ($type) {
            case self::READ:
            case self::WRITE:
                $config = $this->getParticularConnectionConfig($type);
                break;
            default:
                $config = $this->getGeneralConnectionConfig();
                break;
        }
 
        $config['encoding'] = $this->dbencoding ?: 'utf8';
        $config['prefix'] = $this->dbprefix;
 
        return $config;
    }
 
    protected function getGeneralConnectionConfig(): array {
        return [
            'host' => $this->dbhost,
            'port' => $this->dbport,
            'user' => $this->dbuser,
            'password' => $this->dbpass,
            'database' => $this->dbname,
        ];
    }
 
    protected function getParticularConnectionConfig(string $type): array {
        if (array_key_exists('dbhost', $this->db[$type])) {
            // single connection
            return [
                'host' => $this->db[$type]['dbhost'],
                'port' => $this->db[$type]['dbport'],
                'user' => $this->db[$type]['dbuser'],
                'password' => $this->db[$type]['dbpass'],
                'database' => $this->db[$type]['dbname'],
            ];
        }
        
        // new style multiple connections
        $index = array_rand($this->db[$type]);
        return [
            'host' => $this->db[$type][$index]['dbhost'],
            'port' => $this->db[$type][$index]['dbport'],
            'user' => $this->db[$type][$index]['dbuser'],
            'password' => $this->db[$type][$index]['dbpass'],
            'database' => $this->db[$type][$index]['dbname'],
        ];
    }
}