SilverStripe\Tests\ORM\Utf8\Utf8TestHelper

Complexity

Total Complexity

17

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getUpdatedUtfCharsetForCurrentDB()	0	6	4
A	getUpdatedUtfCollationForCurrentDB()	0	9	5
A	isMySqlGte80()	0	7	2
A	getDBVersion()	0	6	2
A	isMariaDBGte106()	0	7	4

<?php

namespace SilverStripe\Tests\ORM\Utf8;

use SilverStripe\Dev\TestOnly;
use SilverStripe\ORM\DB;

class Utf8TestHelper implements TestOnly
{
    private ?string $dbVersion = null;

    public function getUpdatedUtfCharsetForCurrentDB(string $charset): string
    {
        if ($charset !== 'utf8') {
            return $charset;
        }
        return $this->isMySqlGte80() || $this->isMariaDBGte106() ? 'utf8mb3' : 'utf8';
    }

    public function getUpdatedUtfCollationForCurrentDB(string $collation): string
    {
        if ($collation === 'utf8_general_ci') {
            return $this->isMariaDBGte106() ? 'utf8mb3_general_ci' : 'utf8_general_ci';
        }
        if ($collation === 'utf8_unicode_520_ci') {
            return $this->isMariaDBGte106() ? 'utf8mb3_unicode_520_ci' : 'utf8_unicode_520_ci';
        }
        return $collation;
    }

    /**
     * MySQL has used utf8 as an alias for utf8mb3
     * Beginning with MySQL 8.0.28, utf8mb3 is used
     * https://dev.mysql.com/doc/refman/8.0/en/charset-unicode-utf8mb3.html
     */
    private function isMySqlGte80(): bool
    {
        // Example MySQL version: 8.0.29
        if (preg_match('#^([0-9]+)\.[0-9]+\.[0-9]+$#', $this->getDBVersion(), $m)) {
            return (int) $m[1] >= 8;
        }
        return false;
    }

    /**
     * Until MariaDB 10.5, utf8mb3 was an alias for utf8.
     * From MariaDB 10.6, utf8 is by default an alias for utf8mb3
     * https://mariadb.com/kb/en/unicode/
     */
    private function isMariaDBGte106(): bool
    {
        // Example mariadb version: 5.5.5-10.6.8-mariadb-1:10.6.8+maria~focal
        if (preg_match('#([0-9]+)\.([0-9]+)\.[0-9]+-mariadb#', $this->getDBVersion(), $m)) {
            return (int) $m[1] >= 11 || ((int) $m[1] >= 10 && (int) $m[2] >= 6);
        }
        return false;
    }

    private function getDBVersion(): string
    {
        if (is_null($this->dbVersion)) {
            $this->dbVersion = strtolower(DB::get_conn()->getVersion());
        }
        return $this->dbVersion;
    }
}