Mage_Core_Helper_String Class Reference

Inheritance diagram for Mage_Core_Helper_String:

List of all members.

Public Member Functions
	truncate ($string, $length=80, $etc= '...', &$remainder= '', $breakWords=true)
	strlen ($str)
	substr ($str, $offset, $length=null)
	splitInjection ($str, $length=50, $needle= '-', $insert= ' ')
	strrev ($str)
	str_split ($str, $length=1, $keepWords=false, $trim=false, $wordSeparatorRegex= '\s')
	splitWords ($str, $uniqueOnly=false, $maxWordLenght=0, $wordSeparatorRegexp= '\s')
Public Attributes
const	ICONV_CHARSET = 'UTF-8'

---

Detailed Description

Core data helper

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 32 of file String.php.

---

Member Function Documentation

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 109 of file String.php.

    {
        $str = $this->str_split($str, $length);
        $newStr = '';
        foreach ($str as $part) {
            if ($this->strlen($part) >= $length) {
                $lastDelimetr = iconv_strpos(strrev($part), $needle, null, self::ICONV_CHARSET);
                $tmpNewStr = '';
                $tmpNewStr = $this->substr(strrev($part), 0, $lastDelimetr) . $insert . $this->substr(strrev($part), $lastDelimetr);
                $newStr .= strrev($tmpNewStr);
            } else {
                $newStr .= $part;
            }
        }
        return $newStr;
    }

splitWords	(	$	str,
		$	uniqueOnly = false,
		$	maxWordLenght = 0,
		$	wordSeparatorRegexp = '\s'
	)

Split words

Parameters:

	string	$str The source string
	bool	$uniqueOnly Unique words only
	int	$maxWordLenght Limit words count
	string	$wordSeparatorRegexp

Returns:

array

Definition at line 240 of file String.php.

    {
        $result = array();
        $split = preg_split('#' . $wordSeparatorRegexp . '#si', $str, null, PREG_SPLIT_NO_EMPTY);
        foreach ($split as $key => $word) {
            if ($uniqueOnly) {
                $result[$word] = $word;
            }
            else {
                $result[] = $word;
            }
        }
        if ($maxWordLenght && count($result) > $maxWordLenght) {
            $result = array_slice($result, 0, $maxWordLenght);
        }
        return $result;
    }

str_split	(	$	str,
		$	length = 1,
		$	keepWords = false,
		$	trim = false,
		$	wordSeparatorRegex = '\s'
	)

Binary-safe variant of str_split() + 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	$str
	int	$length
	bool	$keepWords
	bool	$trim
	string	$wordSeparatorRegex

Returns:

array

Definition at line 158 of file String.php.

    {
        $result = array();
        $strlen = $this->strlen($str);
        if ((!$strlen) || (!is_int($length)) || ($length <= 0)) {
            return $result;
        }
        // trim
        if ($trim) {
            $str = trim(preg_replace('/\s{2,}/is', ' ', $str));
        }
        // do a usual str_split, but safe for our encoding
        if ((!$keepWords) || ($length < 2)) {
            for ($offset = 0; $offset < $strlen; $offset += $length) {
                $result[] = iconv_substr($str, $offset, $length, self::ICONV_CHARSET);
            }
        }
        // split smartly, keeping words
        else {
            $split = preg_split('/(' . $wordSeparatorRegex . '+)/is', $str, null, PREG_SPLIT_DELIM_CAPTURE);
            $i        = 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[$i])) {
                    $currentLength = 0;
                    $result[$i]    = '';
                    $space         = '';
                    $spaceLen      = 0;
                }
                else {
                    $currentLength = iconv_strlen($result[$i], self::ICONV_CHARSET);
                }
                $partLength = iconv_strlen($part, self::ICONV_CHARSET);
                // add part to current last element
                if (($currentLength + $spaceLen + $partLength) <= $length) {
                    $result[$i] .= $space . $part;
                }
                // add part to new element
                elseif ($partLength <= $length) {
                    $i++;
                    $result[$i] = $part;
                }
                // break too long part recursively
                else {
                    foreach ($this->str_split($part, $length, false, $trim, $wordSeparatorRegex) as $subpart) {
                        $i++;
                        $result[$i] = $subpart;
                    }
                }
            }
        }
        // remove last element, if empty
        if ($count = count($result)) {
            if (empty($result[$count - 1])) {
                unset($result[$count - 1]);
            }
        }
        // remove first element, if empty
        if (isset($result[0]) && empty($result[0])) {
            array_shift($result);
        }
        return $result;
    }

strlen

(

$

str

)

Passthrough to iconv_strlen()

Parameters:

string

$str

Returns:

int

Definition at line 79 of file String.php.

    {
        return iconv_strlen($str, self::ICONV_CHARSET);
    }

strrev

(

$

str

)

Binary-safe strrev()

Parameters:

string

$str

Returns:

string

Definition at line 132 of file String.php.

    {
        $result = '';
        $strlen = $this->strlen($str);
        if (!$strlen) {
            return $result;
        }
        for ($i = $strlen-1; $i >= 0; $i--) {
            $result .= iconv_substr($str, $i, 1, self::ICONV_CHARSET);
        }
        return $result;
    }

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

Passthrough to iconv_substr()

Parameters:

	string	$str
	int	$offset
	int	$length

Returns:

string

Definition at line 92 of file String.php.

    {
        if (is_null($length)) {
            $length = iconv_strlen($str, self::ICONV_CHARSET) - $offset;
        }
        return iconv_substr($str, $offset, $length, self::ICONV_CHARSET);
    }

truncate	(	$	string,
		$	length = 80,
		$	etc = '...',
		&$	remainder = '',
		$	breakWords = true
	)

Truncate a string to a certain length if necessary, appending the $etc string. $remainder will contain the string that has been replaced with $etc.

Parameters:

	string	$string
	int	$length
	string	$etc
	string	&$remainder
	bool	$breakWords

Returns:

string

Definition at line 47 of file String.php.

    {
        $remainder = '';
        if (0 == $length) {
            return '';
        }

        $originalLength = iconv_strlen($string, self::ICONV_CHARSET);
        if ($originalLength > $length) {
            $length -= iconv_strlen($etc, self::ICONV_CHARSET);
            if ($length <= 0) {
                return '';
            }
            $preparedString = $string;
            $preparedlength = $length;
            if (!$breakWords) {
                $preparedString = preg_replace('/\s+?(\S+)?$/', '', iconv_substr($string, 0, $length + 1, self::ICONV_CHARSET));
                $preparedlength = iconv_strlen($preparedString, self::ICONV_CHARSET);
            }
            $remainder = iconv_substr($string, $preparedlength, $originalLength, self::ICONV_CHARSET);
            return iconv_substr($preparedString, 0, $length, self::ICONV_CHARSET) . $etc;
        }

        return $string;
    }

---

Member Data Documentation

const ICONV_CHARSET = 'UTF-8'

Definition at line 34 of file String.php.

---

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

• app/code/core/Mage/Core/Helper/String.php