Component (Components.AdminCtrl.GroupIO) Only the functions and data members that are accessible from your location are displayed
Extends	Components.AdminCtrl.FieldsIO
Hint	This component provides basic group functions.
this	public addGroup Public Function addGroup source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Inserts the standard values for a group. arguments label name required type default hint standardStructure true struct null The standard names and their values. return type struct addGroupMembers Public Function addGroupMembers source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Inserts members of a group. arguments label name required type default hint wg_id true numeric null The ID of the group. wu_id true string null The ID(s) of the members. return type struct addGroupModules Public Function addGroupModules source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Adds modules for a group. arguments label name required type default hint wg_id true numeric null The ID of the group. mm_id true string null The ID(s) of the module. return type struct addGroupValues Public Function addGroupValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Adds all values for a group. arguments label name required type default hint valueStructure true struct null The names and their values. return type struct checkNumericList Public Function checkNumericList source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Checks if each element in a list is numeric arguments label name required type default hint list true string null The list to check add false numeric null If a list is empty, then add the add return type any COMPONENTCACHE Struct concatQuery Public Function concatQuery source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Concats two queries, and returns one query arguments label name required type default hint query1 true query null The first query. query2 true query null The second query. columnList false string * 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 type query countGroupMembers Public Function countGroupMembers source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the amount of members of a group. arguments label name required type default hint wg_id true numeric null The ID of the group. return type struct countGroupModules Public Function countGroupModules source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the amount of modules for a group. arguments label name required type default hint wg_id true numeric null The ID of the group. return type struct createComponent Public Function createComponent source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint return type any CreateCustomField Public Function CreateCustomField source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Creates a new custom field. arguments label name required type default hint wcf_name true string null The display name. wcf_varname true string null The internal var name, the column name. wcf_wistype true numeric null The type of the field, 1=company,2=group,3=user mcft_id true numeric null The type of the field, 1=tekst,2=select,3=photo,4=textarea,5=selectmultiple return type struct CreateCustomFieldOption Public Function CreateCustomFieldOption source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Creates a new option for a custom field arguments label name required type default hint wcf_id true numeric null The id of the multiple select field wcfs_varname true string null The unique variable name wcfs_value true string null The value of the new option return type struct deleteAllGroupMembers Public Function deleteAllGroupMembers source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Removes all members of a group. arguments label name required type default hint wg_id true numeric null The ID of the group. return type struct deleteAllGroupModules Public Function deleteAllGroupModules source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Deletes all modules for a group. arguments label name required type default hint wg_id true numeric null The ID of the group. return type struct deleteGroup Public Function deleteGroup source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Deletes a group. arguments label name required type default hint wg_id true numeric null The ID of the group. return type struct deleteGroupMembers Public Function deleteGroupMembers source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Removes members of a group. arguments label name required type default hint wg_id true numeric null The ID of the group. wu_id true string null The ID(s) of the members. return type struct deleteGroupModules Public Function deleteGroupModules source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Deletes modules for a group. arguments label name required type default hint wg_id true numeric null The ID of the group. mm_id true string null The ID(s) of the module. return type struct displayAlertError Public Function displayAlertError source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Alerts optional errormessages. arguments label name required type default hint inputStructure true struct null The structure returned from another function addScriptTags false boolean true Do you want to add the script tags around the alert message? return type struct displayHTMLError Public Function displayHTMLError source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Displays optional errormessages in HTML. arguments label name required type default hint inputStructure true struct null The structure returned from another function. return type struct generateAddSQL Public Function generateAddSQL source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Generates output for a SQL query statement (adding). arguments label name required type default hint addStructure true struct null The columns and values to add. return type struct generateUpdateSQL Public Function generateUpdateSQL source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Generates output for a SQL query statement (updating). arguments label name required type default hint updateStructure true struct null The columns and values to update. return type struct genPos Public Function genPos source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Creates an order id for queries arguments label name required type default hint key true string null The key the of id's list true string null The list of id's return type string getAllowedMembers Public Function getAllowedMembers source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the maximum amount of (addable) members for a group. arguments label name required type default hint wg_id true numeric null The ID of the group. returnAddable false boolean true Indicates whether to return the maximum amount or the addable groups. return type struct getComponent Public Function getComponent source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint componentName true string null return type any 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 label name required type default hint type true string null The type, values: company, group, user or file. ml_id true numeric null The ID of the language. return type struct 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 label name required type default hint type true string null The type, values: company, group or user. wcf_id true numeric null The ID of the field. ml_id true numeric null The ID of the language. return type struct getCustomSelectorInfo Public Function getCustomSelectorInfo source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc arguments label name required type default hint selectorList true any null ml_id true numeric null return type any 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 label name required type default hint type true string null The type, values: company, group or user. id true string null The ID(s) of the companies, groups or users. ml_id true numeric null The ID of the language. return type struct getGroupByName Public Function getGroupByName source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc return the group with the given name arguments label name required type default hint wg_name true string null wc_id false numeric null return type query getGroupCustomInfo Public Function getGroupCustomInfo source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the info about the custom names for groups. arguments label name required type default hint ml_id true numeric null The ID of the language. return type struct getGroupCustomSelectInfo Public Function getGroupCustomSelectInfo source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the options of a selectfield for groups. arguments label name required type default hint wcf_id true numeric null The ID of the field. ml_id true numeric null The ID of the language. return type struct getGroupCustomValues Public Function getGroupCustomValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the custom values for groups. arguments label name required type default hint wg_id true string null The ID(s) of the groups. ml_id true numeric null The ID of the language. return type struct getGroupDefaultValues Public Function getGroupDefaultValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the default values for a group. arguments label name required type default hint return type struct getGroupMembers Public Function getGroupMembers source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Gets the members of a group. arguments label name required type default hint wg_id true numeric null The ID of the group. searchString false string The string to search the users on (email,firstname,lastname,fullname) sort false numeric 0 return type struct getGroupMinimumShareMode Public Function getGroupMinimumShareMode source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the minimum sharemode of the group. arguments label name required type default hint wg_id true numeric null The ID of the group. return type numeric getGroupModules Public Function getGroupModules source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the modules of a group. arguments label name required type default hint wg_id true numeric null The ID of the group. return type struct getGroupsFromCompany Public Function getGroupsFromCompany source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Gives groups from company arguments label name required type default hint scope_wc_id true numeric null return type query getGroupStandardNames Public Function getGroupStandardNames source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the standard names for groups. arguments label name required type default hint return type struct getGroupStandardValues Public Function getGroupStandardValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the standard values for groups. arguments label name required type default hint wg_id true string null The ID(s) of the groups. return type struct getGroupTypes Public Function getGroupTypes source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns all group types. arguments label name required type default hint return type struct getGroupValues Public Function getGroupValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns all values for groups. arguments label name required type default hint wg_id true string null The ID(s) of the groups. ml_id true numeric null The ID of the language. return type struct getQuery Public Function getQuery source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Allows you to create a query in a cfscript. arguments label name required type default hint body true string null The body of the query return type query getQueryRecords Public Function getQueryRecords source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns the specified amount of records. arguments label name required type default hint query true query null The query. recordCount true numeric null The amount of records to return. return type query 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 label name required type default hint arr true any null prop true any null value true any null return type any isGroupModuleActive Public Function isGroupModuleActive source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns the status (enabled/disabled) of a module for a group. arguments label name required type default hint wg_id true numeric null The ID of the group. mm_id true numeric null The ID of the module. return type boolean joinLists Public Function joinLists source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Joins two lists and filters the duplicates. arguments label name required type default hint list1 true string null The first (filtered) list. list2 true string null The second (filtered) list. return type string logDebug Public Function logDebug source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint message false any null exception false any null The optional cfcatch structure. return type any logError Public Function logError source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint message false any null exception false any null The optional cfcatch structure. return type any logInfo Public Function logInfo source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint message false any null exception false any null The optional cfcatch structure. return type any logWarn Public Function logWarn source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint message false any null exception false any null The optional cfcatch structure. return type any makeUniqueString Public Function makeUniqueString source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc makes a string unique arguments label name required type default hint str true string null arr true array null count false numeric 0 return type string parseXMLFile Public Function parseXMLFile source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint filePath false string null return type any placeImage Public Function placeImage source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint return type any queryToArray Public Function queryToArray source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns an array containing the items from the query. arguments label name required type default hint inputQuery true query null The query to convert to an array. dataColumn true string null The column containing the data to return. return type array 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 label name required type default hint Query true query null the query being converted to CSV. Fields true string null the list of query fields to be used when creating the CSV value. CreateHeaderRow false boolean true flag whether or not to create a row of header values. Delimiter false string , the field delimiter in the CSV value. return type string queryToList Public Function queryToList source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns a list containing the items from the query. arguments label name required type default hint inputQuery true query null The query to convert to a list. dataColumn false string null The optional column containing the data. If not specified, the first column is used. return type string 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 label name required type default hint Query true query null Row false numeric 0 which row? 0 = all ColumnList false string All which columns do you want to convert? DateToISO8601 false boolean false Converts dates to ISO-8601 string return type any readFile Public Function readFile source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint filePath false string null return type string removeCustomRecord Public Function removeCustomRecord source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Deletes all custom field values for the given object arguments label name required type default hint object_type true String null object_id true numeric null return type any ReplaceListNoCase Public Function ReplaceListNoCase source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint input true string null The string where to replace in. list1 true string null The list of the strings to be replaced list2 true string null The list of the strings which are the new items. delimiter false string , The delimiter of the lists. return type string 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 label name required type default hint me_id true numeric null The code for this error, it will be used to get the errormessage. errorStructure false any null The optional cfcatch structure. dumpVariable false any null An optional variable to dump. return type struct returnQueryFromString Public Function returnQueryFromString source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Generates a query with columns and multiple records. arguments label name required type default hint columnName true string null The columnname, this could be a list. value true string null The value. This could be a list valueSeparator false string , A separator for the value list, default is ','. This separates the columns. recordSeparator false string ; A separator for the value list, default is ';'. This separates the records return type query 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 label name required type default hint resultQuery false query null The optional query containing the result. return type struct returnSecurity Public Function returnSecurity source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns a security breach. arguments label name required type default hint return type struct searchCustomFileFields Public Function searchCustomFileFields source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc arguments label name required type default hint searchFields true struct null ml_id true numeric null useOR false boolean true return type any searchGroups Public Function searchGroups source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Returns group info with a search constraint. arguments label name required type default hint wg_id true string null The ID(s) of the groups. search false string A string containing the search. return type struct setGroupCustomValues Public Function setGroupCustomValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Updates the custom values for a group. arguments label name required type default hint wg_id true numeric null The ID of the group. customStructure true struct null The custom names and their values. return type struct setGroupStandardValues Public Function setGroupStandardValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Updates the standard values for a group. arguments label name required type default hint wg_id true numeric null The ID of the group. standardStructure true struct null The standard names and their values. return type struct setGroupValues Public Function setGroupValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Sets all values for a group. arguments label name required type default hint wg_id true numeric null The ID of the group. valueStructure true struct null The names and their values. return type struct setValues Public Function setValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Updates all values for a company, user or group. arguments label name required type default hint type true string null The type, values: company, group or user. id true numeric null The ID of the company, group or user. valueStructure true struct null The fieldnames and their values. ml_id false numeric -1 The fieldnames and their values. return type struct switchGroupStatus Public Function switchGroupStatus source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/GroupIO.cfc Sets a group active/inactive. arguments label name required type default hint wg_id true numeric null The ID of the group. return type struct textToNumber Public Function textToNumber source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns a number for the english word arguments label name required type default hint text true any null return type numeric trueFalseFormat Public Function trueFalseFormat source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc convert cf string to boolean arguments label name required type default hint exp true any null return type any 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 label name required type default hint list true string null The list. items true string null The item(s) to add. delimiter false string , The delimiter (optional). return type string 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 label name required type default hint type true string null The type, values: company, group or user. id true numeric null The ID of the company, group or user. customStructure true struct null The custom names and their values. return type struct 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 label name required type default hint type true string null The type, values: company, group or user. standardStructure true struct null The standard names and their values. return type struct addValues Private Function addValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Adds all values for a company, user or group. arguments label name required type default hint type true string null The type, values: company, group or user. valueStructure true struct null The fieldnames and their values. return type struct 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 label name required type default hint type true string null The type, values: company, group or user. return type struct 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 label name required type default hint type true string null The type, values: company, group or user. return type struct getStandardValues Private Function getStandardValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Returns the standard values for companies, groups or users. arguments label name required type default hint type true string null The type, values: company, group or user. id true string null The ID(s) of companies, groups or users. ml_id false numeric 1 The ID of the language. return type struct getType Private Function getType source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Returns the tablename and primary key. arguments label name required type default hint type true string null The type, values: company, group, user. return type struct getValues Private Function getValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Returns all values for a company, user or group. arguments label name required type default hint type true string null The type, values: company, group or user. id true string null The ID(s) of the companies, groups or users. ml_id true numeric null The ID of the language. return type struct setCustomValues Private Function setCustomValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Updates custom values for a company, group or user. arguments label name required type default hint type true string null The type, values: company, group or user. id true numeric null The ID of the company, group or user. customStructure true struct null The customfield names and their values. ml_id false any -1 return type struct 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 label name required type default hint type true string null The type, values: company, group or user. id true numeric null The ID of the company, group or user. standardStructure true struct null The standard names and their values. return type struct switchStatus Private Function switchStatus source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/FieldsIO.cfc Sets a company, group or user active/inactive. arguments label name required type default hint type true string null The type, values: company, group or user. id true numeric null The ID of the company, group or user. return type struct