Docs For Class Mage_Core_Helper

Description

Core data helper

author: Magento Core Team <[email protected]>

Located in /Core/Helper/String.php (line 32)

Mage_Core_Helper_Abstract
   |
   --Mage_Core_Helper_String

Class Constant Summary

ICONV_CHARSET = 'UTF-8'

Method Summary

string cleanString (string $string)

string splitInjection (string $str, [integer $length = 50], [string $needle = '-'], [string $insert = ' '])

array splitWords (string $str, [bool $uniqueOnly = false], [int $maxWordLength = 0], [string $wordSeparatorRegexp = '\s'])

int strlen (string $string)

int|false strpos (string $haystack, string $needle, [int $offset = null])

string strrev (string $str)

array str_split (string $str, [int $length = 1], [bool $keepWords = false], [bool $trim = false], [string $wordSeparatorRegex = '\s'])

string substr (string $string, int $offset, [int $length = null])

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

Variables

Inherited Variables

Inherited from Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::$_layout
Mage_Core_Helper_Abstract::$_moduleName
Mage_Core_Helper_Abstract::$_request

Methods

cleanString (line 265)

Clean non UTF-8 characters

access: public

string cleanString (string $string)

string $string

splitInjection (line 110)

Split string and appending $insert string after $needle

access: public

string splitInjection (string $str, [integer $length = 50], [string $needle = '-'], [string $insert = ' '])

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

splitWords (line 241)

Split words

array splitWords (string $str, [bool $uniqueOnly = false], [int $maxWordLength = 0], [string $wordSeparatorRegexp = '\s'])

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

strlen (line 79)

Retrieve string length using default charset

access: public

int strlen (string $string)

string $string

strpos (line 278)

Find position of first occurrence of a string

access: public

int|false strpos (string $haystack, string $needle, [int $offset = null])

string $haystack
string $needle
int $offset

strrev (line 133)

Binary-safe strrev()

access: public

string strrev (string $str)

string $str

str_split (line 159)

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

access: public

array str_split (string $str, [int $length = 1], [bool $keepWords = false], [bool $trim = false], [string $wordSeparatorRegex = '\s'])

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

substr (line 92)

Passthrough to iconv_substr()

access: public

string substr (string $string, int $offset, [int $length = null])

string $string
int $offset
int $length

truncate (line 47)

Truncate a string to a certain length if necessary, appending the $etc string.

$remainder will contain the string that has been replaced with $etc.

access: public

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

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

Inherited Methods

Inherited From Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::escapeHtml()
Mage_Core_Helper_Abstract::escapeUrl()
Mage_Core_Helper_Abstract::getLayout()
Mage_Core_Helper_Abstract::htmlEscape()
Mage_Core_Helper_Abstract::isModuleEnabled()
Mage_Core_Helper_Abstract::isModuleOutputEnabled()
Mage_Core_Helper_Abstract::jsQuoteEscape()
Mage_Core_Helper_Abstract::setLayout()
Mage_Core_Helper_Abstract::stripTags()
Mage_Core_Helper_Abstract::translateArray()
Mage_Core_Helper_Abstract::urlDecode()
Mage_Core_Helper_Abstract::urlEncode()
Mage_Core_Helper_Abstract::urlEscape()
Mage_Core_Helper_Abstract::_cleanCache()
Mage_Core_Helper_Abstract::_getModuleName()
Mage_Core_Helper_Abstract::_getRequest()
Mage_Core_Helper_Abstract::_getUrl()
Mage_Core_Helper_Abstract::_loadCache()
Mage_Core_Helper_Abstract::_removeCache()
Mage_Core_Helper_Abstract::_saveCache()
Mage_Core_Helper_Abstract::__()

Class Constants

ICONV_CHARSET = 'UTF-8' (line 34)

Class Mage_Core_Helper_String

Inherited Variables

Inherited Methods