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 $db;
    protected $dbprefix;
    protected $dbhost;
    protected $dbport;
    protected $dbuser;
    protected $dbpass;
    protected $dbname;
    protected $dbencoding;

    public function __construct(\stdClass $config) {
        foreach (array_keys(get_class_vars(__CLASS__)) as $prop) {
            $this->{$prop} = isset($config->{$prop}) ? $config->{$prop} : null;
        }
    }

    public static function fromElggConfig(Config $config) {
        $obj = new \stdClass();
        foreach (array_keys(get_class_vars(__CLASS__)) as $prop) {
            $obj->{$prop} = $config->{$prop};
        }
        return new self($obj);
    }

    public function getTablePrefix() {
        return (string) $this->dbprefix;
    }

    public function isDatabaseSplit() {
        if (isset($this->db['split'])) {
            return $this->db['split'];
        }

        // this was the recommend structure from Elgg 1.0 to 1.8
        if (isset($this->db->split)) {
            elgg_deprecated_notice('Database configuration should be updated to an array. Check the settings.example.php', '4.3');
            
            return $this->db->split;
        }

        return false;
    }

    public function getConnectionConfig($type = self::READ_WRITE) {
        switch ($type) {
            case self::READ:
            case self::WRITE:
                $config = $this->getParticularConnectionConfig($type);
                break;
            default:
                $config = $this->getGeneralConnectionConfig();
                break;
        }

        $config['encoding'] = $this->dbencoding ? $this->dbencoding : 'utf8';
        $config['prefix'] = $this->dbprefix;

        return $config;
    }

    protected function getGeneralConnectionConfig() {
        return [
            'host' => $this->dbhost,
            'port' => $this->dbport,
            'user' => $this->dbuser,
            'password' => $this->dbpass,
            'database' => $this->dbname,
        ];
    }

    protected function getParticularConnectionConfig($type) {
        if (is_object($this->db[$type])) {
            elgg_deprecated_notice('Database configuration should be updated to an array. Check the settings.example.php', '4.3');

            // old style single connection (Elgg < 1.9)
            $config = [
                '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,
            ];
        } else if (array_key_exists('dbhost', $this->db[$type])) {
            // new style single connection
            $config = [
                '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'],
            ];
        } else if (is_object(current($this->db[$type]))) {
            elgg_deprecated_notice('Database configuration should be updated to an array. Check the settings.example.php', '4.3');

            // old style multiple connections
            $index = array_rand($this->db[$type]);
            $config = [
                '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,
            ];
        } else {
            // new style multiple connections
            $index = array_rand($this->db[$type]);
            $config = [
                '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'],
            ];
        }

        return $config;
    }
}