oxStrRegular Class Reference

List of all members.

---

Detailed Description

Class dealing with regular string handling

Definition at line 7 of file oxstrregular.php.

Public Member Functions
	strlen ($sStr)
	substr ($sStr, $iStart, $iLength=null)
	strpos ($sHaystack, $sNeedle, $iOffset=null)
	strstr ($sHaystack, $sNeedle)
	strtolower ($sString)
	strtoupper ($sString)
	htmlspecialchars ($sString, $blDoubleEncode=true)
	htmlentities ($sString)
	html_entity_decode ($sString)
	preg_split ($sPattern, $sString, $iLimit=-1, $iFlag=0)
	preg_replace ($sPattern, $sString, $sSubject, $sLimit=-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('ä', 'ö', 'ü', 'Ä', 'Ö', 'Ü', 'ß' )

---

Member Function Documentation

oxStrRegular.strlen

(

$

sStr

)

PHP strlen() function wrapper

Parameters:

string

$sStr

Returns:

int

Definition at line 36 of file oxstrregular.php.

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

PHP substr() function wrapper

Parameters:

	string	$sStr
	int	$iStart
	int	$iLength

Returns:

string

Definition at line 50 of file oxstrregular.php.

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

PHP strpos() function wrapper

Parameters:

	string	$sHaystack
	string	$sNeedle
	int	$sOffset

Returns:

string

Definition at line 68 of file oxstrregular.php.

oxStrRegular.strstr	(	$	sHaystack,
		$	sNeedle
	)

PHP strstr() function wrapper

Parameters:

	string	$sHaystack
	string	$sNeedle

Returns:

string

Definition at line 85 of file oxstrregular.php.

oxStrRegular.strtolower

(

$

sString

)

PHP multibute compliant strtolower() function wrapper

Parameters:

string

$sString string being lowercased

Returns:

string

Definition at line 97 of file oxstrregular.php.

oxStrRegular.strtoupper

(

$

sString

)

PHP strtolower() function wrapper

Parameters:

string

$sString string being lowercased

Returns:

string

Definition at line 109 of file oxstrregular.php.

oxStrRegular.htmlspecialchars	(	$	sString,
		$	blDoubleEncode = true
	)

PHP htmlspecialchars() function wrapper

Parameters:

	string	$sString string being converted
	bool	$blDoubleEncode When this is turned off PHP will not encode existing html entities, the default is to convert everything.

Returns:

string

Definition at line 122 of file oxstrregular.php.

oxStrRegular.htmlentities

(

$

sString

)

PHP htmlentities() function wrapper

Parameters:

string

$sString string being converted

Returns:

string

Definition at line 134 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 146 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 161 of file oxstrregular.php.

oxStrRegular.preg_replace	(	$	sPattern,
		$	sString,
		$	sSubject,
		$	sLimit = -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 177 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 193 of file oxstrregular.php.

oxStrRegular.ucfirst

(

$

sSubject

)

PHP ucfirst() function wrapper

Parameters:

string

$sSubject input string

Returns:

string

Definition at line 205 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 221 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 238 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 252 of file oxstrregular.php.

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

---

Member Data Documentation

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

Definition at line 14 of file oxstrregular.php.

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

Definition at line 21 of file oxstrregular.php.

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

Definition at line 27 of file oxstrregular.php.

---

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

• core/oxstrregular.php