StringUtils Class Reference

Public Member Functions
	upperCaseWords ($str, $sourceSeparator='_', $destinationSeparator='_')
	splitInjection ($str, $length=50, $needle='-', $insert=' ')
	split ($value, $length=1, $keepWords=false, $trim=false, $wordSeparatorRegex='\s')
	strlen ($string)
	cleanString ($string)
	substr ($string, $offset, $length=null)
	strrev ($str)
	strpos ($haystack, $needle, $offset=null)

Data Fields
const	ICONV_CHARSET = 'UTF-8'

Detailed Description

Magento methods to work with string

@api

Since

100.0.2

Definition at line 14 of file StringUtils.php.

Member Function Documentation

cleanString()

cleanString

(

$string

)

Clean non UTF-8 characters

Parameters

string

$string

Returns

string

Definition at line 161 of file StringUtils.php.

    {
        return mb_convert_encoding($string, self::ICONV_CHARSET);
    }

split()

split	(		$value,
			$length = 1,
			$keepWords = false,
			$trim = false,
			$wordSeparatorRegex = '\s'
	)

Binary-safe variant of strSplit()

• option not to break words
• option to trim spaces (between each word)
• option to set character(s) (pcre pattern) to be considered as words separator

Parameters

string	$value
int	$length
bool	$keepWords
bool	$trim
string	$wordSeparatorRegex

Returns

string[] @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 75 of file StringUtils.php.

    {
        $result = [];
        $strLen = $this->strlen($value);
        if (!$strLen || !is_int($length) || $length <= 0) {
            return $result;
        }
        if ($trim) {
            $value = trim(preg_replace('/\s{2,}/siu', ' ', $value));
        }
        // do a usual str_split, but safe for our encoding
        if (!$keepWords || $length < 2) {
            for ($offset = 0; $offset < $strLen; $offset += $length) {
                $result[] = $this->substr($value, $offset, $length);
            }
        } else {
            // split smartly, keeping words
            $split = preg_split('/(' . $wordSeparatorRegex . '+)/siu', $value, null, PREG_SPLIT_DELIM_CAPTURE);
            $index = 0;
            $space = '';
            $spaceLen = 0;
            foreach ($split as $key => $part) {
                if ($trim) {
                    // ignore spaces (even keys)
                    if ($key % 2) {
                        continue;
                    }
                    $space = ' ';
                    $spaceLen = 1;
                }
                if (empty($result[$index])) {
                    $currentLength = 0;
                    $result[$index] = '';
                    $space = '';
                    $spaceLen = 0;
                } else {
                    $currentLength = $this->strlen($result[$index]);
                }
                $partLength = $this->strlen($part);
                // add part to current last element
                if ($currentLength + $spaceLen + $partLength <= $length) {
                    $result[$index] .= $space . $part;
                } elseif ($partLength <= $length) {
                    // add part to new element
                    $index++;
                    $result[$index] = $part;
                } else {
                    // break too long part recursively
                    foreach ($this->split($part, $length, false, $trim, $wordSeparatorRegex) as $subPart) {
                        $index++;
                        $result[$index] = $subPart;
                    }
                }
            }
        }
        // remove last element, if empty
        $count = count($result);
        if ($count) {
            if ($result[$count - 1] === '') {
                unset($result[$count - 1]);
            }
        }
        // remove first element, if empty
        if (isset($result[0]) && $result[0] === '') {
            array_shift($result);
        }
        return $result;
    }

splitInjection()

splitInjection	(		$str,
			$length = 50,
			$needle = '-',
			$insert = ' '
	)

Split string and appending $insert string after $needle

Parameters

string	$str
integer	$length
string	$needle
string	$insert

Returns

string

Definition at line 43 of file StringUtils.php.

    {
        $str = $this->split($str, $length);
        $newStr = '';
        foreach ($str as $part) {
            if ($this->strlen($part) >= $length) {
                $lastDelimiter = $this->strpos($this->strrev($part), $needle);
                $tmpNewStr = $this->substr($this->strrev($part), 0, $lastDelimiter) . $insert
                    . $this->substr($this->strrev($part), $lastDelimiter);
                $newStr .= $this->strrev($tmpNewStr);
            } else {
                $newStr .= $part;
            }
        }
        return $newStr;
    }

strlen()

strlen

(

$string

)

Retrieve string length using default charset

Parameters

string

$string

Returns

int

Definition at line 150 of file StringUtils.php.

    {
        return mb_strlen($string, self::ICONV_CHARSET);
    }

strpos()

strpos	(		$haystack,
			$needle,
			$offset = null
	)

Find position of first occurrence of a string

Parameters

string	$haystack
string	$needle
int	$offset

Returns

int|bool

Definition at line 210 of file StringUtils.php.

    {
        return mb_strpos($haystack, $needle, $offset, self::ICONV_CHARSET);
    }

strrev()

strrev

(

$str

)

Binary-safe strrev()

Parameters

string

$str

Returns

string

Definition at line 189 of file StringUtils.php.

    {
        $result = '';
        $strLen = $this->strlen($str);
        if (!$strLen) {
            return $result;
        }
        for ($i = $strLen - 1; $i >= 0; $i--) {
            $result .= $this->substr($str, $i, 1);
        }
        return $result;
    }

substr()

substr	(		$string,
			$offset,
			$length = null
	)

Pass through to mb_substr()

Parameters

string	$string
int	$offset
int	$length

Returns

string

Definition at line 174 of file StringUtils.php.

    {
        $string = $this->cleanString($string);
        if ($length === null) {
            $length = $this->strlen($string) - $offset;
        }
        return mb_substr($string, $offset, $length, self::ICONV_CHARSET);
    }

upperCaseWords()

upperCaseWords	(		$str,
			$sourceSeparator = '_',
			$destinationSeparator = '_'
	)

Capitalize first letters and convert separators if needed

Parameters

string	$str
string	$sourceSeparator
string	$destinationSeparator

Returns

string

Definition at line 29 of file StringUtils.php.

    {
        return str_replace(' ', $destinationSeparator, ucwords(str_replace($sourceSeparator, ' ', $str)));
    }

Field Documentation

ICONV_CHARSET

const ICONV_CHARSET = 'UTF-8'

Default charset

Definition at line 19 of file StringUtils.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Stdlib/StringUtils.php