Inheritance diagram for ilDatabaseSetupConfig:

Collaboration diagram for ilDatabaseSetupConfig:

Public Member Functions
	__construct (string $type, string $host, string $database, string $user, Password $password=null, bool $create_database=true, string $collation=null, int $port=null, string $path_to_db_dump=null)

	getType ()

	getHost ()

	getPort ()

	getDatabase ()

	getCreateDatabase ()

	getCollation ()

	getUser ()

	getPassword ()

	getPathToDBDump ()

	toMockIniFile ()
	Adapter to current database-handling via a mock of \ilIniFile. More...

Data Fields
const	DEFAULT_COLLATION = "utf8_general_ci"

const	DEFAULT_PATH_TO_DB_DUMP = "./setup/sql/ilias3.sql"

ilDatabaseSetupConfig	$config

Protected Attributes
string	$type

string	$host

int	$port = null

string	$database

bool	$create_database

string	$collation

string	$user

ILIAS Data Password	$password = null

string	$path_to_db_dump

Detailed Description

Definition at line 24 of file class.ilDatabaseSetupConfig.php.

Constructor & Destructor Documentation

◆ __construct()

ilDatabaseSetupConfig::__construct	(	string	$type,
		string	$host,
		string	$database,
		string	$user,
		Password	$password = `null`,
		bool	$create_database = `true`,
		string	$collation = `null`,
		int	$port = `null`,
		string	$path_to_db_dump = `null`
	)

Definition at line 49 of file class.ilDatabaseSetupConfig.php.

      {
        if (!in_array($type, \ilDBConstants::getInstallableTypes())) {
            throw new \InvalidArgumentException(
                "Unknown database type: $type"
            );
        }
        if ($collation && !in_array(trim($collation), \ilDBConstants::getAvailableCollations())) {
            throw new \InvalidArgumentException(
                "Unknown collation: $collation"
            );
        }
        $this->type = trim($type);
        $this->host = trim($host);
        $this->database = trim($database);
        $this->user = trim($user);
        $this->password = $password;
        $this->create_database = $create_database;
        $this->collation = $collation ? trim($collation) : self::DEFAULT_COLLATION;
        $this->port = $port;
        $this->path_to_db_dump = $path_to_db_dump ?? self::DEFAULT_PATH_TO_DB_DUMP;
    }

References $collation, $create_database, $database, $host, $password, $path_to_db_dump, $port, $type, $user, DEFAULT_COLLATION, DEFAULT_PATH_TO_DB_DUMP, ilDBConstants\getAvailableCollations(), ilDBConstants\getInstallableTypes(), and ILIAS\Repository\user().

Referenced by toMockIniFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ getCollation()

ilDatabaseSetupConfig::getCollation ( )

Definition at line 106 of file class.ilDatabaseSetupConfig.php.

                                  : string
    {
        return $this->collation;
    }

References $collation.

◆ getCreateDatabase()

ilDatabaseSetupConfig::getCreateDatabase ( )

Definition at line 101 of file class.ilDatabaseSetupConfig.php.

                                       : bool
    {
        return $this->create_database;
    }

References $create_database.

◆ getDatabase()

ilDatabaseSetupConfig::getDatabase ( )

Definition at line 96 of file class.ilDatabaseSetupConfig.php.

                                 : string
    {
        return $this->database;
    }

References $database.

◆ getHost()

ilDatabaseSetupConfig::getHost ( )

Definition at line 86 of file class.ilDatabaseSetupConfig.php.

                             : string
    {
        return $this->host;
    }

References $host.

◆ getPassword()

ilDatabaseSetupConfig::getPassword ( )

Definition at line 116 of file class.ilDatabaseSetupConfig.php.

                                 : ?Password
    {
        return $this->password;
    }

References $password.

◆ getPathToDBDump()

ilDatabaseSetupConfig::getPathToDBDump ( )

Definition at line 121 of file class.ilDatabaseSetupConfig.php.

                                     : string
    {
        return $this->path_to_db_dump;
    }

References $path_to_db_dump.

◆ getPort()

ilDatabaseSetupConfig::getPort ( )

Definition at line 91 of file class.ilDatabaseSetupConfig.php.

                             : ?int
    {
        return $this->port;
    }

References $port.

◆ getType()

ilDatabaseSetupConfig::getType ( )

Definition at line 81 of file class.ilDatabaseSetupConfig.php.

                             : string
    {
        return $this->type;
    }

References $type.

◆ getUser()

ilDatabaseSetupConfig::getUser ( )

Definition at line 111 of file class.ilDatabaseSetupConfig.php.

                             : string
    {
        return $this->user;
    }

References $user.

◆ toMockIniFile()

ilDatabaseSetupConfig::toMockIniFile ( )

Adapter to current database-handling via a mock of \ilIniFile.

reads a single variable from a group @access public

Parameters

string	group name
string	value

Returns: mixed|void return value string or boolean 'false' on failure

Definition at line 129 of file class.ilDatabaseSetupConfig.php.

                                   : \ilIniFile
    {
        return new class ($this) extends \ilIniFile {
            public function readVariable(string $a_group, string $a_var_name): string
            {
                if ($a_group !== "db") {
                    throw new \LogicException(
                        "Can only access db-config via this mock."
                    );
                }
                switch ($a_var_name) {
                    case "user":
                        return $this->config->getUser();
                    case "host":
                        return $this->config->getHost();
                    case "port":
                        return (string) $this->config->getPort();
                    case "pass":
                        $pw = $this->config->getPassword();
                        return $pw ? $pw->toString() : "";
                    case "name":
                        return $this->config->getDatabase();
                    case "type":
                        return $this->config->getType();
                    default:
                        throw new \LogicException(
                            "Cannot provide variable '$a_var_name'"
                        );
                }
            }
 
            public function __construct(\ilDatabaseSetupConfig $config)
            {
                $this->config = $config;
            }
            public function read(): bool
            {
                throw new \LogicException("Just a mock here...");
            }
            public function parse(): bool
            {
                throw new \LogicException("Just a mock here...");
            }
            public function fixIniFile(): void
            {
                throw new \LogicException("Just a mock here...");
            }
            public function write(): bool
            {
                throw new \LogicException("Just a mock here...");
            }
            public function show(): string
            {
                throw new \LogicException("Just a mock here...");
            }
            public function getGroupCount(): int
            {
                throw new \LogicException("Just a mock here...");
            }
            public function readGroups(): array
            {
                throw new \LogicException("Just a mock here...");
            }
            public function groupExists(string $a_group_name): bool
            {
                throw new \LogicException("Just a mock here...");
            }
            public function readGroup(string $a_group_name): array
            {
                throw new \LogicException("Just a mock here...");
            }
            public function addGroup(string $a_group_name): bool
            {
                throw new \LogicException("Just a mock here...");
            }
            public function removeGroup(string $a_group_name): bool
            {
                throw new \LogicException("Just a mock here...");
            }
            public function variableExists(string $a_group, string $a_var_name): bool
            {
                throw new \LogicException("Just a mock here...");
            }
            public function setVariable(string $a_group_name, string $a_var_name, string $a_var_value): bool
            {
                throw new \LogicException("Just a mock here...");
            }
            public function error(string $a_errmsg): bool
            {
                throw new \LogicException("Just a mock here...");
            }
            public function getError(): string
            {
                throw new \LogicException("Just a mock here...");
            }
        };
    }