Spiral\Support\Strings

Complexity

Total Complexity

22

Size/Duplication

Total Lines	182
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	random()	0	8	2
A	slug()	0	4	1
A	escape()	0	12	4
A	shorter()	0	8	2
A	bytes()	0	9	3
A	normalizeEndings()	0	8	2
B	normalizeIndents()	0	53	8

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */
namespace Spiral\Support;

use Cocur\Slugify\SlugifyInterface;

/**
 * Set of helper methods to simplify working with string values.
 */
class Strings
{
    /**
     * Create a random string with desired length.
     *
     * @param int $length String length. 32 symbols by default.
     *
     * @return string
     */
    public static function random(int $length = 32): string
    {
        if (empty($string = openssl_random_pseudo_bytes($length))) {
            throw new \RuntimeException("Unable to generate random string");
        }

        return substr(base64_encode($string), 0, $length);
    }

    /**
     * Return a URL safe version of a string.
     *
     * @param string $string
     * @param string $separator
     *
     * @return string
     */
    public static function slug(string $string, string $separator = '-'): string
    {
        return spiral(SlugifyInterface::class)->slugify($string, $separator);
    }

    /**
     * Applies htmlentities() and strip_tags() to string (if enabled). Can be used to clean up
     * data before rendering it in HTML.
     *
     * @param string $string    String to be escaped.
     * @param bool   $stripTags Will remove all tags using strip_tags(). Disabled by default.
     *
     * @return string
     */
    public static function escape($string, bool $stripTags = false)
    {
        if (is_array($string) || is_object($string)) {
            return '';
        }

        if ($stripTags) {
            $string = strip_tags($string);
        }

        return htmlentities($string, ENT_QUOTES, 'UTF-8', false);
    }

    /**
     * Shorter string with specified limit. UTF8 encoding will be used to support non English
     * strings.
     *
     * @param string $string
     * @param int    $limit The max string length, 300 by default.
     *
     * @return string
     */
    public static function shorter(string $string, int $limit = 300): string
    {
        if (mb_strlen($string) + 3 > $limit) {
            return trim(mb_substr($string, 0, $limit - 3, 'UTF-8')) . '...';
        }

        return $string;
    }

    /**
     * Format bytes to human-readable format.
     *
     * @param int $bytes    Size in bytes.
     * @param int $decimals The number of decimals include to output. Set to 1 by default.
     *
     * @return string
     */
    public static function bytes(int $bytes, int $decimals = 1): string
    {
        $pows = ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
        for ($unit = 0; $bytes > 1024; $unit++) {
            $bytes /= 1024;
        }

        return number_format($bytes, $unit ? $decimals : 0) . " " . $pows[$unit];
    }

    /**
     * Normalize string endings to avoid EOL problem. Replace \n\r and multiply new lines with
     * single \n.
     *
     * @param string $string       String to be normalized.
     * @param bool   $joinMultiple Join multiple new lines into one.
     *
     * @return string
     */
    public static function normalizeEndings(string $string, bool $joinMultiple = true): string
    {
        if (!$joinMultiple) {
            return str_replace("\r\n", "\n", $string);
        }

        return preg_replace('/[\n\r]+/', "\n", $string);
    }

    /**
     * Shift all string lines to have minimum indent size set to 0.
     *
     * Example:
     * |-a
     * |--b
     * |--c
     * |---d
     *
     * Output:
     * |a
     * |-b
     * |-c
     * |--d
     *
     * @param string $string         Input string with multiple lines.
     * @param string $tabulationCost How to treat \t symbols relatively to spaces. By default, this
     *                               is set to 4 spaces.
     *
     * @return string
     */
    public static function normalizeIndents(string $string, string $tabulationCost = "   "): string
    {
        $string = self::normalizeEndings($string, false);
        $lines = explode("\n", $string);

        $minIndent = null;
        foreach ($lines as $line) {
            if (!trim($line)) {
                continue;
            }

            $line = str_replace("\t", $tabulationCost, $line);

            //Getting indent size
            if (!preg_match("/^( +)/", $line, $matches)) {
                //Some line has no indent
                return $string;
            }

            if ($minIndent === null) {
                $minIndent = strlen($matches[1]);
            }

            $minIndent = min($minIndent, strlen($matches[1]));
        }

        //Fixing indent
        foreach ($lines as &$line) {
            if (empty($line)) {
                continue;
            }

            //Getting line indent
            preg_match("/^([ \t]+)/", $line, $matches);
            $indent = $matches[1];

            if (!trim($line)) {
                $line = '';
                continue;
            }

            //Getting new indent
            $useIndent = str_repeat(
                " ",
                strlen(str_replace("\t", $tabulationCost, $indent)) - $minIndent
            );

            $line = $useIndent . substr($line, strlen($indent));
            unset($line);
        }

        return join("\n", $lines);
    }
}