oxUtils Class Reference

Inheritance diagram for oxUtils:

Inheritance graph
[legend]
Collaboration diagram for oxUtils:

Collaboration graph
[legend]

List of all members.


Detailed Description

Includes Smarty engine class. general utils class, used as a singelton

Public Member Functions

 stripGpcMagicQuotes ()
 strMan ($sVal, $sKey=null)
 strRem ($sVal, $sKey=null)
 getArrFldName ($sName)
 assignValuesFromText ($sIn, $dVat=null)
 assignValuesToText ($aIn)
 formatCurrency ($dValue, $oActCur=null)
 currency2Float ($sValue)
 isSearchEngine ($sClient=null)
 isValidEmail ($sEmail)
 rebuildCache ()
 loadAdminProfile ($aInterfaceProfiles)
 fRound ($sVal, $oCur=null)
 toStaticCache ($sName, $sContent, $sKey=null)
 fromStaticCache ($sName)
 cleanStaticCache ($sCacheName=null)
 toFileCache ($sKey, $sContents)
 fromFileCache ($sKey)
 oxResetFileCache ()
 getRemoteCachePath ($sRemote, $sLocal)
 checkAccessRights ()
 seoIsActive ($blReset=false, $sShopId=null, $iActLang=null)
 getShopBit ($iShopId)
 bitwiseAnd ($iVal1, $iVal2)
 bitwiseOr ($iVal1, $iVal2)
 isValidAlpha ($sField)
 redirect ($sUrl, $blAddRedirectParam=true)
 showMessageAndExit ($sMsg)
 oxMimeContentType ($sFileName)
 logger ($sText, $blNewline=false)
 strRot13 ($sStr)
 prepareUrlForNoSession ($sUrl)

Static Public Member Functions

static getInstance ()

Protected Member Functions

 _oxFileCache ($blMode, $sName, $sInput=null)
 _simpleRedirect ($sUrl, $sHeaderCode)
 _addUrlParameters ($sUrl, $aParams)
 _fillExplodeArray ($aName, $dVat=null)
 _stripQuotes ($mInput)

Protected Attributes

 $_iCurPrecision = null
 $_sEmailTpl = "^([-!#\$%&'*+./0-9=?A-Z^_`a-z{|}~\177])+@([-!#\$%&'*+/0-9=?A-Z^_`a-z{|}~\177]+\\.)+[a-zA-Z]{2,6}\$"
 $_aStaticCache
 $_blSeoIsActive = null

Static Private Attributes

static $_instance = null

Member Function Documentation

static oxUtils.getInstance (  )  [static]

resturns a single instance of this class

Returns:
oxUtils

oxUtils.stripGpcMagicQuotes (  ) 

Strips magic quotes

Returns:
null

oxUtils.strMan ( sVal,
sKey = null 
)

OXID specific string manipulation method

Parameters:
string $sVal string
string $sKey key
Returns:
string

oxUtils.strRem ( sVal,
sKey = null 
)

OXID specific string manipulation method

Parameters:
string $sVal string
string $sKey key
Returns:
string

oxUtils.getArrFldName ( sName  ) 

Returns string witch "." symbols were replaced with "__".

Parameters:
string $sName String to search replaceble char
Returns:
string

oxUtils.assignValuesFromText ( sIn,
dVat = null 
)

Takes a string and assign all values, returns array with values.

Parameters:
string $sIn Initial string
double $dVat Article VAT (optional)
Returns:
array

oxUtils.assignValuesToText ( aIn  ) 

Takes an array and builds again a string. Returns string with values.

Parameters:
array $aIn Initial array of strings
Returns:
string

oxUtils.formatCurrency ( dValue,
oActCur = null 
)

Returns formatted currency string, according to formatting standards.

Parameters:
double $dValue Plain price
object $oActCur Object of active currency
Returns:
string

oxUtils.currency2Float ( sValue  ) 

Returns formatted currency string, according to formatting standards.

Parameters:
string $sValue Formatted price
Returns:
string

oxUtils.isSearchEngine ( sClient = null  ) 

Checks if current web client is Search Engine. Returns true on success.

Parameters:
string $sClient user browser agent
Returns:
bool

oxUtils.isValidEmail ( sEmail  ) 

User email validation function. Returns true if email is OK otherwise - false; Syntax validation is performed only.

Parameters:
string $sEmail user email
Returns:
bool

oxUtils.rebuildCache (  ) 

Clears Smarty cache data.

Returns:
null

oxUtils.loadAdminProfile ( aInterfaceProfiles  ) 

Parses profile configuration, loads stored info in cookie

Parameters:
array $aInterfaceProfiles ($myConfig->getConfigParam( 'aInterfaceProfiles' ))
Returns:
null

oxUtils.fRound ( sVal,
oCur = null 
)

Rounds the value to currency cents

Parameters:
string $sVal the value that should be rounded
object $oCur Currenncy Object
Returns:
float

oxUtils.toStaticCache ( sName,
sContent,
sKey = null 
)

Stores something into static cache to avoid double loading

Parameters:
string $sName name of the content
mixed $sContent the content
string $sKey optional key, where to store the content
Returns:
null

oxUtils.fromStaticCache ( sName  ) 

Retrieves something from static cache

Parameters:
string $sName name under which the content is stored in the satic cache
Returns:
mixed

oxUtils.cleanStaticCache ( sCacheName = null  ) 

Cleans all or specific data from static cache

Parameters:
string $sCacheName Cache name

oxUtils._oxFileCache ( blMode,
sName,
sInput = null 
) [protected]

Reads or write to filecache

Parameters:
boolean $blMode true == write, false == read
string $sName key under which the input should be stored
string $sInput the content which should be stored in file cache
Returns:
string

oxUtils.toFileCache ( sKey,
sContents 
)

Stores contents to file cache by given key.

Parameters:
string $sKey Cache key
mixed $sContents Contents to cache
Returns:
mixed

oxUtils.fromFileCache ( sKey  ) 

Fetches contents from file cache.

Parameters:
string $sKey Cache key
Returns:
mixed

oxUtils.oxResetFileCache (  ) 

Resets oxFileCache and deletes all cache files

Returns:
null

oxUtils.getRemoteCachePath ( sRemote,
sLocal 
)

If $sLocal file is older than 24h or doesn't exist, trys to download it from $sRemote and save it as $sLocal

Parameters:
string $sRemote the file
string $sLocal the adress of the remote source
Returns:
mixed

oxUtils.checkAccessRights (  ) 

This function checks if logged in user has access to admin or not

Returns:
bool

oxUtils.seoIsActive ( blReset = false,
sShopId = null,
iActLang = null 
)

Checks if Seo mode should be used

Parameters:
bool $blReset used to reset cached SEO mode
string $sShopId shop id (optional; if not passed active session shop id will be used)
int $iActLang language id (optional; if not passed active session language will be used)
Returns:
bool

oxUtils.getShopBit ( iShopId  ) 

Returns integer number with bit set according to $iShopId. The acttion performed could be represented as pow(2, $iShopId - 1) We use mySQL to calculate that, as currently php int size is only 32 bit.

Parameters:
int $iShopId current shop id
Returns:
int

oxUtils.bitwiseAnd ( iVal1,
iVal2 
)

Binary AND implementation. We use mySQL to calculate that, as currently php int size is only 32 bit.

Parameters:
int $iVal1 value nr 1
int $iVal2 value nr 2
Returns:
int

oxUtils.bitwiseOr ( iVal1,
iVal2 
)

Binary OR implementation. We use mySQL to calculate that, as currently php integer size is only 32 bit.

Parameters:
int $iVal1 value nr 1
int $iVal2 value nr 2
Returns:
int

oxUtils.isValidAlpha ( sField  ) 

Checks if string is only alpha numeric symbols

Parameters:
string $sField fieldname to test
Returns:
bool

oxUtils._simpleRedirect ( sUrl,
sHeaderCode 
) [protected]

redirects browser to given url, nothing else done just header send may be used for redirection in case of an exception or similar things

Parameters:
string $sUrl code to add to the header(e.g. "HTTP/1.1 301 Moved Permanently", or "HTTP/1.1 500 Internal Server Error"
string $sHeaderCode the URL to redirect to
Returns:
null

oxUtils.redirect ( sUrl,
blAddRedirectParam = true 
)

redirect user to the specified URL

Parameters:
string $sUrl URL to be redirected
Returns:
null or exit

oxUtils.showMessageAndExit ( sMsg  ) 

shows given message and quits

Parameters:
string $sMsg message to show
Returns:
null dies

oxUtils._addUrlParameters ( sUrl,
aParams 
) [protected]

adds the given paramters at the end of the given url

Parameters:
string $sUrl a url
array $aParams the params which will be added
Returns:
string

oxUtils._fillExplodeArray ( aName,
dVat = null 
) [protected]

Fill array.

Parameters:
array $aName Initial array of strings
double $dVat Article VAT
Returns:
string

oxUtils.oxMimeContentType ( sFileName  ) 

returns manually set mime types

Parameters:
string $sFileName the file
Returns:
string

oxUtils.logger ( sText,
blNewline = false 
)

Processes logging.

Parameters:
string $sText Log message text
bool $blNewline If true, writes message to new line (default false)
Returns:
null

oxUtils._stripQuotes ( mInput  )  [protected]

Recursively removes slashes from arrays

Parameters:
mixed $mInput the input from which the slashes should be removed
Returns:
mixed

oxUtils.strRot13 ( sStr  ) 

Applies ROT13 encoding to $sStr

Parameters:
string $sStr to encoding string
Returns:
string

oxUtils.prepareUrlForNoSession ( sUrl  ) 

prepareUrlForNoSession adds extra url params making it usable without session also removes sid=xxxx&

Parameters:
string $sUrl public
Returns:
string


Member Data Documentation

oxUtils.$_instance = null [static, private]

oxUtils.$_iCurPrecision = null [protected]

oxUtils.$_sEmailTpl = "^([-!#\$%&'*+./0-9=?A-Z^_`a-z{|}~\177])+@([-!#\$%&'*+/0-9=?A-Z^_`a-z{|}~\177]+\\.)+[a-zA-Z]{2,6}\$" [protected]

oxUtils.$_aStaticCache [protected]

oxUtils.$_blSeoIsActive = null [protected]


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

Generated on Wed Oct 29 23:46:24 2008 for OXID eShop CE by  doxygen 1.5.5