Base object for other Admin API CFCs.
| hierarchy: |
WEB-INF.cftags.component CFIDE.adminapi.base |
| path: | /opt/coldfusion/cfusion/wwwroot/CFIDE/adminapi/base.cfc |
| serializable: | Yes |
| properties: | |
| final: | false |
| abstract: | false |
| methods: | dump, getEdition, getInstallType, isAdminUser, logaudit, tfformat*, throw* |
| dump |
|---|
public
dump
(
required
value,
expand="true"
)
Used to debug variables inside of cfscript. Output: enabled Parameters: value: any, required, value - ColdFusion variable or scope to display. expand: any, optional, expand - Expand views, yes or no (Internet Explorer and Mozilla only). |
| getEdition |
package
string
getEdition
(
)
Returns the edition:
Output: suppressed |
| getInstallType |
package
string
getInstallType
(
)
Returns the install type. Output: suppressed |
| isAdminUser |
public
isAdminUser
(
requiredRoles=""
)
Check to see if user is authenticated Output: suppressed Parameters: requiredRoles: any, optional, requiredRoles - List of required roles. |
| logaudit |
public
logaudit
(
required
msg,
isapplication="no"
)
Used to log auditing information for adminapi. Output: suppressed Parameters: msg: any, required, msg - message to log. isapplication: any, optional, isapplication - if message is application level. |
| tfformat* |
private
tfformat
(
required
val
)
Indicates whether a passed value is of data type Boolean. Output: suppressed Parameters: val: any, required, val - Value to be checked. |
| throw* |
private
throw
(
message="",
type="Exception"
)
Used to throw errors in a cfscript block. Output: suppressed Parameters: message: any, optional, message - A message that describes the error. type: any, optional, type |