|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.core.util.Util
public class Util
The main ColdBox utility library filled with lots of nice goodies.
Method Summary | |
---|---|
void |
abortit()
Facade for cfabort |
struct |
arrayToStruct(array in)
Convert an array to struct argument notation |
void |
convertToColdBox(any family, any target)
Decorate an object as a ColdBox Family object |
void |
dumpit(any var, [boolean isAbort='false'])
Facade for cfmx dump |
string |
fileLastModified(any filename)
Get the last modified date of a file |
string |
getAbsolutePath(any path)
Turn any system path, either relative or absolute, into a fully qualified one |
any |
getInheritedMetaData(any component, [any stopRecursions='[runtime expression]'], [any md='[runtime expression]'])
Returns a single-level metadata struct that includes all items inhereited from extending classes |
any<MixerUtil> |
getMixerUtil()
Get the mixer utility |
boolean |
inThread()
Check if you are in cfthread or not for any CFML Engine |
void |
includeit(any template)
Facade for cfinclude |
boolean |
isFamilyType(any family, any target)
Checks if an object is of the passed in family type |
boolean |
isInstanceCheck(any obj, any family='')
Checks if an object is of a certain type of family via inheritance |
any |
placeHolderReplacer(any str, any settings)
PlaceHolder Replacer for strings containing ${} patterns |
void |
rethrowit(any throwObject)
Rethrow an exception |
string |
ripExtension(any filename)
Rip the extension of a filename |
private any<Boolean> |
stopClassRecursion(any classname, any stopRecursions)
Should we stop recursion or not due to class name found: Boolean |
void |
throwInvalidHTTP(any className, any detail, any statusText, any statusCode)
Throw an invalid HTTP exception |
any |
throwit(any message, [any detail=''], [any type='Framework'])
Facade for cfthrow |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Method Detail |
---|
public void abortit()
public struct arrayToStruct(array in)
in
- The array to convertpublic void convertToColdBox(any family, any target)
family
- The family to covert it to: handler, plugin, interceptortarget
- The target objectpublic void dumpit(any var, [boolean isAbort='false'])
var
isAbort
- Abort alsopublic string fileLastModified(any filename)
filename
public string getAbsolutePath(any path)
path
public any getInheritedMetaData(any component, [any stopRecursions='[runtime expression]'], [any md='[runtime expression]'])
component
- A component instance, or the path to onestopRecursions
- An array of classes to stop recursionmd
- A structure containing a copy of the metadata for this level of recursion.public any<MixerUtil> getMixerUtil()
public boolean inThread()
public void includeit(any template)
template
public boolean isFamilyType(any family, any target)
family
- The family to covert it to: handler, plugin, interceptortarget
- The target objectpublic boolean isInstanceCheck(any obj, any family='')
obj
- The object to evaluatefamily
- The family string to checkpublic any placeHolderReplacer(any str, any settings)
str
- The string variable to look for replacementssettings
- The structure of settings to use in replacingpublic void rethrowit(any throwObject)
throwObject
- The exception objectpublic string ripExtension(any filename)
filename
private any<Boolean> stopClassRecursion(any classname, any stopRecursions)
classname
- The class name to checkstopRecursions
- An array of classes to stop processing atpublic void throwInvalidHTTP(any className, any detail, any statusText, any statusCode)
className
- The class producing the exceptiondetail
- The throw detail argument to send outstatusText
- Invalid exception status textstatusCode
- The status code to send out.public any throwit(any message, [any detail=''], [any type='Framework'])
message
detail
type
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |