oxUtilsString Class Reference

Collaboration diagram for oxUtilsString:

Collaboration graph
[legend]

List of all members.


Detailed Description

String manipulation class

Definition at line 6 of file oxutilsstring.php.


Public Member Functions

 prepareCSVField ($sInField)
 minimizeTruncateString ($sString, $iLength)
 prepareStrForSearch ($sSearchStr)
 recodeEntities ($sInput, $blToHtmlEntities=false, $aUmls=array(), $aUmlEntities=array())

Static Public Member Functions

static getInstance ()

Protected Attributes

 $_aUmls = array( "\344", "\366", "\374", "\304", "\326", "\334", "\337" )
 $_aUmlEntities = array('ä', 'ö', 'ü', 'Ä', 'Ö', 'Ü', 'ß' )

Static Private Attributes

static $_instance = null

Member Function Documentation

static oxUtilsString.getInstance (  )  [static]

Returns string manipulation utility instance

Returns:
oxUtilsString

Definition at line 33 of file oxutilsstring.php.

oxUtilsString.prepareCSVField ( sInField  ) 

Prepares passed string for CSV format

Parameters:
string $sInField String to prepare
Returns:
string

Definition at line 61 of file oxutilsstring.php.

oxUtilsString.minimizeTruncateString ( sString,
iLength 
)

shortens a string to a size $iLenght, whereby "," and multiple spaces are removed "," is rerplaced with " " and leading and ending whitespaces are removed

Parameters:
string $sString input string
int $iLength maximum length of result string , -1 -> no truncation
Returns:
string a string of maximum length $iLength without multiple spaces and commas

Definition at line 80 of file oxutilsstring.php.

oxUtilsString.prepareStrForSearch ( sSearchStr  ) 

Prepares and returns string for search engines.

Parameters:
string $sSearchStr String to prepare for search engines
Returns:
string

Definition at line 100 of file oxutilsstring.php.

oxUtilsString.recodeEntities ( sInput,
blToHtmlEntities = false,
aUmls = array(),
aUmlEntities = array() 
)

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

Parameters:
string $sInput text to recode
bool $blToHtmlEntities recode direction
array $aUmls language specific characters
array $aUmlEntities language specific characters equivalents in entities form
Returns:
string

Definition at line 123 of file oxutilsstring.php.


Member Data Documentation

oxUtilsString.$_instance = null [static, private]

Definition at line 13 of file oxutilsstring.php.

oxUtilsString.$_aUmls = array( "\344", "\366", "\374", "\304", "\326", "\334", "\337" ) [protected]

Definition at line 20 of file oxutilsstring.php.

oxUtilsString.$_aUmlEntities = array('ä', 'ö', 'ü', 'Ä', 'Ö', 'Ü', 'ß' ) [protected]

Definition at line 26 of file oxutilsstring.php.


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

Generated on Thu Feb 19 15:09:47 2009 for OXID eShop CE by  doxygen 1.5.5