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 ($sPattern, $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=array(), $aUmlEntities=array())
	hasSpecialChars ($sStr)
	cleanStr ($sStr, $sCleanChr= ' ')
	jsonEncode ($data)
	strip_tags ($sString, $sAllowableTags= '')
	strrcmp ($sStr1, $sStr2)
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 35 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 317 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 303 of file oxstrregular.php.

oxStrRegular.html_entity_decode	(	$	sString,
		$	iQuotStyle = `ENT_QUOTES`
	)

PHP html_entity_decode() function wrapper

Parameters:

	string	$sString string being converted
	int	$iQuotStyle quoting rule

Returns:: string

Definition at line 163 of file oxstrregular.php.

oxStrRegular.htmlentities	(	$	sString,
		$	iQuotStyle = `ENT_QUOTES`
	)

PHP htmlentities() function wrapper

Parameters:

	string	$sString string being converted
	int	$iQuotStyle quoting rule

Returns:: string

Definition at line 150 of file oxstrregular.php.

oxStrRegular.htmlspecialchars	(	$	sString,
		$	iQuotStyle = `ENT_QUOTES`
	)

PHP htmlspecialchars() function wrapper

Parameters:

	string	$sString string being converted
	int	$iQuotStyle quoting rule

Returns:: string

Definition at line 137 of file oxstrregular.php.

oxStrRegular.jsonEncode ( $ data )

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

Parameters:

mixed

$data data to encode

Returns:: string

Definition at line 329 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 226 of file oxstrregular.php.

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

PHP preg_match_all() 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 242 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 194 of file oxstrregular.php.

oxStrRegular.preg_replace_callback	(	$	pattern,
		$	callback,
		$	subject,
		$	limit = `-1`,
		&$	count = `null`
	)

PHP preg_replace() function wrapper

Parameters:

	mixed	$pattern pattern to search for, as a string
	callable	$callback Callback function
	string	$subject strings to search and replace
	int	$limit maximum possible replacements
	int	$count number of replacements done

Returns:: string

Definition at line 210 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 178 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 288 of file oxstrregular.php.

oxStrRegular.strip_tags	(	$	sString,
		$	sAllowableTags = `''`
	)

PHP strip_tags() function wrapper.

Parameters:

	string	$sString the input string
	string	$sAllowableTags an optional parameter to specify tags which should not be stripped

Returns:: string

Definition at line 366 of file oxstrregular.php.

oxStrRegular.strlen ( $ sStr )

PHP strlen() function wrapper

Parameters:

string

$sStr string to measure its length

Returns:: int

Definition at line 46 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 78 of file oxstrregular.php.

oxStrRegular.strrcmp	(	$	sStr1,
		$	sStr2
	)

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

Parameters:

	string	$sStr1 String to compare
	string	$sStr2 String to compare

Returns:: int > 0 if str1 is less than str2; < 0 if str1 is greater than str2, and 0 if they are equal.

Definition at line 385 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 100 of file oxstrregular.php.

oxStrRegular.strtolower ( $ sString )

PHP multi byte compliant strtolower() function wrapper

Parameters:

string

$sString string being lower cased

Returns:: string

Definition at line 112 of file oxstrregular.php.

oxStrRegular.strtoupper ( $ sString )

PHP strtolower() function wrapper

Parameters:

string

$sString string being lower cased

Returns:: string

Definition at line 124 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 60 of file oxstrregular.php.

oxStrRegular.ucfirst ( $ sSubject )

PHP ucfirst() function wrapper

Parameters:

string

$sSubject input string

Returns:: string

Definition at line 254 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 271 of file oxstrregular.php.

Member Data Documentation

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

Definition at line 28 of file oxstrregular.php.

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

Definition at line 21 of file oxstrregular.php.

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

Definition at line 14 of file oxstrregular.php.

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

core/oxstrregular.php

oxStrRegular Class Reference

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation