oxfunctions.php File Reference


Functions

 __autoload ($sClass)
 warningHandler ($iErrorNr, $sErrorText)
 dumpVar ($mVar, $blToFile=false)
 cmpart ($a, $b)
 startProfile ($sProfileName)
 stopProfile ($sProfileName)
 oxNew ($sClassName, $sParams=null)
 oxNewArticle ($sArtId)
 ox_get_template ($sTplName, &$sTplSource, $oSmarty)
 ox_get_timestamp ($sTplName, &$iTplTimestamp, $oSmarty)
 ox_get_secure ($sTplName, $oSmarty)
 ox_get_trusted ($sTplName, $oSmarty)
 smarty_modifier_oxtruncate ($sString, $iLength=80, $sEtc= '...', $blBreakWords=false)

Variables

return $blAdmin
return false
 $sString = var_export( $mVar, true )
 $sRequest = preg_replace( '/((\&)?sid=[^&]*(&)?)/', '', $sRequest )


Function Documentation

__autoload ( sClass  ) 

Includes $sClass class file

Parameters:
string $sClass classname
Returns:
null

cmpart ( a,
b 
)

Sorting for crossselling

Parameters:
object $a first compare item
object $b second compre item
Returns:
integer

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)
Returns:
null

ox_get_secure ( sTplName,
oSmarty 
)

Assumes all templates are secure, returns true.

Parameters:
string $sTplName not used here
object $oSmarty not used here
Returns:
bool

ox_get_template ( sTplName,
&$  sTplSource,
oSmarty 
)

Sets template name to passed reference, returns true.

Parameters:
string $sTplName name of template
string &$sTplSource Template source
object $oSmarty not used here
Returns:
bool

ox_get_timestamp ( sTplName,
&$  iTplTimestamp,
oSmarty 
)

Sets timestamt to passed timestamp object, returns true.

Parameters:
string $sTplName name of template
string &$iTplTimestamp template timestamp referense
object $oSmarty not used here
Returns:
bool

ox_get_trusted ( sTplName,
oSmarty 
)

Does nothing.

Parameters:
string $sTplName not used here
object $oSmarty not used here
Returns:
null

oxNew ( sClassName,
sParams = null 
)

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

Parameters:
string $sClassName Name of class
string $sParams Parameters to object
Exceptions:
oxSystemComponentException in case that class does not exists
Returns:
object

oxNewArticle ( sArtId  ) 

Creates, loads returns oxarticle object

Parameters:
string $sArtId product id
Returns:
oxarticle

smarty_modifier_oxtruncate ( sString,
iLength = 80,
sEtc = '...',
blBreakWords = false 
)

This method replaces existing Smarty function for truncating strings (check Smarty documentation for details). When truncating strings additionally we need to convert '/" entities to '/" and after truncating convert them back.

Parameters:
string $sString string to process
int $iLength max string length
string $sEtc addon to truncated string (default '...')
bool $blBreakWords marker to break words
Returns:
string

startProfile ( sProfileName  ) 

Start profiling

Parameters:
string $sProfileName name of profile
Returns:
null

stopProfile ( sProfileName  ) 

Stop profiling

Parameters:
string $sProfileName name of profile
Returns:
null

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
string $sErrorText


Variable Documentation

return $blAdmin

$sRequest = preg_replace( '/((\&)?sid=[^&]*(&)?)/', '', $sRequest )

$sString = var_export( $mVar, true )

return false


Generated on Wed Oct 29 23:38:33 2008 for OXID eShop CE by  doxygen 1.5.5