ilDBConstants.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Database\FieldDefinition;
 
class ilDBConstants
{
    public const FETCHMODE_ASSOC = 2;
    public const FETCHMODE_OBJECT = 3;
    public const FETCHMODE_DEFAULT = self::FETCHMODE_ASSOC;
    // Main Types
    public const TYPE_INNODB = 'innodb';
    public const TYPE_MYSQL = 'mysql';
    // Experimental
    public const TYPE_GALERA = 'galera';
    public const TYPE_MYSQLI = 'mysqli';
    // Development identifiers (will be removed in 5.3), are mapped with Main and Experimental types
    public const TYPE_PDO_MYSQL_INNODB = 'pdo-mysql-innodb';
    public const TYPE_PDO_MYSQL_GALERA = 'pdo-mysql-galera';
    // Locks
    public const LOCK_WRITE = ilAtomQuery::LOCK_WRITE;
    public const LOCK_READ = ilAtomQuery::LOCK_READ;
    // Modules
    public const MODULE_MANAGER = 'Manager';
    public const MODULE_REVERSE = 'Reverse';
    // Formats
    public const INDEX_FORMAT = FieldDefinition::INDEX_FORMAT;
    public const SEQUENCE_FORMAT = FieldDefinition::SEQUENCE_FORMAT;
    public const SEQUENCE_COLUMNS_NAME = FieldDefinition::SEQUENCE_COLUMNS_NAME;
    // Types
    public const T_CLOB = FieldDefinition::T_CLOB;
    public const T_DATE = FieldDefinition::T_DATE;
    public const T_DATETIME = FieldDefinition::T_DATETIME;
    public const T_FLOAT = FieldDefinition::T_FLOAT;
    public const T_INTEGER = FieldDefinition::T_INTEGER;
    public const T_TEXT = FieldDefinition::T_TEXT;
    public const T_TIME = FieldDefinition::T_TIME;
    public const T_TIMESTAMP = FieldDefinition::T_TIMESTAMP;
    public const T_BLOB = FieldDefinition::T_BLOB;
    // Engines
    public const MYSQL_ENGINE_INNODB = 'InnoDB';
    // Characters
    public const MYSQL_CHARACTER_UTF8 = 'utf8';
    public const MYSQL_CHARACTER_UTF8MB4 = 'utf8mb4';
    // Collations
    public const MYSQL_COLLATION_UTF8 = 'utf8_general_ci';
    public const MYSQL_COLLATION_UTF8MB4 = 'utf8mb4_general_ci';
    public const MYSQL_COLLATION_UTF8_CZECH = "utf8_czech_ci";
    public const MYSQL_COLLATION_UTF8_DANISH = "utf8_danish_ci";
    public const MYSQL_COLLATION_UTF8_ESTONIAN = "utf8_estonian_ci";
    public const MYSQL_COLLATION_UTF8_ICELANDIC = "utf8_icelandic_ci";
    public const MYSQL_COLLATION_UTF8_LATVIAN = "utf8_latvian_ci";
    public const MYSQL_COLLATION_UTF8_LITHUANIAN = "utf8_lithuanian_ci";
    public const MYSQL_COLLATION_UTF8_PERSIAN = "utf8_persian_ci";
    public const MYSQL_COLLATION_UTF8_POLISH = "utf8_polish_ci";
    public const MYSQL_COLLATION_UTF8_ROMAN = "utf8_roman_ci";
    public const MYSQL_COLLATION_UTF8_ROMANIAN = "utf8_romanian_ci";
    public const MYSQL_COLLATION_UTF8_SLOVAK = "utf8_slovak_ci";
    public const MYSQL_COLLATION_UTF8_SLOVENIAN = "utf8_slovenian_ci";
    public const MYSQL_COLLATION_UTF8_SPANISH2 = "utf8_spanish2_ci";
    public const MYSQL_COLLATION_UTF8_SPANISH = "utf8_spanish_ci";
    public const MYSQL_COLLATION_UTF8_SWEDISH = "utf8_swedish_ci";
    public const MYSQL_COLLATION_UTF8_TURKISH = "utf8_turkish_ci";
    public const MYSQL_COLLATION_UTF8MB4_UNICODE = 'utf8mb4_unicode_ci';
    public const MYSQL_COLLATION_UTF8MB4_520 = 'utf8mb4_unicode_520_ci';
    public const MYSQL_COLLATION_UTF8MB4_0900 = 'utf8mb4_0900_ai_ci';
    public const MARIADB_COLLATION_UCA = 'uca1400_ai_ci';
 
    // Mapping AutoExec
    public const AUTOQUERY_INSERT = 1;
    public const AUTOQUERY_UPDATE = 2;
    public const AUTOQUERY_DELETE = 3;
    public const AUTOQUERY_SELECT = 4;
    public const PREPARE_MANIP = false;
    // Other
    public const MB4_REPLACEMENT = "?";
    protected static array $descriptions = [
        // Main
        ilDBConstants::TYPE_MYSQL => "MySQL 5.7.x or higher with InnoDB-Engine",
        ilDBConstants::TYPE_MYSQLI => "MySQL 5.7.x or higher with InnoDB-Engine",
        ilDBConstants::TYPE_INNODB => "MySQL 5.7.x or higher with InnoDB-Engine",
        ilDBConstants::TYPE_GALERA => "Galera-Cluster (experimental)",
        // Development identifiers (will be removed in 5.3)
        ilDBConstants::TYPE_PDO_MYSQL_GALERA => "Galera-Cluster (experimental) [developers-identifier]",
    ];
 
 
    public static function getInstallableTypes(): array
    {
        return [
            // Main
            ilDBConstants::TYPE_MYSQL,
            ilDBConstants::TYPE_INNODB,
            // Experimental
            ilDBConstants::TYPE_GALERA,
            ilDBConstants::TYPE_GALERA,
        ];
    }
 
    public static function getAvailableTypes(bool $with_descriptions = true): array
    {
        $types = self::getSupportedTypes();
        if ($with_descriptions) {
            $return = [];
            foreach ($types as $type) {
                $return [$type] = self::describe($type);
            }
            $types = $return;
        }
 
        return $types;
    }
 
 
    public static function getSupportedTypes(): array
    {
        return [
            ilDBConstants::TYPE_MYSQL,
            ilDBConstants::TYPE_INNODB,
            ilDBConstants::TYPE_GALERA,
        ];
    }
 
    public static function getAvailableCollations(): array
    {
        return [
            ilDBConstants::MYSQL_COLLATION_UTF8,
            ilDBConstants::MYSQL_COLLATION_UTF8MB4,
            ilDBConstants::MYSQL_COLLATION_UTF8_CZECH,
            ilDBConstants::MYSQL_COLLATION_UTF8_DANISH,
            ilDBConstants::MYSQL_COLLATION_UTF8_ESTONIAN,
            ilDBConstants::MYSQL_COLLATION_UTF8_ICELANDIC,
            ilDBConstants::MYSQL_COLLATION_UTF8_LATVIAN,
            ilDBConstants::MYSQL_COLLATION_UTF8_LITHUANIAN,
            ilDBConstants::MYSQL_COLLATION_UTF8_PERSIAN,
            ilDBConstants::MYSQL_COLLATION_UTF8_POLISH,
            ilDBConstants::MYSQL_COLLATION_UTF8_ROMAN,
            ilDBConstants::MYSQL_COLLATION_UTF8_ROMANIAN,
            ilDBConstants::MYSQL_COLLATION_UTF8_SLOVAK,
            ilDBConstants::MYSQL_COLLATION_UTF8_SLOVENIAN,
            ilDBConstants::MYSQL_COLLATION_UTF8_SPANISH2,
            ilDBConstants::MYSQL_COLLATION_UTF8_SPANISH,
            ilDBConstants::MYSQL_COLLATION_UTF8_SWEDISH,
            ilDBConstants::MYSQL_COLLATION_UTF8_TURKISH,
            ilDBConstants::MYSQL_COLLATION_UTF8MB4_UNICODE,
            ilDBConstants::MYSQL_COLLATION_UTF8MB4_520,
            ilDBConstants::MYSQL_COLLATION_UTF8MB4_0900,
            ilDBConstants::MARIADB_COLLATION_UCA,
        ];
    }
 
    public static function isUTF8MB4Collation(string $collation): bool
    {
        return in_array($collation, [
            ilDBConstants::MYSQL_COLLATION_UTF8MB4,
            ilDBConstants::MYSQL_COLLATION_UTF8MB4_UNICODE,
            ilDBConstants::MYSQL_COLLATION_UTF8MB4_520,
            ilDBConstants::MYSQL_COLLATION_UTF8MB4_0900,
            ilDBConstants::MARIADB_COLLATION_UCA,
        ], true);
    }
 
    public static function describe(string $type): string
    {
        return self::$descriptions[$type];
    }
}