Component (Components.AdminCtrl.FieldsIO)
Only the functions and data members that are accessible from your location are displayed
ExtendsComponents.Result.ReturnStruct
HintThis component provides basic field functions for companies, groups and users.
this
public
checkNumericList
Public Function checkNumericList
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Checks if each element in a list is numeric
arguments
labelnamerequiredtypedefaulthint
listtruestringnullThe list to check
addfalsenumericnullIf a list is empty, then add the add
return typeany
COMPONENTCACHE
Struct
concatQuery
Public Function concatQuery
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Concats two queries, and returns one query
arguments
labelnamerequiredtypedefaulthint
query1truequerynullThe first query.
query2truequerynullThe second query.
columnListfalsestring*If you want to select only some columns in stead of of all columns. Usefull if you want to concat queries with different columns.
return typequery
createComponent
Public Function createComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
return typeany
CreateCustomField
Public Function CreateCustomField
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Creates a new custom field.
arguments
labelnamerequiredtypedefaulthint
wcf_nametruestringnullThe display name.
wcf_varnametruestringnullThe internal var name, the column name.
wcf_wistypetruenumericnullThe type of the field, 1=company,2=group,3=user
mcft_idtruenumericnullThe type of the field, 1=tekst,2=select,3=photo,4=textarea,5=selectmultiple
return typestruct
CreateCustomFieldOption
Public Function CreateCustomFieldOption
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Creates a new option for a custom field
arguments
labelnamerequiredtypedefaulthint
wcf_idtruenumericnullThe id of the multiple select field
wcfs_varnametruestringnullThe unique variable name
wcfs_valuetruestringnullThe value of the new option
return typestruct
displayAlertError
Public Function displayAlertError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Alerts optional errormessages.
arguments
labelnamerequiredtypedefaulthint
inputStructuretruestructnullThe structure returned from another function
addScriptTagsfalsebooleantrueDo you want to add the script tags around the alert message?
return typestruct
displayHTMLError
Public Function displayHTMLError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Displays optional errormessages in HTML.
arguments
labelnamerequiredtypedefaulthint
inputStructuretruestructnullThe structure returned from another function.
return typestruct
generateAddSQL
Public Function generateAddSQL
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Generates output for a SQL query statement (adding).
arguments
labelnamerequiredtypedefaulthint
addStructuretruestructnullThe columns and values to add.
return typestruct
generateUpdateSQL
Public Function generateUpdateSQL
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Generates output for a SQL query statement (updating).
arguments
labelnamerequiredtypedefaulthint
updateStructuretruestructnullThe columns and values to update.
return typestruct
genPos
Public Function genPos
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Creates an order id for queries
arguments
labelnamerequiredtypedefaulthint
keytruestringnullThe key the of id's
listtruestringnullThe list of id's
return typestring
getComponent
Public Function getComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
componentNametruestringnull
return typeany
getCustomInfo
Public Function getCustomInfo
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Returns the info about the custom names for companies, groups or users.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group, user or file.
ml_idtruenumericnullThe ID of the language.
return typestruct
getCustomSelectInfo
Public Function getCustomSelectInfo
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Returns the options of a selectfield for a company, group or user.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
wcf_idtruenumericnullThe ID of the field.
ml_idtruenumericnullThe ID of the language.
return typestruct
getCustomSelectorInfo
Public Function getCustomSelectorInfo
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
arguments
labelnamerequiredtypedefaulthint
selectorListtrueanynull
ml_idtruenumericnull
return typeany
getCustomValues
Public Function getCustomValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Returns the custom values for a company, group or user.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
idtruestringnullThe ID(s) of the companies, groups or users.
ml_idtruenumericnullThe ID of the language.
return typestruct
getQuery
Public Function getQuery
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Allows you to create a query in a cfscript.
arguments
labelnamerequiredtypedefaulthint
bodytruestringnullThe body of the query
return typequery
getQueryRecords
Public Function getQueryRecords
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns the specified amount of records.
arguments
labelnamerequiredtypedefaulthint
querytruequerynullThe query.
recordCounttruenumericnullThe amount of records to return.
return typequery
grep
Public Function grep
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
finds a struct with given property value in array of structs
arguments
labelnamerequiredtypedefaulthint
arrtrueanynull
proptrueanynull
valuetrueanynull
return typeany
joinLists
Public Function joinLists
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Joins two lists and filters the duplicates.
arguments
labelnamerequiredtypedefaulthint
list1truestringnullThe first (filtered) list.
list2truestringnullThe second (filtered) list.
return typestring
logDebug
Public Function logDebug
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
logError
Public Function logError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
logInfo
Public Function logInfo
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
logWarn
Public Function logWarn
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
makeUniqueString
Public Function makeUniqueString
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
makes a string unique
arguments
labelnamerequiredtypedefaulthint
strtruestringnull
arrtruearraynull
countfalsenumeric0
return typestring
parseXMLFile
Public Function parseXMLFile
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
filePathfalsestringnull
return typeany
placeImage
Public Function placeImage
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
return typeany
queryToArray
Public Function queryToArray
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns an array containing the items from the query.
arguments
labelnamerequiredtypedefaulthint
inputQuerytruequerynullThe query to convert to an array.
dataColumntruestringnullThe column containing the data to return.
return typearray
QueryToCSV
Public Function QueryToCSV
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
take a query and convert it to a comma separated value string.
arguments
labelnamerequiredtypedefaulthint
Querytruequerynullthe query being converted to CSV.
Fieldstruestringnullthe list of query fields to be used when creating the CSV value.
CreateHeaderRowfalsebooleantrueflag whether or not to create a row of header values.
Delimiterfalsestring,the field delimiter in the CSV value.
return typestring
queryToList
Public Function queryToList
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a list containing the items from the query.
arguments
labelnamerequiredtypedefaulthint
inputQuerytruequerynullThe query to convert to a list.
dataColumnfalsestringnullThe optional column containing the data. If not specified, the first column is used.
return typestring
QueryToStruct
Public Function QueryToStruct
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Converts an entire query or the given record to a struct. This might return a structure (single record) or an array of structures.
arguments
labelnamerequiredtypedefaulthint
Querytruequerynull
Rowfalsenumeric0which row? 0 = all
ColumnListfalsestringAllwhich columns do you want to convert?
DateToISO8601falsebooleanfalseConverts dates to ISO-8601 string
return typeany
readFile
Public Function readFile
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
filePathfalsestringnull
return typestring
removeCustomRecord
Public Function removeCustomRecord
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Deletes all custom field values for the given object
arguments
labelnamerequiredtypedefaulthint
object_typetrueStringnull
object_idtruenumericnull
return typeany
ReplaceListNoCase
Public Function ReplaceListNoCase
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
inputtruestringnullThe string where to replace in.
list1truestringnullThe list of the strings to be replaced
list2truestringnullThe list of the strings which are the new items.
delimiterfalsestring,The delimiter of the lists.
return typestring
returnError
Public Function returnError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a structure containing detailed error info. It also logs the error in the CF-admin.
arguments
labelnamerequiredtypedefaulthint
me_idtruenumericnullThe code for this error, it will be used to get the errormessage.
errorStructurefalseanynullThe optional cfcatch structure.
dumpVariablefalseanynullAn optional variable to dump.
return typestruct
returnQueryFromString
Public Function returnQueryFromString
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Generates a query with columns and multiple records.
arguments
labelnamerequiredtypedefaulthint
columnNametruestringnullThe columnname, this could be a list.
valuetruestringnullThe value. This could be a list
valueSeparatorfalsestring,A separator for the value list, default is ','. This separates the columns.
recordSeparatorfalsestring;A separator for the value list, default is ';'. This separates the records
return typequery
returnResult
Public Function returnResult
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a structure containing status info and a resultquery (optional).
arguments
labelnamerequiredtypedefaulthint
resultQueryfalsequerynullThe optional query containing the result.
return typestruct
returnSecurity
Public Function returnSecurity
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a security breach.
arguments
labelnamerequiredtypedefaulthint
return typestruct
searchCustomFileFields
Public Function searchCustomFileFields
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
arguments
labelnamerequiredtypedefaulthint
searchFieldstruestructnull
ml_idtruenumericnull
useORfalsebooleantrue
return typeany
setValues
Public Function setValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Updates all values for a company, user or group.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
idtruenumericnullThe ID of the company, group or user.
valueStructuretruestructnullThe fieldnames and their values.
ml_idfalsenumeric-1The fieldnames and their values.
return typestruct
textToNumber
Public Function textToNumber
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a number for the english word
arguments
labelnamerequiredtypedefaulthint
texttrueanynull
return typenumeric
trueFalseFormat
Public Function trueFalseFormat
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
convert cf string to boolean
arguments
labelnamerequiredtypedefaulthint
exptrueanynull
return typeany
uniqueListAppend
Public Function uniqueListAppend
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Adds an item to the list if that list does not contain it already.
arguments
labelnamerequiredtypedefaulthint
listtruestringnullThe list.
itemstruestringnullThe item(s) to add.
delimiterfalsestring,The delimiter (optional).
return typestring
private
addCustomValues
Private Function addCustomValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Inserts custom values for a company, group or user.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
idtruenumericnullThe ID of the company, group or user.
customStructuretruestructnullThe custom names and their values.
return typestruct
addStandardValues
Private Function addStandardValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Inserts the standard values for a company, group or user.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
standardStructuretruestructnullThe standard names and their values.
return typestruct
addValues
Private Function addValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Adds all values for a company, user or group.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
valueStructuretruestructnullThe fieldnames and their values.
return typestruct
getDefaultValues
Private Function getDefaultValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Returns the default values for a company, group or user.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
return typestruct
getStandardNames
Private Function getStandardNames
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Returns the standard names for a company, group or user.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
return typestruct
getStandardValues
Private Function getStandardValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Returns the standard values for companies, groups or users.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
idtruestringnullThe ID(s) of companies, groups or users.
ml_idfalsenumeric1The ID of the language.
return typestruct
getType
Private Function getType
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Returns the tablename and primary key.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group, user.
return typestruct
getValues
Private Function getValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Returns all values for a company, user or group.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
idtruestringnullThe ID(s) of the companies, groups or users.
ml_idtruenumericnullThe ID of the language.
return typestruct
setCustomValues
Private Function setCustomValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Updates custom values for a company, group or user.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
idtruenumericnullThe ID of the company, group or user.
customStructuretruestructnullThe customfield names and their values.
ml_idfalseany-1
return typestruct
setStandardValues
Private Function setStandardValues
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Updates the standard values for a company, group or user.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
idtruenumericnullThe ID of the company, group or user.
standardStructuretruestructnullThe standard names and their values.
return typestruct
switchStatus
Private Function switchStatus
source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc
Sets a company, group or user active/inactive.
arguments
labelnamerequiredtypedefaulthint
typetruestringnullThe type, values: company, group or user.
idtruenumericnullThe ID of the company, group or user.
return typestruct