mb_vsprintf()

Complexity

Conditions	15
Paths	176

Size

Total Lines	85
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	25
CRAP Score	33.1146

Importance

Changes	1
Bugs	0	Features	0

<?php
    function mb_vsprintf($format, $argv, $encoding = null): string
    {
        if (!is_array($argv)) {
            $argv = [$argv];
        }
        
        if (is_null($encoding)) {
            $encoding = mb_internal_encoding();
        }
        
        // Use UTF-8 in the format so we can use the u flag in preg_split
        $format = mb_convert_encoding($format, 'UTF-8', $encoding);
        $newFormat = '';
        
        // build a new format in UTF-8
        $newArgv = [];
        
        // unhandled args in unchanged encoding
        while ($format !== '') {
            
            // Split the format in two parts: $pre and $post by the first %-directive
            // We get also the matched groups
            $split = preg_split("!\%(\+?)('.|[0 ]|)(-?)([1-9][0-9]*|)(\.[1-9][0-9]*|)([%a-zA-Z])!u", $format, 2, PREG_SPLIT_DELIM_CAPTURE);

It seems like $format can also be of type array; however, parameter $subject of preg_split() does only seem to accept string, maybe add an additional type check?

            $pre = $split[0] ?? null;
            $sign = $split[1] ?? null;
            $filler = $split[2] ?? null;
            $align = $split[3] ?? null;
            $size = $split[4] ?? null;
            $precision = $split[5] ?? null;
            $type = $split[6] ?? null;
            $post = $split[7] ?? null;
            
            $newFormat .= mb_convert_encoding($pre, $encoding, 'UTF-8');

It seems like $pre can also be of type null; however, parameter $string of mb_convert_encoding() does only seem to accept array|string, maybe add an additional type check?

            
            if ($type === '') {
                // didn't match. do nothing. this is the last iteration.
            }
            elseif ($type === '%') {
                // an escaped %
                $newFormat .= '%%';
            }
            elseif ($type === 's') {
                $arg = array_shift($argv);
                $arg = mb_convert_encoding($arg, 'UTF-8', $encoding);
                $paddingPre = '';
                $paddingPost = '';
                
                // truncate $arg
                if ($precision !== '') {
                    $precision = intval(substr($precision, 1));

It seems like $precision can also be of type null; however, parameter $string of substr() does only seem to accept string, maybe add an additional type check?

                    if ($precision > 0 && mb_strlen($arg, $encoding) > $precision) {

It seems like $arg can also be of type array; however, parameter $string of mb_strlen() does only seem to accept string, maybe add an additional type check?

                        $arg = mb_substr($precision, 0, $precision, $encoding);
                    }
                }
                
                // define padding
                if ($size > 0) {
                    $argLength = mb_strlen($arg, $encoding);
                    if ($argLength < $size) {
                        if ($filler === '') {
                            $filler = ' ';
                        }
                        if ($align === '-') {
                            $paddingPost = str_repeat($filler, $size - $argLength);
                        }
                        else {
                            $paddingPre = str_repeat($filler, $size - $argLength);
                        }
                    }
                }
                
                // escape % and pass it forward
                $newFormat .= $paddingPre . str_replace('%', '%%', $arg) . $paddingPost;
            }
            else {
                // another type, pass forward
                $newFormat .= "%$sign$filler$align$size$precision$type";
                $newArgv[] = array_shift($argv);
            }
            
            $format = strval($post);
        }
        // Convert new format back from UTF-8 to the original encoding
        $newFormat = mb_convert_encoding($newFormat, $encoding, 'UTF-8');
        return !empty($newArgv) ? vsprintf($newFormat, $newArgv) : $newFormat;

It seems like $newFormat can also be of type array; however, parameter $format of vsprintf() does only seem to accept string, maybe add an additional type check?

The expression return ! empty($newArgv) ? vsprintf($newFormat, $newArgv) : $newFormat could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }