Public Member Functions | Protected Attributes

oxStrRegular Class Reference

List of all members.

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)
 htmlentities ($sString)
 html_entity_decode ($sString)
 preg_split ($sPattern, $sString, $iLimit=-1, $iFlag=0)
 preg_replace ($sPattern, $sString, $sSubject, $iLimit=-1, $iCount=null)
 preg_match ($sPattern, $sSubject, &$aMatches=null, $iFlags=null, $iOffset=null)
 ucfirst ($sSubject)
 wordwrap ($sString, $iLength=75, $sBreak="\n", $blCut=null)
 recodeEntities ($sInput, $blToHtmlEntities=false, $aUmls=array(), $aUmlEntities=array())
 hasSpecialChars ($sStr)
 cleanStr ($sStr, $sCleanChr= ' ')

Protected Attributes

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

Detailed Description

Class dealing with regular string handling

Definition at line 6 of file oxstrregular.php.

Constructor & Destructor Documentation

oxStrRegular.__construct (  ) 

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

Returns:
null;

Definition at line 33 of file oxstrregular.php.

Member Function Documentation

oxStrRegular.cleanStr ( $  sStr,
$  sCleanChr = ' ' 
)

Replaces special characters with passed char. Special chars are: " ' : ! ?
x95 xa0 ;

Parameters:
string $sStr string to cleanup
object $sCleanChr which character should be used as a replacement (default is empty space)
Returns:
string

Definition at line 277 of file oxstrregular.php.

oxStrRegular.hasSpecialChars ( $  sStr  ) 

Checks if string has special chars

Parameters:
string $sStr string to search in
Returns:
bool

Definition at line 263 of file oxstrregular.php.

oxStrRegular.html_entity_decode ( $  sString  ) 

PHP html_entity_decode() function wrapper

Parameters:
string $sString string being converted
Returns:
string

Definition at line 157 of file oxstrregular.php.

oxStrRegular.htmlentities ( $  sString  ) 

PHP htmlentities() function wrapper

Parameters:
string $sString string being converted
Returns:
string

Definition at line 145 of file oxstrregular.php.

oxStrRegular.htmlspecialchars ( $  sString  ) 

PHP htmlspecialchars() function wrapper

Parameters:
string $sString string being converted
Returns:
string

Definition at line 133 of file oxstrregular.php.

oxStrRegular.preg_match ( $  sPattern,
$  sSubject,
&$  aMatches = null,
$  iFlags = null,
$  iOffset = null 
)

PHP preg_match() function wrapper

Parameters:
string $sPattern pattern to search for, as a string
string $sSubject input string
array &$aMatches is filled with the results of search
int $iFlags flags
int $iOffset place from which to start the search
Returns:
string

Definition at line 204 of file oxstrregular.php.

oxStrRegular.preg_replace ( $  sPattern,
$  sString,
$  sSubject,
$  iLimit = -1,
$  iCount = null 
)

PHP preg_replace() function wrapper

Parameters:
mixed $sPattern pattern to search for, as a string
mixed $sString string to replace
string $sSubject strings to search and replace
int $iLimit maximum possible replacements
int $iCount number of replacements done
Returns:
string

Definition at line 188 of file oxstrregular.php.

oxStrRegular.preg_split ( $  sPattern,
$  sString,
$  iLimit = -1,
$  iFlag = 0 
)

PHP preg_split() function wrapper

Parameters:
string $sPattern pattern to search for, as a string
string $sString input string
int $iLimit (optional) only substrings up to limit are returned
int $iFlag flags
Returns:
string

Definition at line 172 of file oxstrregular.php.

oxStrRegular.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 249 of file oxstrregular.php.

oxStrRegular.strlen ( $  sStr  ) 

PHP strlen() function wrapper

Parameters:
string $sStr strint to mesure its length
Returns:
int

Definition at line 44 of file oxstrregular.php.

oxStrRegular.strpos ( $  sHaystack,
$  sNeedle,
$  iOffset = null 
)

PHP strpos() function wrapper

Parameters:
string $sHaystack value to search in
string $sNeedle value to search for
int $iOffset initial search position
Returns:
string

Definition at line 76 of file oxstrregular.php.

oxStrRegular.strstr ( $  sHaystack,
$  sNeedle 
)

PHP strstr() function wrapper

Parameters:
string $sHaystack string searching in
string $sNeedle string to search
Returns:
mixed

Definition at line 97 of file oxstrregular.php.

oxStrRegular.strtolower ( $  sString  ) 

PHP multibute compliant strtolower() function wrapper

Parameters:
string $sString string being lowercased
Returns:
string

Definition at line 109 of file oxstrregular.php.

oxStrRegular.strtoupper ( $  sString  ) 

PHP strtolower() function wrapper

Parameters:
string $sString string being lowercased
Returns:
string

Definition at line 121 of file oxstrregular.php.

oxStrRegular.substr ( $  sStr,
$  iStart,
$  iLength = null 
)

PHP substr() function wrapper

Parameters:
string $sStr value to truncate
int $iStart start position
int $iLength length
Returns:
string

Definition at line 58 of file oxstrregular.php.

oxStrRegular.ucfirst ( $  sSubject  ) 

PHP ucfirst() function wrapper

Parameters:
string $sSubject input string
Returns:
string

Definition at line 216 of file oxstrregular.php.

oxStrRegular.wordwrap ( $  sString,
$  iLength = 75,
$  sBreak = "\n",
$  blCut = null 
)

PHP wordwrap() function wrapper

Parameters:
string $sString input string
int $iLength column width
string $sBreak line is broken using the optional break parameter
bool $blCut string is always wrapped at the specified width
Returns:
string

Definition at line 232 of file oxstrregular.php.

Member Data Documentation

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

Definition at line 26 of file oxstrregular.php.

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

Definition at line 20 of file oxstrregular.php.

oxStrRegular.$_sEncoding = 'ISO8859-15' [protected]

Definition at line 13 of file oxstrregular.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1