Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Attributes

oxUtils Class Reference

Inheritance diagram for oxUtils:
Collaboration diagram for oxUtils:

List of all members.

Public Member Functions

 stripGpcMagicQuotes ()
 strMan ($sVal, $sKey=null)
 strRem ($sVal, $sKey=null)
 getArrFldName ($sName)
 assignValuesFromText ($sIn, $dVat=null)
 assignValuesToText ($aIn)
 currency2Float ($sValue)
 isSearchEngine ($sClient=null)
 isValidEmail ($sEmail)
 rebuildCache ()
 loadAdminProfile ($aInterfaceProfiles)
 fRound ($sVal, $oCur=null)
 toStaticCache ($sName, $sContent, $sKey=null)
 fromStaticCache ($sName)
 cleanStaticCache ($sCacheName=null)
 toPhpFileCache ($sKey, $mContents)
 fromPhpFileCache ($sKey)
 getCacheMeta ($sKey)
 setCacheMeta ($sKey, $aMeta)
 toFileCache ($sKey, $mContents)
 fromFileCache ($sKey)
 commitFileCache ()
 oxResetFileCache ()
 getRemoteCachePath ($sRemote, $sLocal)
 canPreview ()
 getPreviewId ()
 checkAccessRights ()
 seoIsActive ($blReset=false, $sShopId=null, $iActLang=null)
 getShopBit ($iShopId)
 bitwiseAnd ($iVal1, $iVal2)
 bitwiseOr ($iVal1, $iVal2)
 isValidAlpha ($sField)
 redirect ($sUrl, $blAddRedirectParam=true, $iHeaderCode=301)
 showMessageAndExit ($sMsg)
 setHeader ($sHeader)
 oxMimeContentType ($sFileName)
 logger ($sText, $blNewline=false)
 strRot13 ($sStr)
 getCacheFilePath ($sCacheName, $blPathOnly=false, $sExtension= 'txt')
 getLangCache ($sCacheName)
 setLangCache ($sCacheName, $aLangCache)
 checkUrlEndingSlash ($sUrl)
 writeToLog ($sLogMessage, $sLogFileName)
 handlePageNotFoundError ($sUrl= '')
 extractDomain ($sHost)

Static Public Member Functions

static getInstance ()

Protected Member Functions

 _readFile ($sFilePath)
 _includeFile ($sFilePath)
 _processCache ($sKey, $mContents)
 _lockFile ($sFilePath, $sIdent, $iLockMode=LOCK_EX)
 _releaseFile ($sIdent, $iLockMode=LOCK_EX)
 _simpleRedirect ($sUrl, $sHeaderCode)
 _addUrlParameters ($sUrl, $aParams)
 _fillExplodeArray ($aName, $dVat=null)
 _stripQuotes ($mInput)

Protected Attributes

 $_iCurPrecision = null
 $_sPermanentCachePattern = "/c_fieldnames_/"
 $_aLockedFileHandles = array()
 $_aFileCacheContents = array()
 $_blIsSe = null
 $_aStaticCache
 $_blSeoIsActive = null

Static Private Attributes

static $_instance = null

Detailed Description

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

Definition at line 12 of file oxutils.php.

Member Function Documentation

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

Definition at line 1114 of file oxutils.php.

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

Fill array.

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

Definition at line 1136 of file oxutils.php.

oxUtils._includeFile ( $  sFilePath  )  [protected]

Includes cache file

Parameters:
string $sFilePath cache fiel path
Returns:
mixed

Definition at line 583 of file oxutils.php.

oxUtils._lockFile ( $  sFilePath,
$  sIdent,
$  iLockMode = LOCK_EX 
) [protected]

Locks cache file and returns its handle on success or false on failure

Parameters:
string $sFilePath name of file to lock
string $sIdent lock identifier
int $iLockMode lock mode - LOCK_EX/LOCK_SH
Returns:
mixed lock file resource or false on error

Definition at line 653 of file oxutils.php.

oxUtils._processCache ( $  sKey,
$  mContents 
) [protected]

Serializes or writes php array for class file cache

Parameters:
string $sKey cache key
mixed $mContents cache data
Returns:
mixed

Definition at line 598 of file oxutils.php.

oxUtils._readFile ( $  sFilePath  )  [protected]

Reads and returns cache file contents

Parameters:
string $sFilePath cache fiel path
Returns:
string

Definition at line 570 of file oxutils.php.

oxUtils._releaseFile ( $  sIdent,
$  iLockMode = LOCK_EX 
) [protected]

Releases file lock and returns release state

Parameters:
string $sIdent lock ident
int $iLockMode lock mode
Returns:
bool

Definition at line 708 of file oxutils.php.

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

Definition at line 1015 of file oxutils.php.

oxUtils._stripQuotes ( $  mInput  )  [protected]

Recursively removes slashes from arrays

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

Definition at line 1249 of file oxutils.php.

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

Definition at line 175 of file oxutils.php.

oxUtils.assignValuesToText ( $  aIn  ) 

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

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

Definition at line 197 of file oxutils.php.

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

Definition at line 967 of file oxutils.php.

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

Definition at line 985 of file oxutils.php.

oxUtils.canPreview (  ) 

Checks if preview mode is ON

Returns:
bool

Definition at line 802 of file oxutils.php.

oxUtils.checkAccessRights (  ) 

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

Returns:
bool

Definition at line 834 of file oxutils.php.

oxUtils.checkUrlEndingSlash ( $  sUrl  ) 

Cheks if url has ending slash / - if not, adds it

Parameters:
string $sUrl url string
Returns:
string

Definition at line 1333 of file oxutils.php.

oxUtils.cleanStaticCache ( $  sCacheName = null  ) 

Cleans all or specific data from static cache

Parameters:
string $sCacheName Cache name
Returns:
null

Definition at line 439 of file oxutils.php.

oxUtils.commitFileCache (  ) 

Writes all cache contents to file at once. This method was introduced due to possible race conditions. Cache is cleand up after commit

Returns:
null;

Definition at line 619 of file oxutils.php.

oxUtils.currency2Float ( $  sValue  ) 

Returns formatted currency string, according to formatting standards.

Parameters:
string $sValue Formatted price
Returns:
string

Definition at line 217 of file oxutils.php.

oxUtils.extractDomain ( $  sHost  ) 

Extracts domain name from given host

Parameters:
string $sHost host name
Returns:
string

Definition at line 1398 of file oxutils.php.

oxUtils.fromFileCache ( $  sKey  ) 

Fetches contents from file cache.

Parameters:
string $sKey Cache key
Returns:
mixed

Definition at line 536 of file oxutils.php.

oxUtils.fromPhpFileCache ( $  sKey  ) 

Includes cached php file and loads stored contents.

Parameters:
string $sKey Cache key.
Returns:
null;

Definition at line 477 of file oxutils.php.

oxUtils.fromStaticCache ( $  sName  ) 

Retrieves something from static cache

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

Definition at line 424 of file oxutils.php.

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

Definition at line 365 of file oxutils.php.

oxUtils.getArrFldName ( $  sName  ) 

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

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

Definition at line 162 of file oxutils.php.

oxUtils.getCacheFilePath ( $  sCacheName,
$  blPathOnly = false,
$  sExtension = 'txt' 
)

Returns full path (including file name) to cache file

Parameters:
string $sCacheName cache file name
bool $blPathOnly if TRUE, name parameter will be ignored and only cache folder will be returned (default FALSE)
string $sExtension cache file extension
Returns:
string

Definition at line 1278 of file oxutils.php.

oxUtils.getCacheMeta ( $  sKey  ) 

If available returns cache meta data array

Parameters:
string $sKey meta data/cache key
Returns:
mixed

Definition at line 491 of file oxutils.php.

static oxUtils.getInstance (  )  [static]

resturns a single instance of this class

Returns:
oxUtils

Definition at line 63 of file oxutils.php.

oxUtils.getLangCache ( $  sCacheName  ) 

Tries to load lang cache array from cache file

Parameters:
string $sCacheName cache file name
Returns:
array

Definition at line 1301 of file oxutils.php.

oxUtils.getPreviewId (  ) 

Returns id which is used for product preview in shop during administration

Returns:
string

Definition at line 821 of file oxutils.php.

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

Definition at line 751 of file oxutils.php.

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

Definition at line 948 of file oxutils.php.

oxUtils.handlePageNotFoundError ( $  sUrl = ''  ) 

handler for 404 (page not found) error

Parameters:
string $sUrl url wich was given, can be not specified in some cases
Returns:
void

Definition at line 1370 of file oxutils.php.

oxUtils.isSearchEngine ( $  sClient = null  ) 

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

Parameters:
string $sClient user browser agent
Returns:
bool

Definition at line 239 of file oxutils.php.

oxUtils.isValidAlpha ( $  sField  ) 

Checks if string is only alpha numeric symbols

Parameters:
string $sField fieldname to test
Returns:
bool

Definition at line 1001 of file oxutils.php.

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

Definition at line 291 of file oxutils.php.

oxUtils.loadAdminProfile ( $  aInterfaceProfiles  ) 

Parses profile configuration, loads stored info in cookie

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

Definition at line 328 of file oxutils.php.

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

Definition at line 1229 of file oxutils.php.

oxUtils.oxMimeContentType ( $  sFileName  ) 

returns manually set mime types

Parameters:
string $sFileName the file
Returns:
string

Definition at line 1195 of file oxutils.php.

oxUtils.oxResetFileCache (  ) 

Removes most files stored in cache (default 'tmp') folder. Some files e.g. table fiels names description, are left. Excluded cache file name patterns are defined in oxutils._sPermanentCachePattern parameter

Returns:
null

Definition at line 730 of file oxutils.php.

oxUtils.rebuildCache (  ) 

Clears Smarty cache data.

Deprecated:
since v4.5.9 (2012-03-06); Not needed from 3.0
Returns:
null

Definition at line 309 of file oxutils.php.

oxUtils.redirect ( $  sUrl,
$  blAddRedirectParam = true,
$  iHeaderCode = 301 
)

redirect user to the specified URL

Parameters:
string $sUrl URL to be redirected
bool $blAddRedirectParam add "redirect" param
int $iHeaderCode header code, default 301

change $iHeaderCode default value to 302, because ONLY if page was removed permanently 301 header must be send. On most redirects we only transfer to different page

Returns:
null or exit

Definition at line 1035 of file oxutils.php.

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

Definition at line 915 of file oxutils.php.

oxUtils.setCacheMeta ( $  sKey,
$  aMeta 
)

Saves cache meta data (information)

Parameters:
string $sKey meta data/cache key
array $aMeta meta data array
Returns:
null

Definition at line 504 of file oxutils.php.

oxUtils.setHeader ( $  sHeader  ) 

set header sent to browser

Parameters:
string $sHeader header to sent
Returns:
null

Definition at line 1101 of file oxutils.php.

oxUtils.setLangCache ( $  sCacheName,
$  aLangCache 
)

Writes languge array to file cache

Parameters:
string $sCacheName name of cache file
array $aLangCache language array
Returns:
null

Definition at line 1319 of file oxutils.php.

oxUtils.showMessageAndExit ( $  sMsg  ) 

shows given message and quits

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

Definition at line 1082 of file oxutils.php.

oxUtils.stripGpcMagicQuotes (  ) 

Strips magic quotes

Returns:
null

Definition at line 100 of file oxutils.php.

oxUtils.strMan ( $  sVal,
$  sKey = null 
)

OXID specific string manipulation method

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

Definition at line 119 of file oxutils.php.

oxUtils.strRem ( $  sVal,
$  sKey = null 
)

OXID specific string manipulation method

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

Definition at line 141 of file oxutils.php.

oxUtils.strRot13 ( $  sStr  ) 

Applies ROT13 encoding to $sStr

Parameters:
string $sStr to encoding string
Returns:
string

Definition at line 1261 of file oxutils.php.

oxUtils.toFileCache ( $  sKey,
$  mContents 
)

Adds contents to cache contents by given key. Returns true on success. All file caches are supposed to be written once by commitFileCache() method.

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

Definition at line 519 of file oxutils.php.

oxUtils.toPhpFileCache ( $  sKey,
$  mContents 
)

Generates php file, which could later be loaded as include instead of paresed data. Currenntly this method supports simple arrays only.

Parameters:
string $sKey Cache key
mixed $mContents Cache contents. At this moment only simple array type is supported.
Returns:
null;

Definition at line 457 of file oxutils.php.

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

Definition at line 407 of file oxutils.php.

oxUtils.writeToLog ( $  sLogMessage,
$  sLogFileName 
)

Writes given log message. Returns write state

Parameters:
string $sLogMessage log message
string $sLogFileName log file name
Returns:
bool

Definition at line 1350 of file oxutils.php.

Member Data Documentation

oxUtils.$_aFileCacheContents = array() [protected]

Definition at line 49 of file oxutils.php.

oxUtils.$_aLockedFileHandles = array() [protected]

Definition at line 42 of file oxutils.php.

oxUtils.$_aStaticCache [protected]

Definition at line 86 of file oxutils.php.

oxUtils.$_blIsSe = null [protected]

Definition at line 56 of file oxutils.php.

oxUtils.$_blSeoIsActive = null [protected]

Definition at line 93 of file oxutils.php.

oxUtils.$_iCurPrecision = null [protected]

Definition at line 26 of file oxutils.php.

oxUtils.$_instance = null [static, private]

Definition at line 19 of file oxutils.php.

oxUtils.$_sPermanentCachePattern = "/c_fieldnames_/" [protected]

Definition at line 35 of file oxutils.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1