| public |
| addData | Public Function addData source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Adds data. You can specify a query to insert directly data, so the query must and can only contain a column named data and ml_id. | | arguments | | label | name | required | type | default | hint | | data_type | true | string | null | The data type of the data, it accepts a lot of values. You can give SQL types(don't worry about nx or x), or the id wich can be find in the table data_types. | | dataQuery | false | query | null | A query to fill the new data record set. |
| | return type | struct |
|
| addLanguage | Public Function addLanguage source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Adds for every data_id a new record for the new language. | | arguments | | label | name | required | type | default | hint | | ml_id | true | numeric | null | The ml_id of the new language. |
| | return type | struct |
|
| addSite | Public Function addSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds a website. | | arguments | | label | name | required | type | default | hint | | valueStructure | true | struct | null | The siteproperties and their values. | | languages | true | string | null | The languages the site must be available for. |
| | return type | struct |
|
| addSiteAdmin | Public Function addSiteAdmin source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds an admin to a website. One of the arguments can be specified as a list. | | arguments | | label | name | required | type | default | hint | | site_id_list | true | string | null | The ID(s) of the website. | | wu_id_list | true | string | null | The ID(s) of the administrator. |
| | return type | struct |
|
| addSiteValues | Public Function addSiteValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds the standard values for a website. | | arguments | | label | name | required | type | default | hint | | valueStructure | true | struct | null | The site properties and their values. |
| | return type | struct |
|
| addTemplate | Public Function addTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds a template in a website. Note, after this you need to add a template part. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. | | name | true | string | null | The name of the new template |
| | return type | struct |
|
| addTemplatePart | Public Function addTemplatePart source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds a template part in a template. | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The ID of the template. | | stp_parent_id | true | numeric | null | The id of the parent part. 0 is a main part. |
| | return type | struct |
|
| checkDatabase | Public Function checkDatabase source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc This function can repair the data parte of the database. | | arguments | | label | name | required | type | default | hint | | definition | true | query | null | A query wich contains a column named table, a column named column and and a column named data_type. For every column wich a data part, you needs to specify the table and the column name. | | repair | false | boolean | false | What has the function to do, repair or only report? Default is no, thus report. |
| | 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 |
|
| compileTemplate | Public Function compileTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Compiles a cfm template | | arguments | | label | name | required | type | default | hint | | templateName | true | string | null | The name of the template to compile | | siteName | true | string | null | The name of the website | | replaceSpecialCharacters | true | boolean | null | Replace characters in the compiled template | | dateMask | false | string | null | The datemask to use. Can be used when it cannot be retrieved from the session. | | timeMask | false | string | null | The timemask to use. Can be used when it cannot be retrieved from the session. |
| | return type | string |
|
| COMPONENTCACHE | |
| 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 |
|
| countCompanySites | Public Function countCompanySites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the number of sites for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | 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 |
|
| createDataTimeNow | Public Function createDataTimeNow source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Returns query which can be passed to the addData function when creating a datetime value with the current time | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| createSelectDate | Public Function createSelectDate source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Generates the select clause for a datetime | | arguments | | label | name | required | type | default | hint | | tablePrefix | true | string | null | The prefix of the table | | format | true | string | null | The format of the date | | as | true | string | null | The select clause AS. |
| | return type | struct |
|
| deleteSite | Public Function deleteSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website |
| | 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 |
|
| filterSites | Public Function filterSites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the records of inputquery where the websites are below the company specified. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. | | filterQuery | true | query | null | The query to be filtered. |
| | 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 |
|
| getAddableSiteAdmins | Public Function getAddableSiteAdmins source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of the site admins which the caller can add. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
|
| getAllPages | Public Function getAllPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of all pages for a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | struct |
|
| getAllSites | Public Function getAllSites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of all sites on an WIS-install. | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getAllSitesBelow | Public Function getAllSitesBelow source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of the websites below the given company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
|
| getCompanyFromSite | Public Function getCompanyFromSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the wc_id of the website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | struct |
|
| getCompanySiteLanguages | Public Function getCompanySiteLanguages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the (distinct) languages from all websites of a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | 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 |
|
| getCustomPropertiesForSite | Public Function getCustomPropertiesForSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc returns all custom properties for the site | | arguments | | label | name | required | type | default | hint | | site_id | true | any | null | |
| | return type | any |
|
| getCustomPropertyForSite | Public Function getCustomPropertyForSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc returns value of custom property for the site, or default | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | | | scp_key | true | any | null | | | default | false | any | | | | object | false | any | false | |
| | return type | any |
|
| getData | Public Function getData source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data. It can find the location of the data on it's own, you don't need to specify the type. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data. | | ml_id | true | numeric | null | The ml_id of the data to get. |
| | return type | struct |
|
| getDataForAllLanguages | Public Function getDataForAllLanguages source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data for all languages. It can find the location of the data on it's own, you don't need to specify the type. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data. |
| | return type | struct |
|
| getDataNumeric | Public Function getDataNumeric source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets numeric data. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The ID of the data. |
| | return type | struct |
|
| getDataReal | Public Function getDataReal source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets real data. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The ID of the data. |
| | return type | struct |
|
| getDataText | Public Function getDataText source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data. It can find the location of the data on it's own, you don't need to specify the type. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data. | | ml_id | true | numeric | null | The ml_id of the data to get. |
| | return type | struct |
|
| getDataType | Public Function getDataType source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data type of the given data_id | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | |
| | return type | struct |
|
| getDataVarchar | Public Function getDataVarchar source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data. It can find the location of the data on it's own, you don't need to specify the type. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data. | | ml_id | true | numeric | null | The ml_id of the data to get. |
| | return type | struct |
|
| getDateTime | Public Function getDateTime source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the datetime. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data datetime. | | dateFormat | false | string | | Gives a CF formatted type, if not defined it returns a cftime format. | | timeFormat | false | string | | Gives a CF formatted type, if not defined it returns a cftime format. |
| | return type | struct |
|
| getFormTemplates | Public Function getFormTemplates source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns all form templates for a siteConfigContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | any |
|
| getImageTemplates | Public Function getImageTemplates source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns all image templates for a siteConfigContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | any |
|
| getLicenses | Public Function getLicenses source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc This function calulates for a given company the number of website licenses. If the company has unlimited websites, it returns -1. If the license is not given for the company, it a void query. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company from wich you want to know the number of licenses. |
| | return type | struct |
|
| getProtocolToUse | Public Function getProtocolToUse source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the protocol to use for this website. | | arguments | | label | name | required | type | default | hint | | siteProperties | true | query | null | |
| | return type | string |
|
| 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 |
|
| getRemovableSiteAdmins | Public Function getRemovableSiteAdmins source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of the site admins which the caller can delete. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | struct |
|
| getSite | Public Function getSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | any |
|
| getSiteAdmins | Public Function getSiteAdmins source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Get all admins of a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website from wich you want the site administrators. |
| | return type | struct |
|
| getSiteConfigContainer | Public Function getSiteConfigContainer source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the configurationContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | struct |
|
| getSiteConfigContainerPageCustomProperties | Public Function getSiteConfigContainerPageCustomProperties source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc returns the configured default page custom properties for this site | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | any |
|
| getSiteConfigContainerPageCustomProperty | Public Function getSiteConfigContainerPageCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Get's a custom property bij sccpcp_id | | arguments | | label | name | required | type | default | hint | | sccpcp_id | true | numeric | null | |
| | return type | any |
|
| getSiteConfigContainerPageCustomPropertyByKey | Public Function getSiteConfigContainerPageCustomPropertyByKey source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Get's a custom property bij spcp_key. You should either pass sp_id or scc_id because the siteConfigContainer should be found first | | arguments | | label | name | required | type | default | hint | | key | true | any | null | | | sp_id | false | any | -1 | | | scc_id | false | any | -1 | |
| | return type | any |
|
| getSiteConfigContainers | Public Function getSiteConfigContainers source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns al configured config containers for a company | | arguments | | label | name | required | type | default | hint | | wc_id | true | any | null | |
| | return type | struct |
|
| getSiteCustomProperty | Public Function getSiteCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc returns custom property value | | arguments | | label | name | required | type | default | hint | | scp_id | true | numeric | null | |
| | return type | any |
|
| getSiteDefaultLanguage | Public Function getSiteDefaultLanguage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the default ml_id for a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | string | null | The ID of the website. |
| | return type | struct |
|
| getSiteFromPage | Public Function getSiteFromPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the site_id of a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The ID of the page. |
| | return type | struct |
|
| getSiteLanguages | Public Function getSiteLanguages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets all languages from a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | struct |
|
| getSiteLanguagesComplete | Public Function getSiteLanguagesComplete source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets all languages from a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | struct |
|
| getSitesFromCompany | Public Function getSitesFromCompany source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns a query with all sites direct below the given company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. | | includeInactive | false | boolean | true | Includes inactive websites? |
| | return type | struct |
|
| getSitesFromSiteAdmin | Public Function getSitesFromSiteAdmin source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets all websites from a site administrator. Not the company websites. | | arguments | | label | name | required | type | default | hint | | wu_id | true | numeric | null | The ID of the site administrator. | | getCompany | false | boolean | true | Also return an admin website which is also a company website? | | includeInactive | false | boolean | true | |
| | return type | struct |
|
| getSiteStandardLanguage | Public Function getSiteStandardLanguage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets all information about a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | string | null | The ID, or a list of ID's of the website(s) to get. |
| | return type | struct |
|
| getSiteValues | Public Function getSiteValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the values for one or more websites. | | arguments | | label | name | required | type | default | hint | | site_id_list | true | string | null | The ID(s) of the website(s). | | ml_id | false | numeric | 0 | The ml_id of the website(s). |
| | return type | struct |
|
| getTopLevelPages | Public Function getTopLevelPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of the toplevel pages for a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | struct |
|
| getUnusedlicenses | Public Function getUnusedlicenses source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the amount of website licenses left; -1 is unlimited, -2 undefined. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
|
| getUsedDesignSites | Public Function getUsedDesignSites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the websites which use the website as design. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the website. |
| | return type | struct |
|
| getUseDesignsOfCompany | Public Function getUseDesignsOfCompany source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the designs with can be used for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The id of the company. |
| | return type | struct |
|
| getUseDesignsOfSite | Public Function getUseDesignsOfSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the designs with can be used. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the website. |
| | return type | struct |
|
| 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 |
|
| isSiteAdmin | Public Function isSiteAdmin source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Checks if the given user is a site administtor for the given site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | wu_id | false | numeric | -1 | The ID of the user to check. |
| | return type | boolean |
|
| isSiteUser | Public Function isSiteUser source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Checks if the given user is a valid editor of the given site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | wu_id | false | numeric | -1 | The ID of the user to check. |
| | return type | boolean |
|
| isValidSite | Public Function isValidSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns true or false for the given site_id. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | boolean |
|
| isValidSiteLanguage | Public Function isValidSiteLanguage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Checks if a language is valid for a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | ml_id | true | numeric | null | The ID of the language. |
| | 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 |
|
| removeData | Public Function removeData source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Removes the a data record. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The data_id to remove. |
| | return type | struct |
|
| removeFormTemplate | Public Function removeFormTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes a form template | | arguments | | label | name | required | type | default | hint | | sccft_id | true | numeric | null | |
| | return type | any |
|
| removeImageTemplate | Public Function removeImageTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes an image template | | arguments | | label | name | required | type | default | hint | | sccit_id | true | numeric | null | |
| | return type | any |
|
| removeSiteAdmin | Public Function removeSiteAdmin source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes a site administrator from a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | wu_id_list | true | string | null | The ID(s) of the site administrator(s). |
| | return type | struct |
|
| removeSiteCachedPages | Public Function removeSiteCachedPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes all cached pages of a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | struct |
|
| removeSiteConfigContainer | Public Function removeSiteConfigContainer source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes a site_config_container | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | struct |
|
| removeSiteConfigContainerPageCustomProperty | Public Function removeSiteConfigContainerPageCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc removes a siteConfigContainer page custom property by sccpcp_id | | arguments | | label | name | required | type | default | hint | | sccpcp_id | true | numeric | null | |
| | return type | any |
|
| removeSiteConfigContainersFromCompany | Public Function removeSiteConfigContainersFromCompany source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes all site_config_containers from a company | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | |
| | return type | struct |
|
| removeSiteCustomProperty | Public Function removeSiteCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc removes a custom property by scp_id | | arguments | | label | name | required | type | default | hint | | scp_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 |
|
| saveFormTemplate | Public Function saveFormTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves a new form template for a siteConfigContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | sccft_name | true | any | null | | | sccft_value | true | any | null | | | sccft_description | false | any | | |
| | return type | any |
|
| saveImageTemplate | Public Function saveImageTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves a new image template for a siteConfigContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | sccit_name | true | any | null | | | sccit_width | true | any | null | | | sccit_height | true | any | null | | | sccit_description | false | any | | |
| | return type | any |
|
| saveSiteConfigContainer | Public Function saveSiteConfigContainer source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc adds a configurationContainter | | arguments | | label | name | required | type | default | hint | | scc_name | true | any | null | | | wc_id | true | any | null | | | scc_sharemode | false | any | 0 | |
| | return type | struct |
|
| saveSiteConfigContainerPageCustomProperty | Public Function saveSiteConfigContainerPageCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves a custom property | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | spcp_key | true | any | null | | | spcp_type | true | numeric | null | 1: text, 2: varchar, 3: date, 4: numeric, 6: bit | | spcp_value | true | any | null | | | sccpcp_desc | false | any | | |
| | return type | any |
|
| saveSiteCustomProperty | Public Function saveSiteCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves a custom property for a site | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | | | scp_key | true | any | null | | | scp_type | true | numeric | null | 1: text, 2: varchar, 3: date, 4: numeric, 6: bit | | scp_value | true | any | null | |
| | return type | any |
|
| searchSites | Public Function searchSites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns websites with a search constraint. Searches names and descriptions. | | arguments | | label | name | required | type | default | hint | | site_id_list | true | string | null | The ID(s) of the website. | | search | true | string | null | A string containing the search. |
| | return type | struct |
|
| setData | Public Function setData source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Sets the data of a data_id and a ml_id. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The data_id of the data to set. | | ml_id | true | numeric | null | The ml_id of the data to set. | | data | true | string | null | The data to set. |
| | return type | struct |
|
| setDateTime | Public Function setDateTime source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Updates the datarecord for a date_time value. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The data_id to update. | | date | false | numeric | {ts '2026-09-10 13:15:53'} | |
| | return type | struct |
|
| setDateTimeCF | Public Function setDateTimeCF source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Updates the datarecord for a date_time value. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The data_id to update. | | datetime | false | date | {ts '2026-09-10 13:15:53'} | The Coldfusion formatted date. |
| | return type | struct |
|
| setLicenses | Public Function setLicenses source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Sets the number of website licenses for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. | | licenses | true | numeric | null | The amount of sitelicenses. |
| | return type | struct |
|
| setSiteAllowedObjectTypes | Public Function setSiteAllowedObjectTypes source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Sets the allowed objecttypes for a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | typeQuery | true | query | null | The query with allowed objecttypes. |
| | return type | struct |
|
| setSiteLanguages | Public Function setSiteLanguages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Sets the languages from a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | ml_id_list | true | string | null | The ID(s) of the languages(s). |
| | return type | struct |
|
| setSiteTitle | Public Function setSiteTitle source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Set the site title for the given language | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | the site to set the title for | | title | true | String | null | the new title for the site | | ml_id | true | numeric | null | The language to set the title in, use 0 to set it in all active languages |
| | return type | any |
|
| setSiteValues | Public Function setSiteValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates the site values. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. | | valueStructure | true | struct | null | The structure with all values. | | ml_id | false | numeric | 0 | The structure with all values. |
| | return type | struct |
|
| setTemplatePart | Public Function setTemplatePart source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Sets the values of a template part. | | arguments | | label | name | required | type | default | hint | | stp_id | true | numeric | null | The ID of the template part. | | st_values | true | struct | null | A structure with the values. |
| | return type | struct |
|
| stringWebsitePath | Public Function stringWebsitePath source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Return the OS path to a website | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | string |
|
| 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 |
|
| updateFormTemplate | Public Function updateFormTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates a form template | | arguments | | label | name | required | type | default | hint | | sccft_id | true | numeric | null | | | sccft_name | true | any | null | | | sccft_description | true | any | null | |
| | return type | any |
|
| updateImageTemplate | Public Function updateImageTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates an image template | | arguments | | label | name | required | type | default | hint | | sccit_id | true | numeric | null | | | sccit_width | true | any | null | | | sccit_height | true | any | null | | | sccit_description | true | any | null | |
| | return type | any |
|
| updateSiteConfigContainer | Public Function updateSiteConfigContainer source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves the fields of a configurationContainter | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | scc_name | true | any | null | | | scc_sharemode | true | numeric | null | |
| | return type | struct |
|
| updateSiteConfigContainerPageCustomProperty | Public Function updateSiteConfigContainerPageCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates a custom property | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | spcp_key | true | any | null | | | spcp_value | true | any | null | | | sccpcp_desc | false | any | null | |
| | return type | any |
|
| updateSiteCustomProperty | Public Function updateSiteCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates a custom property | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | | | scp_key | true | any | null | | | scp_value | true | any | null | |
| | return type | any |
|