Bavix\Helpers\Str

Complexity

Total Complexity

38

Size/Duplication

Total Lines	441
Duplicated Lines	0 %

Test Coverage

Coverage

92.08%

Importance

Changes

0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	split()	0	3	1
A	shuffle()	0	3	1
A	last()	0	3	1
A	first()	0	3	1
A	low()	0	3	1
A	len()	0	3	1
A	pos()	0	3	1
A	repeat()	0	3	1
A	uniqid()	0	3	1
A	withoutLast()	0	3	1
A	capitalize()	0	3	1
A	toNumber()	0	3	1
A	upp()	0	3	1
A	withoutFirst()	0	3	1
A	_upperCase()	0	3	1
A	sub()	0	3	1
A	translit()	0	5	1
A	camelCase()	0	14	2
A	snakeCase()	0	5	1
A	rand()	0	13	2
A	shorten()	0	15	2
A	random()	0	20	4
A	ucFirst()	0	6	1
A	fileSize()	0	23	5
A	lcFirst()	0	6	1
A	friendlyUrl()	0	19	3

<?php

namespace Bavix\Helpers;

use Bavix\Exceptions;

class Str
{

    const SNAKE_CASE = 1;
    const CAMEL_CASE = 2;

    const DIGITS        = '0123456789';
    const ALPHABET_LOW  = 'abcdefghijklmnopqrstuvwxyz';
    const ALPHABET_HIGH = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
    const ALPHABET      = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';

    const RAND_ALPHA_LOW  = 1;
    const RAND_ALPHA_HIGH = 2;
    const RAND_ALPHA      = 4;
    const RAND_DIGITS     = 8;
    const RAND_ALL        = 16;

    /**
     * @var array
     */
    protected static $dictionary = [
        4 => self::ALPHABET . self::DIGITS,
        3 => self::DIGITS,
        2 => self::ALPHABET,
        1 => self::ALPHABET_HIGH,
        0 => self::ALPHABET_LOW,
    ];

    /**
     * @param string $str
     * @param int    $length
     *
     * @return array
     */
    public static function split($str, $length = 1)
    {
        return \str_split($str, $length);
    }

    /**
     * Shortens text to length and keeps integrity of words
     *
     * @param  string  $str
     * @param  integer $length
     * @param  string  $end
     *
     * @return string
     */
    public static function shorten($str, $length = 100, $end = '&#8230;')
    {
        $data = $str;

        if (strlen($data) > $length)
        {
            $data = trim($data);
            $data = \substr($data, 0, $length);
            $rev  = \strrev($data);
            $pos  = \strpos($rev, ' ');
            $data = \substr($data, 0, -$pos);
            $data .= trim($end);
        }

        return $data;
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function ucFirst($string)
    {
        $ucFirst = static::sub($string, 0, 1);
        $ucFirst = static::upp($ucFirst);

        return $ucFirst . static::sub($string, 1);
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function lcFirst($string)
    {
        $lcFirst = static::sub($string, 0, 1);
        $lcFirst = static::low($lcFirst);

        return $lcFirst . static::sub($string, 1);
    }

    /**
     * Return random string
     *
     * @param  int $length
     * @param  int $type
     *
     * @return string
     *
     * @throws \InvalidArgumentException
     */
    public static function random($length = 32, $type = self::RAND_ALL)
    {
        $string = '';
        // todo: make to helper?
        foreach (static::$dictionary as $pos => $item)
        {
            $key = (1 << $pos);
            if ($type >= $key)
            {
                $string .= $item;
                $type   -= $key;
            }
        }

        if (empty($string))
        {
            throw new Exceptions\Blank("Invalid random string type [{$type}].");
        }

        return static::rand($string, $length);
    }

    /**
     * @param string $chars
     * @param int    $length
     *
     * @return string
     */
    protected static function rand($chars, $length)
    {
        $string = '';
        $max    = static::len($chars) - 1;
        $i      = 0;

        while ($i < $length)
        {
            $string .= $chars[Num::randomInt(0, $max)];
            $i++;
        }

        return $string;
    }

    /**
     * @return string
     */
    public static function uniqid()
    {
        return \uniqid(Num::randomInt(), true);
    }

    /**
     * @param int $size
     * @param int $decimals
     *
     * @return string
     */
    public static function fileSize($size, $decimals = 2)
    {
        $units = [
            'B', 'KB', 'MB',
            'GB', 'TB', 'PB',
            'EB', 'ZB', 'YB'
        ];

        if ($size < 0)
        {
            throw new Exceptions\Invalid('Undefined size!');
        }

        $log     = \log($size, 1024);
        $power   = \min(\floor($log), \count($units));
        $postfix = $units[$power > 0 ? $power : 0];

        while ($power > 0 && $power--)
        {
            $size /= 1024;
        }

        return Num::format($size, $decimals) . ' ' . $postfix;
    }

    /**
     * transliteration cyr->lat
     *
     * @param $string
     *
     * @return string
     */
    public static function translit($string)
    {
        $string = \strtr($string, static::$trans);

        return \iconv(\mb_internal_encoding(), 'ASCII//TRANSLIT', $string);
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function first($string)
    {
        return static::sub($string, 0, 1);
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function withoutFirst($string)
    {
        return static::sub($string, 1);
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function last($string)
    {
        return static::sub($string, -1, 1);
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function withoutLast($string)
    {
        return static::sub($string, 1, -1);
    }

    /**
     * @param string $string
     * @param int    $start
     * @param int    $length
     *
     * @return string
     */
    public static function sub($string, $start, $length = null)
    {
        return \mb_substr($string, $start, $length);
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function upp($string)
    {
        return \mb_convert_case($string, MB_CASE_UPPER);
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function low($string)
    {
        return \mb_convert_case($string, MB_CASE_LOWER);
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function capitalize($string)
    {
        return \mb_convert_case($string, MB_CASE_TITLE);
    }

    /**
     * @param $string string
     * @param $char   string
     *
     * @return string
     */
    public static function snakeCase($string, $char = '_')
    {
        $data = \preg_replace('~([a-zа-яё])([A-ZА-ЯЁ])~u', '\\1' . $char . '\\2', $string);

        return static::low($data);
    }

    /**
     * @param array $input
     *
     * @return string
     */
    final protected static function _upperCase(array $input)
    {
        return static::upp(\end($input));
    }

    /**
     * @param string $string
     * @param string $char
     * @param bool   $lcFirst
     *
     * @return mixed
     */
    public static function camelCase($string, $char = '_', $lcFirst = false)
    {
        $data = \preg_replace_callback(
            '~' . $char . '([a-zа-яё])~u',
            [static::class, '_upperCase'],
            $string
        );

        if ($lcFirst)
        {
            return static::lcFirst($data);
        }

        return $data;
    }

    /**
     * @param string $string
     * @param bool   $translit
     * @param int    $case
     *
     * @return string
     */
    public static function friendlyUrl($string, $translit = true, $case = self::SNAKE_CASE)
    {
        $data = static::low($string);

        if ($translit)
        {
            $data = static::translit($data);
        }

        $data = \preg_replace('~[^a-zа-яё0-9]+~u', '-', $data);

        if ($case !== self::SNAKE_CASE)
        {
            $data = static::camelCase($data, '-');
        }

        $data = \preg_replace('~-{2,}~', '-', $data);

        return \trim($data, '-');
    }

    /**
     * @param string $string
     *
     * @return string mixed
     */
    public static function toNumber($string)
    {
        return \preg_replace('/\D/', '', $string);
    }

    /**
     * @param string $string
     * @param string $needle
     * @param int    $offset
     *
     * @return int
     */
    public static function pos($string, $needle, $offset = null)
    {
        return \mb_strpos($string, $needle, $offset);
    }

    /**
     * @param string $string
     * @param int    $multiplier
     *
     * @return string
     */
    public static function repeat($string, $multiplier)
    {
        return \str_repeat($string, $multiplier);
    }

    /**
     * @param string $string
     *
     * @return string
     */
    public static function shuffle($string)
    {
        return static::rand($string, static::len($string));
    }

    /**
     * @param string $string
     *
     * @return int
     */
    public static function len($string)
    {
        return \mb_strlen($string);
    }

    protected static $trans = [
        'á' => 'a', 'Á' => 'A', 'à' => 'a', 'À' => 'A', 'ă' => 'a', 'Ă' => 'A', 'â' => 'a', 'Â' => 'A',
        'å' => 'a', 'Å' => 'A', 'ã' => 'a', 'Ã' => 'A', 'ą' => 'a', 'Ą' => 'A', 'ā' => 'a', 'Ā' => 'A',
        'ä' => 'ae', 'Ä' => 'AE', 'æ' => 'ae', 'Æ' => 'AE', 'ḃ' => 'b', 'Ḃ' => 'B', 'ć' => 'c', 'Ć' => 'C',
        'ĉ' => 'c', 'Ĉ' => 'C', 'č' => 'c', 'Č' => 'C', 'ċ' => 'c', 'Ċ' => 'C', 'ç' => 'c', 'Ç' => 'C',
        'ď' => 'd', 'Ď' => 'D', 'ḋ' => 'd', 'Ḋ' => 'D', 'đ' => 'd', 'Đ' => 'D', 'ð' => 'dh', 'Ð' => 'Dh',
        'é' => 'e', 'É' => 'E', 'è' => 'e', 'È' => 'E', 'ĕ' => 'e', 'Ĕ' => 'E', 'ê' => 'e', 'Ê' => 'E',
        'ě' => 'e', 'Ě' => 'E', 'ë' => 'e', 'Ë' => 'E', 'ė' => 'e', 'Ė' => 'E', 'ę' => 'e', 'Ę' => 'E',
        'ē' => 'e', 'Ē' => 'E', 'ḟ' => 'f', 'Ḟ' => 'F', 'ƒ' => 'f', 'Ƒ' => 'F', 'ğ' => 'g', 'Ğ' => 'G',
        'ĝ' => 'g', 'Ĝ' => 'G', 'ġ' => 'g', 'Ġ' => 'G', 'ģ' => 'g', 'Ģ' => 'G', 'ĥ' => 'h', 'Ĥ' => 'H',
        'ħ' => 'h', 'Ħ' => 'H', 'í' => 'i', 'Í' => 'I', 'ì' => 'i', 'Ì' => 'I', 'î' => 'i', 'Î' => 'I',
        'ï' => 'i', 'Ï' => 'I', 'ĩ' => 'i', 'Ĩ' => 'I', 'į' => 'i', 'Į' => 'I', 'ī' => 'i', 'Ī' => 'I',
        'ĵ' => 'j', 'Ĵ' => 'J', 'ķ' => 'k', 'Ķ' => 'K', 'ĺ' => 'l', 'Ĺ' => 'L', 'ľ' => 'l', 'Ľ' => 'L',
        'ļ' => 'l', 'Ļ' => 'L', 'ł' => 'l', 'Ł' => 'L', 'ṁ' => 'm', 'Ṁ' => 'M', 'ń' => 'n', 'Ń' => 'N',
        'ň' => 'n', 'Ň' => 'N', 'ñ' => 'n', 'Ñ' => 'N', 'ņ' => 'n', 'Ņ' => 'N', 'ó' => 'o', 'Ó' => 'O',
        'ò' => 'o', 'Ò' => 'O', 'ô' => 'o', 'Ô' => 'O', 'ő' => 'o', 'Ő' => 'O', 'õ' => 'o', 'Õ' => 'O',
        'ø' => 'oe', 'Ø' => 'OE', 'ō' => 'o', 'Ō' => 'O', 'ơ' => 'o', 'Ơ' => 'O', 'ö' => 'oe', 'Ö' => 'OE',
        'ṗ' => 'p', 'Ṗ' => 'P', 'ŕ' => 'r', 'Ŕ' => 'R', 'ř' => 'r', 'Ř' => 'R', 'ŗ' => 'r', 'Ŗ' => 'R',
        'ś' => 's', 'Ś' => 'S', 'ŝ' => 's', 'Ŝ' => 'S', 'š' => 's', 'Š' => 'S', 'ṡ' => 's', 'Ṡ' => 'S',
        'ş' => 's', 'Ş' => 'S', 'ș' => 's', 'Ș' => 'S', 'ß' => 'SS', 'ť' => 't', 'Ť' => 'T', 'ṫ' => 't',
        'Ṫ' => 'T', 'ţ' => 't', 'Ţ' => 'T', 'ț' => 't', 'Ț' => 'T', 'ŧ' => 't', 'Ŧ' => 'T', 'ú' => 'u',
        'Ú' => 'U', 'ù' => 'u', 'Ù' => 'U', 'ŭ' => 'u', 'Ŭ' => 'U', 'û' => 'u', 'Û' => 'U', 'ů' => 'u',
        'Ů' => 'U', 'ű' => 'u', 'Ű' => 'U', 'ũ' => 'u', 'Ũ' => 'U', 'ų' => 'u', 'Ų' => 'U', 'ū' => 'u',
        'Ū' => 'U', 'ư' => 'u', 'Ư' => 'U', 'ü' => 'ue', 'Ü' => 'UE', 'ẃ' => 'w', 'Ẃ' => 'W', 'ẁ' => 'w',
        'Ẁ' => 'W', 'ŵ' => 'w', 'Ŵ' => 'W', 'ẅ' => 'w', 'Ẅ' => 'W', 'ý' => 'y', 'Ý' => 'Y', 'ỳ' => 'y',
        'Ỳ' => 'Y', 'ŷ' => 'y', 'Ŷ' => 'Y', 'ÿ' => 'y', 'Ÿ' => 'Y', 'ź' => 'z', 'Ź' => 'Z', 'ž' => 'z',
        'Ž' => 'Z', 'ż' => 'z', 'Ż' => 'Z', 'þ' => 'th', 'Þ' => 'Th', 'µ' => 'u', 'а' => 'a', 'А' => 'A',
        'б' => 'b', 'Б' => 'B', 'в' => 'v', 'В' => 'V', 'г' => 'g', 'Г' => 'G', 'д' => 'd', 'Д' => 'D',
        'е' => 'e', 'Е' => 'E', 'ё' => 'e', 'Ё' => 'E', 'ж' => 'zh', 'Ж' => 'Zh', 'з' => 'z', 'З' => 'Z',
        'и' => 'i', 'И' => 'I', 'й' => 'j', 'Й' => 'J', 'к' => 'k', 'К' => 'K', 'л' => 'l', 'Л' => 'L',
        'м' => 'm', 'М' => 'M', 'н' => 'n', 'Н' => 'N', 'о' => 'o', 'О' => 'O', 'п' => 'p', 'П' => 'P',
        'р' => 'r', 'Р' => 'R', 'с' => 's', 'С' => 'S', 'т' => 't', 'Т' => 'T', 'у' => 'u', 'У' => 'U',
        'ф' => 'f', 'Ф' => 'F', 'х' => 'h', 'Х' => 'H', 'ц' => 'c', 'Ц' => 'C', 'ч' => 'ch', 'Ч' => 'Ch',
        'ш' => 'sh', 'Ш' => 'Sh', 'щ' => 'sch', 'Щ' => 'Sch', 'ъ' => '', 'Ъ' => '', 'ы' => 'y', 'Ы' => 'Y',
        'ь' => '', 'Ь' => '', 'э' => 'e', 'Э' => 'E', 'ю' => 'ju', 'Ю' => 'Ju', 'я' => 'ja', 'Я' => 'Ja'
    ];

}