OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Core\StrMb Class Reference

Public Member Functions

 __construct ()
 
 strlen ($sStr)
 
 substr ($sStr, $iStart, $iLength=null)
 
 strpos ($sHaystack, $sNeedle, $iOffset=null)
 
 strstr ($sHaystack, $sNeedle)
 
 strtolower ($sString)
 
 strtoupper ($sString)
 
 htmlspecialchars ($sString, $iQuotStyle=ENT_QUOTES)
 
 htmlentities ($sString, $iQuotStyle=ENT_QUOTES)
 
 html_entity_decode ($sString, $iQuotStyle=ENT_QUOTES)
 
 preg_split ($sPattern, $sString, $iLimit=-1, $iFlag=0)
 
 preg_replace ($aPattern, $sString, $sSubject, $iLimit=-1, $iCount=null)
 
 preg_replace_callback ($pattern, $callback, $subject, $limit=-1, &$count=null)
 
 preg_match ($sPattern, $sSubject, &$aMatches=null, $iFlags=null, $iOffset=null)
 
 preg_match_all ($sPattern, $sSubject, &$aMatches=null, $iFlags=null, $iOffset=null)
 
 ucfirst ($sSubject)
 
 wordwrap ($sString, $iLength=75, $sBreak="\n", $blCut=null)
 
 recodeEntities ($sInput, $blToHtmlEntities=false, $aUmls=[], $aUmlEntities=[])
 
 hasSpecialChars ($sStr)
 
 cleanStr ($sStr, $sCleanChr=' ')
 
 jsonEncode ($data)
 
 strip_tags ($sString, $sAllowableTags='')
 
 strrcmp ($sStr1, $sStr2)
 

Protected Attributes

 $_sEncoding = 'UTF-8'
 
 $_aUmls = ["\xc3\xa4", "\xc3\xb6", "\xc3\xbc", "\xC3\x84", "\xC3\x96", "\xC3\x9C", "\xC3\x9F"]
 
 $_aUmlEntities = ['ä', 'ö', 'ü', 'Ä', 'Ö', 'Ü', 'ß']
 

Detailed Description

Class dealing with multibyte strings

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Core\StrMb::__construct ( )

Class constructor. The constructor is defined in order to be possible to call parent::__construct() in modules.

Member Function Documentation

◆ cleanStr()

OxidEsales\EshopCommunity\Core\StrMb::cleanStr (   $sStr,
  $sCleanChr = ' ' 
)

Replaces special characters with passed char. Special chars are:
\r \t \xc2\x95 \xc2\xa0 ;

Parameters
string$sStrstring to cleanup
string$sCleanChrwhich character should be used as a replacement (default is empty space)
Returns
string

◆ hasSpecialChars()

OxidEsales\EshopCommunity\Core\StrMb::hasSpecialChars (   $sStr)

Checks if string has special chars

Parameters
string$sStrstring to search in
Returns
bool

◆ html_entity_decode()

OxidEsales\EshopCommunity\Core\StrMb::html_entity_decode (   $sString,
  $iQuotStyle = ENT_QUOTES 
)

PHP html_entity_decode() function wrapper

Parameters
string$sStringstring being converted
int$iQuotStylequoting rule
Returns
string

◆ htmlentities()

OxidEsales\EshopCommunity\Core\StrMb::htmlentities (   $sString,
  $iQuotStyle = ENT_QUOTES 
)

PHP htmlentities() function wrapper

Parameters
string$sStringstring being converted
int$iQuotStylequoting rule
Returns
string

◆ htmlspecialchars()

OxidEsales\EshopCommunity\Core\StrMb::htmlspecialchars (   $sString,
  $iQuotStyle = ENT_QUOTES 
)

PHP htmlspecialchars() function wrapper

Parameters
string$sStringstring being converted
int$iQuotStylequoting rule
Returns
string

◆ jsonEncode()

OxidEsales\EshopCommunity\Core\StrMb::jsonEncode (   $data)

wrapper for json encode, which does not work with non utf8 characters

Parameters
mixed$datadata to encode
Returns
string

◆ preg_match()

OxidEsales\EshopCommunity\Core\StrMb::preg_match (   $sPattern,
  $sSubject,
$aMatches = null,
  $iFlags = null,
  $iOffset = null 
)

PHP preg_match() function wrapper

Parameters
string$sPatternpattern to search for, as a string
string$sSubjectinput string
array$aMatchesis filled with the results of search
int$iFlagsflags
int$iOffsetplace from which to start the search
Returns
string

◆ preg_match_all()

OxidEsales\EshopCommunity\Core\StrMb::preg_match_all (   $sPattern,
  $sSubject,
$aMatches = null,
  $iFlags = null,
  $iOffset = null 
)

PHP preg_match_all() function wrapper

Parameters
string$sPatternpattern to search for, as a string
string$sSubjectinput string
array$aMatchesis filled with the results of search
int$iFlagsflags
int$iOffsetplace from which to start the search
Returns
string

◆ preg_replace()

OxidEsales\EshopCommunity\Core\StrMb::preg_replace (   $aPattern,
  $sString,
  $sSubject,
  $iLimit = -1,
  $iCount = null 
)

PHP preg_replace() function wrapper

Parameters
mixed$aPatternpattern to search for, as a string
mixed$sStringstring to replace
string$sSubjectstrings to search and replace
int$iLimitmaximum possible replacements
int$iCountnumber of replacements done
Returns
string

◆ preg_replace_callback()

OxidEsales\EshopCommunity\Core\StrMb::preg_replace_callback (   $pattern,
  $callback,
  $subject,
  $limit = -1,
$count = null 
)

PHP preg_replace() function wrapper

Parameters
mixed$patternpattern to search for, as a string
callable$callbackCallback function
string$subjectstrings to search and replace
int$limitmaximum possible replacements
int$countnumber of replacements done
Returns
string

◆ preg_split()

OxidEsales\EshopCommunity\Core\StrMb::preg_split (   $sPattern,
  $sString,
  $iLimit = -1,
  $iFlag = 0 
)

PHP preg_split() function wrapper

Parameters
string$sPatternpattern to search for, as a string
string$sStringinput string
int$iLimit(optional) only sub strings up to limit are returned
int$iFlagflags
Returns
string

◆ recodeEntities()

OxidEsales\EshopCommunity\Core\StrMb::recodeEntities (   $sInput,
  $blToHtmlEntities = false,
  $aUmls = [],
  $aUmlEntities = [] 
)

Recodes and returns passed input: if $blToHtmlEntities == true ä -> ä if $blToHtmlEntities == false ä -> ä

Parameters
string$sInputtext to recode
bool$blToHtmlEntitiesrecode direction
array$aUmlslanguage specific characters
array$aUmlEntitieslanguage specific characters equivalents in entities form
Returns
string

◆ strip_tags()

OxidEsales\EshopCommunity\Core\StrMb::strip_tags (   $sString,
  $sAllowableTags = '' 
)

PHP strip_tags() function wrapper.

Parameters
string$sStringthe input string
string$sAllowableTagsan optional parameter to specify tags which should not be stripped
Returns
string

◆ strlen()

OxidEsales\EshopCommunity\Core\StrMb::strlen (   $sStr)

PHP multi byte compliant strlen() function wrapper

Parameters
string$sStrstring to measure its length
Returns
int

◆ strpos()

OxidEsales\EshopCommunity\Core\StrMb::strpos (   $sHaystack,
  $sNeedle,
  $iOffset = null 
)

PHP multi byte compliant strpos() function wrapper

Parameters
string$sHaystackvalue to search in
string$sNeedlevalue to search for
int$iOffsetinitial search position
Returns
string

◆ strrcmp()

OxidEsales\EshopCommunity\Core\StrMb::strrcmp (   $sStr1,
  $sStr2 
)

Compares two strings. Case sensitive. For use in sorting with reverse order

Parameters
string$sStr1String to compare
string$sStr2String to compare
Returns
int > 0 if str1 is less than str2; < 0 if str1 is greater than str2, and 0 if they are equal.

◆ strstr()

OxidEsales\EshopCommunity\Core\StrMb::strstr (   $sHaystack,
  $sNeedle 
)

PHP multi byte compliant strstr() function wrapper

Parameters
string$sHaystackvalue to search in
string$sNeedlevalue to search for
Returns
string

◆ strtolower()

OxidEsales\EshopCommunity\Core\StrMb::strtolower (   $sString)

PHP multi byte compliant strtolower() function wrapper

Parameters
string$sStringstring being lower cased
Returns
string

◆ strtoupper()

OxidEsales\EshopCommunity\Core\StrMb::strtoupper (   $sString)

PHP multi byte compliant strtoupper() function wrapper

Parameters
string$sStringstring being lower cased
Returns
string

◆ substr()

OxidEsales\EshopCommunity\Core\StrMb::substr (   $sStr,
  $iStart,
  $iLength = null 
)

PHP multi byte compliant substr() function wrapper

Parameters
string$sStrvalue to truncate
int$iStartstart position
int$iLengthlength
Returns
string

◆ ucfirst()

OxidEsales\EshopCommunity\Core\StrMb::ucfirst (   $sSubject)

PHP ucfirst() function wrapper

Parameters
string$sSubjectinput string
Returns
string

◆ wordwrap()

OxidEsales\EshopCommunity\Core\StrMb::wordwrap (   $sString,
  $iLength = 75,
  $sBreak = "\n",
  $blCut = null 
)

PHP wordwrap() function wrapper

Parameters
string$sStringinput string
int$iLengthcolumn width
string$sBreakline is broken using the optional break parameter
bool$blCutstring is always wrapped at the specified width
Returns
string

Member Data Documentation

◆ $_aUmlEntities

OxidEsales\EshopCommunity\Core\StrMb::$_aUmlEntities = ['&auml;', '&ouml;', '&uuml;', '&Auml;', '&Ouml;', '&Uuml;', '&szlig;']
protected

◆ $_aUmls

OxidEsales\EshopCommunity\Core\StrMb::$_aUmls = ["\xc3\xa4", "\xc3\xb6", "\xc3\xbc", "\xC3\x84", "\xC3\x96", "\xC3\x9C", "\xC3\x9F"]
protected

◆ $_sEncoding

OxidEsales\EshopCommunity\Core\StrMb::$_sEncoding = 'UTF-8'
protected

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