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)
	string2Float ($sValue)
	isSearchEngine ($sClient=null)
	setSearchEngine ($blIsSe=null, $sClient=null)
	isValidEmail ($sEmail)
	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, $iTtl=0)
	fromFileCache ($sKey)
	commitFileCache ()
	oxResetFileCache ()
	resetTemplateCache ($aTemplates)
	resetLanguageCache ()
	resetMenuCache ()
	getRemoteCachePath ($sRemote, $sLocal)
	canPreview ()
	getPreviewId ()
	checkAccessRights ()
	seoIsActive ($blReset=false, $sShopId=null, $iActLang=null)
	isValidAlpha ($sField)
	redirectOffline ($iHeaderCode=302)
	redirect ($sUrl, $blAddRedirectParam=true, $iHeaderCode=302)
	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)
	_preparePrice ($dPrice, $dVat)
	_stripQuotes ($mInput)
Protected Attributes
	$_iCurPrecision = null
	$_sPermanentCachePattern = "/c_fieldnames_|c_tbdsc_|_allfields_/"
	$_sLanguageCachePattern = "/c_langcache_/i"
	$_sMenuCachePattern = "/c_menu_/i"
	$_aLockedFileHandles = array()
	$_aFileCacheContents = array()
	$_blIsSe = null
	$_aStaticCache
	$_blSeoIsActive = null

---

Detailed Description

Includes Smarty engine class. General utils class

Definition at line 12 of file oxutils.php.

---

Member Function Documentation

oxUtils._addUrlParameters	(	$	sUrl,
		$	aParams
	)			[protected]

adds the given parameters 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 1163 of file oxutils.php.

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

Fill array.

Parameters:

	array	$aName Initial array of strings
	float	$dVat Article VAT

Returns:

string

Definition at line 1185 of file oxutils.php.

oxUtils._includeFile

(

$

sFilePath

)

[protected]

Includes cache file

Parameters:

string

$sFilePath cache file path

Returns:

mixed

Definition at line 606 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 676 of file oxutils.php.

oxUtils._preparePrice	(	$	dPrice,
		$	dVat
	)			[protected]

Prepares price depending what options are used(show as net, brutto, etc.) for displaying

Parameters:

	$dPrice
	$dVat

Returns:

float

Definition at line 1248 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 621 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 593 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 731 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 1051 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 1323 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
	float	$dVat Article VAT (optional)

Returns:

array

Definition at line 171 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 193 of file oxutils.php.

oxUtils.canPreview

(

)

Checks if preview mode is ON

Returns:

bool

Definition at line 892 of file oxutils.php.

oxUtils.checkAccessRights

(

)

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

Returns:

bool

Definition at line 925 of file oxutils.php.

oxUtils.checkUrlEndingSlash

(

$

sUrl

)

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

Parameters:

string

$sUrl url string

Returns:

string

Definition at line 1405 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 447 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 cleaned up after commit

Returns:

null;

Definition at line 642 of file oxutils.php.

oxUtils.currency2Float

(

$

sValue

)

Returns formatted currency string, according to formatting standards.

Parameters:

string

$sValue Formatted price

Returns:

float

Definition at line 213 of file oxutils.php.

oxUtils.extractDomain

(

$

sHost

)

Extracts domain name from given host

Parameters:

string

$sHost host name

Returns:

string

Definition at line 1471 of file oxutils.php.

oxUtils.fromFileCache

(

$

sKey

)

Fetches contents from file cache.

Parameters:

string

$sKey Cache key

Returns:

mixed

Definition at line 550 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 485 of file oxutils.php.

oxUtils.fromStaticCache

(

$

sName

)

Retrieves something from static cache

Parameters:

string

$sName name under which the content is stored in the static cache

Returns:

mixed

Definition at line 432 of file oxutils.php.

oxUtils.fRound	(	$	sVal,
		$	oCur = null
	)

Rounds the value to currency cents. This method does NOT format the number.

Parameters:

	string	$sVal the value that should be rounded
	object	$oCur Currency Object

Returns:

float

Definition at line 374 of file oxutils.php.

oxUtils.getArrFldName

(

$

sName

)

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

Parameters:

string

$sName String to search replaceable char

Returns:

string

Definition at line 158 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 1352 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 499 of file oxutils.php.

static oxUtils.getInstance

(

)

[static]

Return a single instance of this class

Deprecated:

since v5.0 (2012-08-10); Use oxRegistry.getUtils() instead.

Returns:

oxUtils

Definition at line 72 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 1373 of file oxutils.php.

oxUtils.getPreviewId

(

)

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

Returns:

string

Definition at line 912 of file oxutils.php.

oxUtils.getRemoteCachePath	(	$	sRemote,
		$	sLocal
	)

If $sLocal file is older than 24h or does not exist, tries to download it from $sRemote and save it as $sLocal

Parameters:

	string	$sRemote the file
	string	$sLocal the address of the remote source

Returns:

mixed

Definition at line 841 of file oxutils.php.

oxUtils.handlePageNotFoundError

(

$

sUrl = ''

)

handler for 404 (page not found) error

Parameters:

string

$sUrl url which was given, can be not specified in some cases

Returns:

void

Definition at line 1442 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 262 of file oxutils.php.

oxUtils.isValidAlpha

(

$

sField

)

Checks if string is only alpha numeric symbols

Parameters:

string

$sField field name to test

Returns:

bool

Definition at line 1037 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 320 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 338 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 1303 of file oxutils.php.

oxUtils.oxMimeContentType

(

$

sFileName

)

returns manually set mime types

Parameters:

string

$sFileName the file

Returns:

string

Definition at line 1269 of file oxutils.php.

oxUtils.oxResetFileCache

(

)

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

Returns:

null

Definition at line 753 of file oxutils.php.

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

redirect user to the specified URL

Parameters:

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

Returns:

null or exit

Definition at line 1080 of file oxutils.php.

oxUtils.redirectOffline

(

$

iHeaderCode = 302

)

Redirects to shop offline page

Parameters:

int

$iHeaderCode header code, default 302

Definition at line 1065 of file oxutils.php.

oxUtils.resetLanguageCache

(

)

Removes language constant cache

Returns:

null

Definition at line 801 of file oxutils.php.

oxUtils.resetMenuCache

(

)

Removes admin menu cache

Returns:

null

Definition at line 819 of file oxutils.php.

oxUtils.resetTemplateCache

(

$

aTemplates

)

Removes smarty template cache for given templates

Parameters:

array

$aTemplates Template name array

Returns:

null

Definition at line 772 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 1006 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 512 of file oxutils.php.

oxUtils.setHeader

(

$

sHeader

)

set header sent to browser

Parameters:

string

$sHeader header to sent

Returns:

null

Definition at line 1150 of file oxutils.php.

oxUtils.setLangCache	(	$	sCacheName,
		$	aLangCache
	)

Writes language array to file cache

Parameters:

	string	$sCacheName name of cache file
	array	$aLangCache language array

Returns:

null

Definition at line 1391 of file oxutils.php.

oxUtils.setSearchEngine	(	$	blIsSe = null,
		$	sClient = null
	)

Sets if current web client is Search Engine.

Parameters:

	bool	$blIsSe sets if Search Engine is on
	string	$sClient user browser agent

Returns:

null

Definition at line 278 of file oxutils.php.

oxUtils.showMessageAndExit

(

$

sMsg

)

shows given message and quits message might be whole content like 404 page.

Parameters:

string

$sMsg message to show

Returns:

null dies

Definition at line 1130 of file oxutils.php.

oxUtils.string2Float

(

$

sValue

)

Returns formatted float, according to formatting standards.

Parameters:

string

$sValue Formatted price

Returns:

float

Definition at line 235 of file oxutils.php.

oxUtils.stripGpcMagicQuotes

(

)

Strips magic quotes

Returns:

null

Definition at line 96 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 115 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 137 of file oxutils.php.

oxUtils.strRot13

(

$

sStr

)

Applies ROT13 encoding to $sStr

Parameters:

string

$sStr to encoding string

Returns:

string

Definition at line 1335 of file oxutils.php.

oxUtils.toFileCache	(	$	sKey,
		$	mContents,
		$	iTtl = 0
	)

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
	int	$iTtl Time to live in seconds (0 for forever).

Returns:

bool

Definition at line 528 of file oxutils.php.

oxUtils.toPhpFileCache	(	$	sKey,
		$	mContents
	)

Generates php file, which could later be loaded as include instead of parsed data. Currently 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 465 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 415 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 1422 of file oxutils.php.

---

Member Data Documentation

oxUtils.$_aFileCacheContents = array() [protected]

Definition at line 56 of file oxutils.php.

oxUtils.$_aLockedFileHandles = array() [protected]

Definition at line 49 of file oxutils.php.

oxUtils.$_aStaticCache [protected]

Definition at line 82 of file oxutils.php.

oxUtils.$_blIsSe = null [protected]

Definition at line 63 of file oxutils.php.

oxUtils.$_blSeoIsActive = null [protected]

Definition at line 89 of file oxutils.php.

oxUtils.$_iCurPrecision = null [protected]

Definition at line 19 of file oxutils.php.

oxUtils.$_sLanguageCachePattern = "/c_langcache_/i" [protected]

Definition at line 35 of file oxutils.php.

oxUtils.$_sMenuCachePattern = "/c_menu_/i" [protected]

Definition at line 42 of file oxutils.php.

oxUtils.$_sPermanentCachePattern = "/c_fieldnames_|c_tbdsc_|_allfields_/" [protected]

Definition at line 28 of file oxutils.php.

---

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

• core/oxutils.php