utility

Class utility

lucee.Component
    mura.baseobject
      mura.utility

This provides global utility methods

Class Attributes:

output : false

synchronized : false

accessors : false

persistent : false

Constructor Summary
init(any configBean, any fileWriter)

Method Summary
`any`	arrayFind(array array, string stringa)
`any`	arrayToQuery(array array)
`any`	backUp()
`any`	cfformprotect([any event])
`any`	cfml2wddx([any value])
`any`	checkBCryptHash([any string], [any hash])
`any`	checkForInstanceOf([any obj], [any name])
`any`	clearObjectCache()
`any`	copyDir(any baseDir='', any destDir='', any excludeList='', any sinceDate='', any excludeHiddenFiles='true')
`string`	createCSSHook([any text=''])
`any`	createDir(any baseDir='')
`any`	createRedirectID(any theLink)
`any`	createRequiredSiteDirectories(string siteid='', string displaypoolid='')
`any`	datetimeToTimespanInterval([any datetime='[runtime expression]'], [any timespan=''])
`any`	deleteCookie(string name, [boolean preserveCase='true'])
`any`	deleteDir(any baseDir='')
`any`	displayErrors(struct error='[runtime expression]')
`any`	dumpTrace()
`struct`	filterArgs([struct args], [string badwords])
`any`	fixLineBreaks([any str])
`any`	fixOracleClobs([any rs])
`any`	fixQueryPaths([any rsDir], [any path='directory'])
`any`	formatError([any exception])
`any`	getBCrypt()
`any`	getCryptoSalt([any logRounds='[runtime expression]'], [any reseedFrequency='[runtime expression]'])
`any`	getEpochTime()
`any`	getIsoTimeString(date datetime, [boolean convertToUTC='true'])
`struct`	getNextN([any data], [numeric RecordsPerPage], [numeric startRow], [numeric pageBuffer='5'])
`struct`	getReCAPTCHAKeys(any event)
`struct`	getReCAPTCHALanguages()
`any`	getRemoteIP()
`any`	getRequestHost()
`any`	getRequestProtocol()
`any`	getStringBytesLength([any str])
`any`	getUUID()
`any`	getXMLKeyValue([any xmlObj], [any key], [any defaultValue=''])
`any`	invokeMethod([any component], [any methodName], [any args='[runtime expression]'])
`boolean`	isHTTPS()
`boolean`	isHuman(any event)
`any`	isPathLegal([any path])
`any`	isValidCFVariableName(String text)
`any`	joinArrays([any array1], [any array2])
`any`	leftTrimByBytes([any str=''], [any len='255'])
`any`	legacyLogout()
`any`	listFix([any list])
`any`	logEvent(string text='', string file='', string type='Information', boolean application='true')
`any`	parseDomain([any urlstring])
`any`	queryAppend(query QueryOne, query QueryTwo) This takes two queries and appends the second one to the first one.
`any`	queryRowToArray([any qry], [any i])
`struct`	queryRowToStruct(query qry)
`any`	queryToArray([any qry], [any primarykey=''])
`any`	queryToStruct([any qry])
`boolean`	reCAPTCHA(any event)
`string`	renderFileSize([any size='0'])
`any`	resetContent()
`any`	sanitizeHref([any href])
`any`	scheduleTask()
`string`	setCamelback([any theString=''])
`any`	setCookie(string name, string value, [string expires='never'], [boolean preserveCase='true'], [boolean httpOnly='true'], [string samesite=''])
`void`	setCookieLegacy(string name, string value, [any expires=''], [string domain=''], [string path='/'], [boolean secure='false'], [boolean httponly='true'], [boolean preserveCase='false'], [string samesite='']) Replacement for cfcookie that handles httponly cookies.
`any`	setCryptoSalt([any logRounds='[runtime expression]'])
`any`	setHeader([any statustext], [any statuscode])
`any`	setHTMLHead([any value])
`string`	setProperCase([any theString=''])
`any`	setRequestTimeout([any timeout])
`any`	setSessionCookies([any reset='[runtime expression]'])
`string`	stripTags([any text=''], [any tagsToStrip='script,style,embed,object'])
`any`	suppressDebugging()
`any`	textPreview(string str, [numeric maxlen='100'], [string finishlist='.\|?\|!'], [string finishdelim='\|'])
`any`	toBCryptHash([any string], [any logRounds='[runtime expression]'])
`any`	trimVarchar([any str], [any len])
`any`	wddx2cfml([any value])

Methods inherited from class `mura.baseobject`
commitTracePoint, convertTimezone, deleteMethod, get, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEntity, getEventManager, getFeed, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getQueryAttrs, getQueryService, getServiceFactory, getSession, getValue, hasCustomDatasource, initTracePoint, inject, injectMethod, isORM, mixin, parseDateArg, removeValue, set, setValue, valueExists

Methods inherited from class mura.baseobject

commitTracePoint, convertTimezone, deleteMethod, get, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEntity, getEventManager, getFeed, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getQueryAttrs, getQueryService, getServiceFactory, getSession, getValue, hasCustomDatasource, initTracePoint, inject, injectMethod, isORM, mixin, parseDateArg, removeValue, set, setValue, valueExists

Methods inherited from class `lucee.Component`
None

Constructor Detail

init

public init(any configBean, any fileWriter)

Parameters:: configBean; fileWriter

Method Detail

arrayFind

public any arrayFind(array array, string stringa)

Parameters:: array; stringa

arrayToQuery

public any arrayToQuery(array array)

Parameters:: array

backUp

public any backUp()

cfformprotect

public any cfformprotect([any event])

Parameters:: event

cfml2wddx

public any cfml2wddx([any value])

Parameters:: value

checkBCryptHash

public any checkBCryptHash([any string], [any hash])

Parameters:: string; hash

checkForInstanceOf

public any checkForInstanceOf([any obj], [any name])

Parameters:: obj; name

clearObjectCache

public any clearObjectCache()

copyDir

public any copyDir(any baseDir='', any destDir='', any excludeList='', any sinceDate='', any excludeHiddenFiles='true')

Parameters:: baseDir; destDir; excludeList; sinceDate; excludeHiddenFiles

createCSSHook

public string createCSSHook([any text=''])

Parameters:: text

createDir

public any createDir(any baseDir='')

Parameters:: baseDir

createRedirectID

public any createRedirectID(any theLink)

Parameters:: theLink

createRequiredSiteDirectories

public any createRequiredSiteDirectories(string siteid='', string displaypoolid='')

Parameters:: siteid; displaypoolid

datetimeToTimespanInterval

public any datetimeToTimespanInterval([any datetime='[runtime expression]'], [any timespan=''])

Parameters:: datetime; timespan

deleteCookie

public any deleteCookie(string name, [boolean preserveCase='true'])

Parameters:: name; preserveCase

deleteDir

public any deleteDir(any baseDir='')

Parameters:: baseDir

displayErrors

public any displayErrors(struct error='[runtime expression]')

Parameters:: error

dumpTrace

public any dumpTrace()

filterArgs

public struct filterArgs([struct args], [string badwords])

Parameters:: args; badwords

fixLineBreaks

public any fixLineBreaks([any str])

Parameters:: str

fixOracleClobs

public any fixOracleClobs([any rs])

Parameters:: rs

fixQueryPaths

public any fixQueryPaths([any rsDir], [any path='directory'])

Parameters:: rsDir; path

formatError

public any formatError([any exception])

Parameters:: exception

getBCrypt

public any getBCrypt()

getCryptoSalt

public any getCryptoSalt([any logRounds='[runtime expression]'], [any reseedFrequency='[runtime expression]'])

Parameters:: logRounds; reseedFrequency - How often to re-seed.

getEpochTime

public any getEpochTime()

getIsoTimeString

public any getIsoTimeString(date datetime, [boolean convertToUTC='true'])

Parameters:: datetime; convertToUTC

getNextN

public struct getNextN([any data], [numeric RecordsPerPage], [numeric startRow], [numeric pageBuffer='5'])

Parameters:: data; RecordsPerPage; startRow; pageBuffer

getReCAPTCHAKeys

public struct getReCAPTCHAKeys(any event)

Parameters:: event

getReCAPTCHALanguages

public struct getReCAPTCHALanguages()

getRemoteIP

public any getRemoteIP()

getRequestHost

public any getRequestHost()

getRequestProtocol

public any getRequestProtocol()

getStringBytesLength

public any getStringBytesLength([any str])

Parameters:: str

getUUID

public any getUUID()

getXMLKeyValue

public any getXMLKeyValue([any xmlObj], [any key], [any defaultValue=''])

Parameters:: xmlObj; key; defaultValue

invokeMethod

public any invokeMethod([any component], [any methodName], [any args='[runtime expression]'])

Overrides:: invokeMethod in class baseobject

Parameters:: component; methodName; args

isHTTPS

public boolean isHTTPS()

isHuman

public boolean isHuman(any event)

Parameters:: event

isPathLegal

public any isPathLegal([any path])

Parameters:: path

isValidCFVariableName

public any isValidCFVariableName(String text)

Parameters:: text

joinArrays

public any joinArrays([any array1], [any array2])

Parameters:: array1; array2

leftTrimByBytes

public any leftTrimByBytes([any str=''], [any len='255'])

Parameters:: str; len

legacyLogout

public any legacyLogout()

listFix

public any listFix([any list])

Parameters:: list

logEvent

public any logEvent(string text='', string file='', string type='Information', boolean application='true')

Parameters:: text; file; type; application

parseDomain

public any parseDomain([any urlstring])

Parameters:: urlstring

queryAppend

public any queryAppend(query QueryOne, query QueryTwo)

This takes two queries and appends the second one to the first one. This actually updates the first query and does not return anything.

Parameters:: QueryOne; QueryTwo

queryRowToArray

public any queryRowToArray([any qry], [any i])

Parameters:: qry; i

queryRowToStruct

public struct queryRowToStruct(query qry)

Parameters:: qry

queryToArray

public any queryToArray([any qry], [any primarykey=''])

Parameters:: qry; primarykey

queryToStruct

public any queryToStruct([any qry])

Parameters:: qry

reCAPTCHA

public boolean reCAPTCHA(any event)

Parameters:: event

renderFileSize

public string renderFileSize([any size='0'])

Parameters:: size

resetContent

public any resetContent()

sanitizeHref

public any sanitizeHref([any href])

Parameters:: href

scheduleTask

public any scheduleTask()

setCamelback

public string setCamelback([any theString=''])

Parameters:: theString

setCookie

public any setCookie(string name, string value, [string expires='never'], [boolean preserveCase='true'], [boolean httpOnly='true'], [string samesite=''])

Parameters:: name; value; expires; preserveCase; httpOnly; samesite

setCookieLegacy

public void setCookieLegacy(string name, string value, [any expires=''], [string domain=''], [string path='/'], [boolean secure='false'], [boolean httponly='true'], [boolean preserveCase='false'], [string samesite=''])

Replacement for cfcookie that handles httponly cookies

Parameters:: name; value; expires - ''=session only|now|never|[date]|[number of days]; domain; path; secure; httponly; preserveCase; samesite

setCryptoSalt

public any setCryptoSalt([any logRounds='[runtime expression]'])

Parameters:: logRounds

setHeader

public any setHeader([any statustext], [any statuscode])

Parameters:: statustext; statuscode

setHTMLHead

public any setHTMLHead([any value])

Parameters:: value

setProperCase

public string setProperCase([any theString=''])

Parameters:: theString

setRequestTimeout

public any setRequestTimeout([any timeout])

Parameters:: timeout

setSessionCookies

public any setSessionCookies([any reset='[runtime expression]'])

Parameters:: reset

stripTags

public string stripTags([any text=''], [any tagsToStrip='script,style,embed,object'])

Parameters:: text; tagsToStrip

suppressDebugging

public any suppressDebugging()

textPreview

public any textPreview(string str, [numeric maxlen='100'], [string finishlist='.|?|!'], [string finishdelim='|'])

Parameters:: str; maxlen - Maximum length; finishlist - List of finish symbols; finishdelim - Deliemiter for List of finish symbols

toBCryptHash

public any toBCryptHash([any string], [any logRounds='[runtime expression]'])

Parameters:: string; logRounds

trimVarchar

public any trimVarchar([any str], [any len])

Parameters:: str; len

wddx2cfml

public any wddx2cfml([any value])

Parameters:: value