oxfunctions.php File Reference

Functions
	isAdmin ()
	warningHandler ($iErrorNr, $sErrorText)
	dumpVar ($mVar, $blToFile=false)
	debug ($mVar)
	cmpart ($a, $b)
	oxNew ($className)
	getDb ($blAssoc=true)
	getStr ()
	ox_get_template ($sTplName, &$sTplSource, $oSmarty)
	ox_get_timestamp ($sTplName, &$iTplTimestamp, $oSmarty)
	ox_get_secure ($sTplName, $oSmarty)
	ox_get_trusted ($sTplName, $oSmarty)

Function Documentation

cmpart()

cmpart	(		$a,
			$b
	)

Sorting for crossselling

Parameters

object	$a	first compare item
object	$b	second compre item

Deprecated:

since v6.0.0 (2016-05-16); Moved as anonymous function to Article class.

Returns

integer

debug()

debug

(

$mVar

)

prints anything given into a file, for debugging

Parameters

mixed

$mVar

variable to debug

dumpVar()

dumpVar	(		$mVar,
			$blToFile = false
	)

Dumps $mVar information to vardump.txt file. Used in debugging.

Parameters

mixed	$mVar	variable
bool	$blToFile	marker to write log info to file (must be true to log)

getDb()

getDb

(

$blAssoc = true

)

Returns current DB handler

Parameters

bool

$blAssoc

data fetch mode

Deprecated:

since v6.0.0 (2016-05-16); Use \OxidEsales\Eshop\Core\DatabaseProvidergetDb().

Returns

oxDb

getStr()

getStr

(

)

Returns string handler

Deprecated:

since v6.0.0 (2016-05-16); Use \OxidEsales\Eshop\Core\StrgetStr().

Returns

oxStrRegular|oxStrMb

isAdmin()

isAdmin

(

)

Returns true in case framework is called from shop administrator environment.

Returns

bool

ox_get_secure()

ox_get_secure	(		$sTplName,
			$oSmarty
	)

Dummy function, required for smarty plugin registration.

See also

http://www.smarty.net/docsv2/en/template.resources.tpl

Parameters

string	$sTplName	not used here
object	$oSmarty	not used here

Returns

bool

ox_get_template()

ox_get_template	(		$sTplName,
		&	$sTplSource,
			$oSmarty
	)

Sets template content from cache. In demoshop enables security mode.

See also

http://www.smarty.net/docsv2/en/template.resources.tpl

Parameters

string	$sTplName	name of template
string	&$sTplSource	Template source
object	$oSmarty	not used here

Returns

bool

ox_get_timestamp()

ox_get_timestamp	(		$sTplName,
		&	$iTplTimestamp,
			$oSmarty
	)

Sets time for smarty templates recompilation. If oxidtimecache is set, smarty will cache templates for this period. Otherwise templates will always be compiled.

See also

http://www.smarty.net/docsv2/en/template.resources.tpl

Parameters

string	$sTplName	name of template
string	&$iTplTimestamp	template timestamp referense
object	$oSmarty	not used here

Returns

bool

ox_get_trusted()

ox_get_trusted	(		$sTplName,
			$oSmarty
	)

Dummy function, required for smarty plugin registration.

See also

http://www.smarty.net/docsv2/en/template.resources.tpl

Parameters

string	$sTplName	not used here
object	$oSmarty	not used here

oxNew()

oxNew

(

$className

)

Creates and returns new object. If creation is not available, dies and outputs error message.

Parameters

string	$className	Name of class
	mixed	...$args constructor arguments

Returns

object

warningHandler()

warningHandler	(		$iErrorNr,
			$sErrorText
	)

Displays 'nice' HTML formatted user error. Later this method is hooked as error handler by calling set_error_handler('warningHandler', E_USER_WARNING); #T2008-07-22 Not used yet

Parameters

int	$iErrorNr	error number
string	$sErrorText	error message