Encoding.php

<?php
declare(strict_types=1);

/*
 * This file is part of the QuidPHP package <https://quidphp.com>
 * Author: Pierre-Philippe Emond <emondpph@gmail.com>
 * License: https://github.com/quidphp/base/blob/master/LICENSE
 */

namespace Quid\Base;

// encoding
// class which contains methods related to string encoding (manages mb overload)
final class Encoding extends Root
{
    // config
    protected static array $config = [
        'charset'=>null, // charset
        'charsetMb'=>['UTF-8'], // charset qui retourne vrai à la méthode isCharsetMb
        'mb'=>false // active les fonctions multibyte
    ];


    // is
    // retourne vrai si la chaîne est valide pour un encodage spécifique
    final public static function is($value,?string $charset=null):bool
    {
        return (is_string($value))? mb_check_encoding($value,self::getCharset($charset)):false;
    }


    // isMb
    // retourne vrai si la valeur est string et multibyte
    final public static function isMb($value):bool
    {
        return is_string($value) && strlen($value) !== mb_strlen($value,self::$config['charset']);
    }


    // isMbs
    // retourne vrai si une des chaînes est multibyte
    final public static function isMbs(...$values):bool
    {
        return Arr::some($values,fn($value) => self::isMb($value));
    }


    // isCharsetMb
    // retourne vrai si le charset est multibyte
    final public static function isCharsetMb($value):bool
    {
        return is_string($value) && Arr::in($value,self::$config['charsetMb'],false);
    }


    // exists
    // retourne vrai si l'encodage existe
    final public static function exists(string $value):bool
    {
        return in_array($value,mb_list_encodings(),true);
    }


    // get
    // retourne l'encodage de la chaîne
    final public static function get(string $value,$list=null,bool $strict=false):?string
    {
        return mb_detect_encoding($value,$list,$strict);
    }


    // set
    // change l'encodage de la chaîne
    final public static function set(string $return,?string $charset=null,?string $from=null)
    {
        $charset = self::getCharset($charset);
        $from = self::getCharset($from);

        if($charset !== $from)
        $return = mb_convert_encoding($return,$charset,$from);

        return $return;
    }


    // scrub
    // permet de remplacer les caractères illégaux en ?
    final public static function scrub(string $return,?string $charset=null):string
    {
        return mb_scrub($return,self::getCharset($charset));
    }


    // getInternal
    // retourne l'encoding interne de l'extension mbstring
    final public static function getInternal():string
    {
        return self::$config['charset'] = mb_internal_encoding();
    }


    // setInternal
    // change l'encoding interne de l'extension mbstring
    final public static function setInternal(string $charset):bool
    {
        $return = mb_internal_encoding($charset);
        if($return === true)
        self::$config['charset'] = $charset;

        return $return;
    }


    // getCharset
    // retourne le charset actuel ou celui donné en argument si c'est une string
    final public static function getCharset(?string $charset=null):string
    {
        return (is_string($charset))? $charset:self::$config['charset'];
    }


    // setCharset
    // change le charset actuel, change aussi dans la classe str
    final public static function setCharset(string $value):void
    {
        self::$config['charset'] = $value;
        Str::setCharset($value);
    }


    // getMb
    // retourne si multibyte est true ou false
    final public static function getMb($mb=null,$value=null):bool
    {
        $return = false;

        if(is_bool($mb))
        $return = $mb;

        elseif(is_bool(self::$config['mb']))
        $return = self::$config['mb'];

        elseif(is_string($value))
        $return = self::isMb($value);

        return $return;
    }


    // getMbs
    // retourne si multibyte est true ou false
    // si une des string contient un caractère multibyte, alors retourne true
    final public static function getMbs($mb=null,...$values):bool
    {
        $return = false;

        if(is_bool($mb))
        $return = $mb;

        elseif(is_bool(self::$config['mb']))
        $return = self::$config['mb'];

        elseif(!empty($values))
        $return = self::isMbs(...$values);

        return $return;
    }


    // setMb
    // change la valeur par défaut de mb
    final public static function setMb($mb):void
    {
        if(is_string($mb))
        $mb = self::isMb($mb);

        if(is_bool($mb) || $mb === null)
        self::$config['mb'] = $mb;
    }


    // toUtf8
    // alias pour utf8_encode
    final public static function toUtf8(string $value):string
    {
        return utf8_encode($value);
    }


    // fromUtf8
    // alias pour utf8_decode
    final public static function fromUtf8(string $value):string
    {
        return utf8_decode($value);
    }


    // info
    // retourne les informations sur l'extension mbstring
    final public static function info():array
    {
        return mb_get_info();
    }


    // all
    // affiche tous les encodages supportés
    final public static function all():array
    {
        return mb_list_encodings();
    }
}

// init
Encoding::setCharset('UTF-8');
?>