oxUtils Class Reference

Inheritance diagram for oxUtils:

Collaboration diagram for oxUtils:

Public Member Functions
	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)
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	__construct ()
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

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)
	_isPriceViewModeNetto ()
	_getArticleUser ()

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

Additional Inherited Members
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = 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 1124 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 1146 of file oxutils.php.

oxUtils::_getArticleUser ( )

protected

Return article user.

Returns

oxUser

Definition at line 1247 of file oxutils.php.

oxUtils::_includeFile (   $sFilePath )

protected

Includes cache file

Parameters

string

$sFilePath

cache file path

Returns

mixed

Definition at line 576 of file oxutils.php.

oxUtils::_isPriceViewModeNetto ( )

protected

Checks and return true if price view mode is netto.

Returns

bool

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

oxUtils::_preparePrice (   $dPrice,   $dVat  )

protected

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

Parameters

double	$dPrice	Price
double	$dVat	VAT

Returns

float

Definition at line 1210 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 592 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 562 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 700 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	the URL to redirect to
string	$sHeaderCode	code to add to the header(e.g. "HTTP/1.1 301 Moved Permanently", or "HTTP/1.1 500 Internal Server Error"

Definition at line 1014 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 136 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 159 of file oxutils.php.

oxUtils::canPreview

(

)

Checks if preview mode is ON

Returns

bool

Definition at line 855 of file oxutils.php.

oxUtils::checkAccessRights

(

)

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

Returns

bool

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

oxUtils::cleanStaticCache

(

$sCacheName = null

)

Cleans all or specific data from static cache

Parameters

string

$sCacheName

Cache name

Definition at line 418 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

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

oxUtils::extractDomain

(

$sHost

)

Extracts domain name from given host

Parameters

string

$sHost

host name

Returns

string

Definition at line 1453 of file oxutils.php.

oxUtils::fromFileCache

(

$sKey

)

Fetches contents from file cache.

Parameters

string

$sKey

Cache key

Returns

mixed

Definition at line 519 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 454 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 404 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 347 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 123 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 1334 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 469 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 1355 of file oxutils.php.

oxUtils::getPreviewId

(

)

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

Returns

string

Definition at line 876 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 803 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

Definition at line 1424 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 233 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 1002 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

Deprecated:

since v4.9.0/v5.2.0 (2014-06-17); Use MailValidator::isValidEmail().

Returns

bool

Definition at line 295 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 309 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)

Definition at line 1296 of file oxutils.php.

oxUtils::oxMimeContentType

(

$sFileName

)

returns manually set mime types

Parameters

string

$sFileName

the file

Returns

string

Definition at line 1263 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

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

oxUtils::redirectOffline

(

$iHeaderCode = 302

)

Redirects to shop offline page

Parameters

int

$iHeaderCode

header code, default 302

Definition at line 1028 of file oxutils.php.

oxUtils::resetLanguageCache

(

)

Removes language constant cache

Definition at line 765 of file oxutils.php.

oxUtils::resetMenuCache

(

)

Removes admin menu cache

Definition at line 781 of file oxutils.php.

oxUtils::resetTemplateCache

(

$aTemplates

)

Removes smarty template cache for given templates

Parameters

array

$aTemplates

Template name array

Definition at line 738 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 971 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

Definition at line 480 of file oxutils.php.

oxUtils::setHeader

(

$sHeader

)

set header sent to browser

Parameters

string

$sHeader

header to sent

Definition at line 1111 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 1374 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 250 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 1093 of file oxutils.php.

oxUtils::string2Float

(

$sValue

)

Returns formatted float, according to formatting standards.

Parameters

string

$sValue

Formatted price

Returns

float

Definition at line 203 of file oxutils.php.

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

OXID specific string manipulation method

Parameters

string	$sVal	string
string	$sKey	key

Deprecated:

since v5.2 (2014-08-11); use oxEncryptor::encrypt() instead.

Returns

string

Definition at line 90 of file oxutils.php.

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

OXID specific string manipulation method

Parameters

string	$sVal	string
string	$sKey	key

Deprecated:

since v5.2 (2014-08-11); use oxDecryptor::decrypt() instead.

Returns

string

Definition at line 108 of file oxutils.php.

oxUtils::strRot13

(

$sStr

)

Applies ROT13 encoding to $sStr

Parameters

string

$sStr

to encoding string

Returns

string

Definition at line 1317 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 496 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.

Definition at line 434 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

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

Member Data Documentation

oxUtils::$_aFileCacheContents = array()

protected

Definition at line 57 of file oxutils.php.

oxUtils::$_aLockedFileHandles = array()

protected

Definition at line 50 of file oxutils.php.

oxUtils::$_aStaticCache

protected

Definition at line 71 of file oxutils.php.

oxUtils::$_blIsSe = null

protected

Definition at line 64 of file oxutils.php.

oxUtils::$_blSeoIsActive = null

protected

Definition at line 78 of file oxutils.php.

oxUtils::$_iCurPrecision = null

protected

Definition at line 20 of file oxutils.php.

oxUtils::$_sLanguageCachePattern = "/c_langcache_/i"

protected

Definition at line 36 of file oxutils.php.

oxUtils::$_sMenuCachePattern = "/c_menu_/i"

protected

Definition at line 43 of file oxutils.php.

oxUtils::$_sPermanentCachePattern = "/c_fieldnames_|c_tbdsc_|_allfields_/"

protected

Definition at line 29 of file oxutils.php.

---

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

• core/oxutils.php