function Source::makeFriendlyName

Converts a camel caps name into a readable string.

Parameters

string $name The camel caps name to convert.:

Return value

string

1 call to Source::makeFriendlyName()

Source::generate in vendor/squizlabs/php_codesniffer/src/Reports/Source.php

Prints the source of all errors and warnings.

File

vendor/squizlabs/php_codesniffer/src/Reports/Source.php, line 283

Class

Source

Namespace

PHP_CodeSniffer\Reports

Code

public function makeFriendlyName($name) {
    if (trim($name) === '') {
        return '';
    }
    $friendlyName = '';
    $length = strlen($name);
    $lastWasUpper = false;
    $lastWasNumeric = false;
    for ($i = 0; $i < $length; $i++) {
        if (is_numeric($name[$i]) === true) {
            if ($lastWasNumeric === false) {
                $friendlyName .= ' ';
            }
            $lastWasUpper = false;
            $lastWasNumeric = true;
        }
        else {
            $lastWasNumeric = false;
            $char = strtolower($name[$i]);
            if ($char === $name[$i]) {
                // Lowercase.
                $lastWasUpper = false;
            }
            else {
                // Uppercase.
                if ($lastWasUpper === false) {
                    $friendlyName .= ' ';
                    if ($i < $length - 1) {
                        $next = $name[$i + 1];
                        if (strtolower($next) === $next) {
                            // Next char is lowercase so it is a word boundary.
                            $name[$i] = strtolower($name[$i]);
                        }
                    }
                }
                $lastWasUpper = true;
            }
        }
        
        //end if
        $friendlyName .= $name[$i];
    }
    
    //end for
    $friendlyName = trim($friendlyName);
    $friendlyName[0] = strtoupper($friendlyName[0]);
    return $friendlyName;
}