Component (Components.ContentMngt.Style) Style
Only the functions and data members that are accessible from your location are displayed
ExtendsComponents.Result.ReturnStruct
HintCreates style functionality
this
public
addStyle
Public Function addStyle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Creates a new style for a website.
arguments
labelnamerequiredtypedefaulthint
sst_nametruestringnullThe name of the style
sst_descriptiontruestringnullThe description of the style
sst_sharemodetruenumericnullShare the style for other website on the same level or below. 0=no share, 1=neighbours, 2=below, 3=neighbours and below
site_idtruenumericnullThe id of the site. This is the owner of the wbsite.
return typestruct
addStyleClass
Public Function addStyleClass
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Creates a new style class.
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe ID of the style
sstc_fortruenumericnullThe ID of the style
return typestruct
addTableStyle
Public Function addTableStyle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Creates a new style for a table
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe ID of the style
sstt_nametruestringnullThe name of the table style
sstt_descriptiontruestringnullThe description of the table style
return typestruct
changeCustom
Public Function changeCustom
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Changes the custom property of the style.
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe ID of the style
sst_customtruestringnullThe custom style of the style
return typestruct
changeStyle
Public Function changeStyle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Changes the properties of a style.
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe ID of the style
sst_nametruestringnullThe name of the style
sst_descriptiontruestringnullThe description of the style
sst_sharemodetruenumericnullShare the style for other website on the same level or below. 0=no share, 1=neighbours, 2=below, 3=neighbours and below
return typestruct
changeTableStyle
Public Function changeTableStyle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Changes the values of a table style.
arguments
labelnamerequiredtypedefaulthint
sstt_idtruenumericnullThe id of the table style
sstt_nametruestringnullThe name of the table style
sstt_descriptiontruestringnullThe description of the table style
return typestruct
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
colorsChanged
Public Function colorsChanged
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Re-creates all styles again of a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
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
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
getDefaultStyle
Public Function getDefaultStyle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the default style of the website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site
return typeany
getHttpStylePath
Public Function getHttpStylePath
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the URL to the style of a website.
arguments
labelnamerequiredtypedefaulthint
pagetrueanynullThe java page object
sitetrueanynullThe java site object
return typestring
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
getStyleFile
Public Function getStyleFile
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the canonical file name.
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe id of the style
return typestring
getStylePath
Public Function getStylePath
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the path to the style directory of a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestring
getStylePathHttp
Public Function getStylePathHttp
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the URL to the style of a website.
arguments
labelnamerequiredtypedefaulthint
pagePropertiestruequerynullThe properties of the page.
sitePropertiestruequerynullThe properties of the website.
return typestring
getStyleSite
Public Function getStyleSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the ID of the site of a style.
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe ID of the style.
return typestruct
getStylesOfCompany
Public Function getStylesOfCompany
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the styles of a company. Also the shared styles from above.
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe id of the website.
return typestruct
getStylesOfSite
Public Function getStylesOfSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the styles of a website. Also the shared styles from above.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
getStyleValues
Public Function getStyleValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the properties of a style.
arguments
labelnamerequiredtypedefaulthint
sst_id_listtruestringnullThe ID of the style
return typestruct
getTableStylesOfStyle
Public Function getTableStylesOfStyle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the table styles of a style
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe ID of the style.
return typestruct
getTableStyleValues
Public Function getTableStyleValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Returns the values of a table style
arguments
labelnamerequiredtypedefaulthint
sstt_id_listtruestringnullThe ID of the table style.
return typestruct
getUsingPages
Public Function getUsingPages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Gets all the pages that use the given stylesheet
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe id of the style sheet
return typestruct
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
isStyleInUse
Public Function isStyleInUse
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Checks if the style is in use by some pages.
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe ID of the style
return typeboolean
isTableStyleInUse
Public Function isTableStyleInUse
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Checks if the table style is in use. Not used at the moment.
arguments
labelnamerequiredtypedefaulthint
sstt_idtruenumericnullThe id of the table style
return typeboolean
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
removeSiteStyles
Public Function removeSiteStyles
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Removes all styles from a website
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the site. This is the owner of the wbsite.
return typestruct
removeStyle
Public Function removeStyle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Removes a style from the system. Can only remove if the style is not in use at the moment.
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe ID of the style
return typestruct
removeStyleClass
Public Function removeStyleClass
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
arguments
labelnamerequiredtypedefaulthint
return typestruct
removeTableStyle
Public Function removeTableStyle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Changes the values of a table style.
arguments
labelnamerequiredtypedefaulthint
sstt_idtruenumericnullThe id of the table style
return typestruct
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
searchStyles
Public Function searchStyles
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Search through a list of styles. Searches in the name and the description.
arguments
labelnamerequiredtypedefaulthint
sst_id_listtruestringnullThe list of the styles to search in.
searchtruestringnullThe string to search for.
return typestruct
setDefaultStyle
Public Function setDefaultStyle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Sets the default style of the website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site
sst_idtruenumericnullThe ID of the style
return typeany
SITEIO
Component (Components.contentMngt.siteIO)
Only the functions and data members that are accessible from your location are displayed
ExtendsComponents.WIS.DataIO
HintThis component handles all site IO.
this
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
labelnamerequiredtypedefaulthint
data_typetruestringnullThe 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.
dataQueryfalsequerynullA query to fill the new data record set.
return typestruct
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
labelnamerequiredtypedefaulthint
ml_idtruenumericnullThe ml_id of the new language.
return typestruct
addSite
Public Function addSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Adds a website.
arguments
labelnamerequiredtypedefaulthint
valueStructuretruestructnullThe siteproperties and their values.
languagestruestringnullThe languages the site must be available for.
return typestruct
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
labelnamerequiredtypedefaulthint
site_id_listtruestringnullThe ID(s) of the website.
wu_id_listtruestringnullThe ID(s) of the administrator.
return typestruct
addSiteValues
Public Function addSiteValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Adds the standard values for a website.
arguments
labelnamerequiredtypedefaulthint
valueStructuretruestructnullThe site properties and their values.
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
nametruestringnullThe name of the new template
return typestruct
addTemplatePart
Public Function addTemplatePart
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Adds a template part in a template.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe ID of the template.
stp_parent_idtruenumericnullThe id of the parent part. 0 is a main part.
return typestruct
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
labelnamerequiredtypedefaulthint
definitiontruequerynullA 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.
repairfalsebooleanfalseWhat has the function to do, repair or only report? Default is no, thus report.
return typestruct
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
compileTemplate
Public Function compileTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Compiles a cfm template
arguments
labelnamerequiredtypedefaulthint
templateNametruestringnullThe name of the template to compile
siteNametruestringnullThe name of the website
replaceSpecialCharacterstruebooleannullReplace characters in the compiled template
dateMaskfalsestringnullThe datemask to use. Can be used when it cannot be retrieved from the session.
timeMaskfalsestringnullThe timemask to use. Can be used when it cannot be retrieved from the session.
return typestring
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
countCompanySites
Public Function countCompanySites
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the number of sites for a company.
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
createComponent
Public Function createComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
return typeany
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
labelnamerequiredtypedefaulthint
return typeany
createSelectDate
Public Function createSelectDate
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Generates the select clause for a datetime
arguments
labelnamerequiredtypedefaulthint
tablePrefixtruestringnullThe prefix of the table
formattruestringnullThe format of the date
astruestringnullThe select clause AS.
return typestruct
deleteSite
Public Function deleteSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website
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
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
filterQuerytruequerynullThe query to be filtered.
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
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
wc_idtruenumericnullThe ID of the company.
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
return typestruct
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
labelnamerequiredtypedefaulthint
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
getCompanyFromSite
Public Function getCompanyFromSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the wc_id of the website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
getComponent
Public Function getComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
componentNametruestringnull
return typeany
getCustomPropertiesForSite
Public Function getCustomPropertiesForSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
returns all custom properties for the site
arguments
labelnamerequiredtypedefaulthint
site_idtrueanynull
return typeany
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
labelnamerequiredtypedefaulthint
site_idtruenumericnull
scp_keytrueanynull
defaultfalseany
objectfalseanyfalse
return typeany
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
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data.
ml_idtruenumericnullThe ml_id of the data to get.
return typestruct
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
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data.
return typestruct
getDataNumeric
Public Function getDataNumeric
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets numeric data.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe ID of the data.
return typestruct
getDataReal
Public Function getDataReal
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets real data.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe ID of the data.
return typestruct
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
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data.
ml_idtruenumericnullThe ml_id of the data to get.
return typestruct
getDataType
Public Function getDataType
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets the data type of the given data_id
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnull
return typestruct
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
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data.
ml_idtruenumericnullThe ml_id of the data to get.
return typestruct
getDateTime
Public Function getDateTime
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets the datetime.
arguments
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data datetime.
dateFormatfalsestringGives a CF formatted type, if not defined it returns a cftime format.
timeFormatfalsestringGives a CF formatted type, if not defined it returns a cftime format.
return typestruct
getFormTemplates
Public Function getFormTemplates
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns all form templates for a siteConfigContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typeany
getImageTemplates
Public Function getImageTemplates
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns all image templates for a siteConfigContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typeany
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company from wich you want to know the number of licenses.
return typestruct
getProtocolToUse
Public Function getProtocolToUse
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the protocol to use for this website.
arguments
labelnamerequiredtypedefaulthint
sitePropertiestruequerynull
return typestring
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
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typestruct
getSite
Public Function getSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Gets a site.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
return typeany
getSiteAdmins
Public Function getSiteAdmins
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Get all admins of a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website from wich you want the site administrators.
return typestruct
getSiteConfigContainer
Public Function getSiteConfigContainer
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the configurationContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typestruct
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
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typeany
getSiteConfigContainerPageCustomProperty
Public Function getSiteConfigContainerPageCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Get's a custom property bij sccpcp_id
arguments
labelnamerequiredtypedefaulthint
sccpcp_idtruenumericnull
return typeany
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
labelnamerequiredtypedefaulthint
keytrueanynull
sp_idfalseany-1
scc_idfalseany-1
return typeany
getSiteConfigContainers
Public Function getSiteConfigContainers
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns al configured config containers for a company
arguments
labelnamerequiredtypedefaulthint
wc_idtrueanynull
return typestruct
getSiteCustomProperty
Public Function getSiteCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
returns custom property value
arguments
labelnamerequiredtypedefaulthint
scp_idtruenumericnull
return typeany
getSiteDefaultLanguage
Public Function getSiteDefaultLanguage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the default ml_id for a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruestringnullThe ID of the website.
return typestruct
getSiteFromPage
Public Function getSiteFromPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the site_id of a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
return typestruct
getSiteLanguages
Public Function getSiteLanguages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Gets all languages from a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typestruct
getSiteLanguagesComplete
Public Function getSiteLanguagesComplete
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Gets all languages from a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
includeInactivefalsebooleantrueIncludes inactive websites?
return typestruct
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
labelnamerequiredtypedefaulthint
wu_idtruenumericnullThe ID of the site administrator.
getCompanyfalsebooleantrueAlso return an admin website which is also a company website?
includeInactivefalsebooleantrue
return typestruct
getSiteStandardLanguage
Public Function getSiteStandardLanguage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Gets all information about a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruestringnullThe ID, or a list of ID's of the website(s) to get.
return typestruct
getSiteValues
Public Function getSiteValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the values for one or more websites.
arguments
labelnamerequiredtypedefaulthint
site_id_listtruestringnullThe ID(s) of the website(s).
ml_idfalsenumeric0The ml_id of the website(s).
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
getUsedDesignSites
Public Function getUsedDesignSites
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the websites which use the website as design.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe id of the company.
return typestruct
getUseDesignsOfSite
Public Function getUseDesignsOfSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the designs with can be used.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
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
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
wu_idfalsenumeric-1The ID of the user to check.
return typeboolean
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
wu_idfalsenumeric-1The ID of the user to check.
return typeboolean
isValidSite
Public Function isValidSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns true or false for the given site_id.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typeboolean
isValidSiteLanguage
Public Function isValidSiteLanguage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Checks if a language is valid for a site.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
ml_idtruenumericnullThe ID of the language.
return typeboolean
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
removeData
Public Function removeData
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Removes the a data record.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id to remove.
return typestruct
removeFormTemplate
Public Function removeFormTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes a form template
arguments
labelnamerequiredtypedefaulthint
sccft_idtruenumericnull
return typeany
removeImageTemplate
Public Function removeImageTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes an image template
arguments
labelnamerequiredtypedefaulthint
sccit_idtruenumericnull
return typeany
removeSiteAdmin
Public Function removeSiteAdmin
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes a site administrator from a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
wu_id_listtruestringnullThe ID(s) of the site administrator(s).
return typestruct
removeSiteCachedPages
Public Function removeSiteCachedPages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes all cached pages of a site.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
return typestruct
removeSiteConfigContainer
Public Function removeSiteConfigContainer
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes a site_config_container
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typestruct
removeSiteConfigContainerPageCustomProperty
Public Function removeSiteConfigContainerPageCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
removes a siteConfigContainer page custom property by sccpcp_id
arguments
labelnamerequiredtypedefaulthint
sccpcp_idtruenumericnull
return typeany
removeSiteConfigContainersFromCompany
Public Function removeSiteConfigContainersFromCompany
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes all site_config_containers from a company
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnull
return typestruct
removeSiteCustomProperty
Public Function removeSiteCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
removes a custom property by scp_id
arguments
labelnamerequiredtypedefaulthint
scp_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
saveFormTemplate
Public Function saveFormTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves a new form template for a siteConfigContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
sccft_nametrueanynull
sccft_valuetrueanynull
sccft_descriptionfalseany
return typeany
saveImageTemplate
Public Function saveImageTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves a new image template for a siteConfigContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
sccit_nametrueanynull
sccit_widthtrueanynull
sccit_heighttrueanynull
sccit_descriptionfalseany
return typeany
saveSiteConfigContainer
Public Function saveSiteConfigContainer
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
adds a configurationContainter
arguments
labelnamerequiredtypedefaulthint
scc_nametrueanynull
wc_idtrueanynull
scc_sharemodefalseany0
return typestruct
saveSiteConfigContainerPageCustomProperty
Public Function saveSiteConfigContainerPageCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves a custom property
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
spcp_keytrueanynull
spcp_typetruenumericnull1: text, 2: varchar, 3: date, 4: numeric, 6: bit
spcp_valuetrueanynull
sccpcp_descfalseany
return typeany
saveSiteCustomProperty
Public Function saveSiteCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves a custom property for a site
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnull
scp_keytrueanynull
scp_typetruenumericnull1: text, 2: varchar, 3: date, 4: numeric, 6: bit
scp_valuetrueanynull
return typeany
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
labelnamerequiredtypedefaulthint
site_id_listtruestringnullThe ID(s) of the website.
searchtruestringnullA string containing the search.
return typestruct
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
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id of the data to set.
ml_idtruenumericnullThe ml_id of the data to set.
datatruestringnullThe data to set.
return typestruct
setDateTime
Public Function setDateTime
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Updates the datarecord for a date_time value.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id to update.
datefalsenumeric{ts '2026-09-10 13:15:53'}
return typestruct
setDateTimeCF
Public Function setDateTimeCF
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Updates the datarecord for a date_time value.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id to update.
datetimefalsedate{ts '2026-09-10 13:15:53'}The Coldfusion formatted date.
return typestruct
setLicenses
Public Function setLicenses
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Sets the number of website licenses for a company.
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
licensestruenumericnullThe amount of sitelicenses.
return typestruct
setSiteAllowedObjectTypes
Public Function setSiteAllowedObjectTypes
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Sets the allowed objecttypes for a site.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
typeQuerytruequerynullThe query with allowed objecttypes.
return typestruct
setSiteLanguages
Public Function setSiteLanguages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Sets the languages from a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
ml_id_listtruestringnullThe ID(s) of the languages(s).
return typestruct
setSiteTitle
Public Function setSiteTitle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Set the site title for the given language
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullthe site to set the title for
titletrueStringnullthe new title for the site
ml_idtruenumericnullThe language to set the title in, use 0 to set it in all active languages
return typeany
setSiteValues
Public Function setSiteValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates the site values.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
valueStructuretruestructnullThe structure with all values.
ml_idfalsenumeric0The structure with all values.
return typestruct
setTemplatePart
Public Function setTemplatePart
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Sets the values of a template part.
arguments
labelnamerequiredtypedefaulthint
stp_idtruenumericnullThe ID of the template part.
st_valuestruestructnullA structure with the values.
return typestruct
stringWebsitePath
Public Function stringWebsitePath
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Return the OS path to a website
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
return typestring
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
updateFormTemplate
Public Function updateFormTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates a form template
arguments
labelnamerequiredtypedefaulthint
sccft_idtruenumericnull
sccft_nametrueanynull
sccft_descriptiontrueanynull
return typeany
updateImageTemplate
Public Function updateImageTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates an image template
arguments
labelnamerequiredtypedefaulthint
sccit_idtruenumericnull
sccit_widthtrueanynull
sccit_heighttrueanynull
sccit_descriptiontrueanynull
return typeany
updateSiteConfigContainer
Public Function updateSiteConfigContainer
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves the fields of a configurationContainter
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
scc_nametrueanynull
scc_sharemodetruenumericnull
return typestruct
updateSiteConfigContainerPageCustomProperty
Public Function updateSiteConfigContainerPageCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates a custom property
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
spcp_keytrueanynull
spcp_valuetrueanynull
sccpcp_descfalseanynull
return typeany
updateSiteCustomProperty
Public Function updateSiteCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates a custom property
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnull
scp_keytrueanynull
scp_valuetrueanynull
return typeany
private
addSiteAdminPrivate
Private Function addSiteAdminPrivate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Creates a site administrator.
arguments
labelnamerequiredtypedefaulthint
site_id_listtruestringnullThe ID(s) of the website.
wu_id_listtruestringnullThe ID(s) of the administrator.
return typestruct
createSQLLTTen
Private Function createSQLLTTen
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Creates a SQL statement to Return a zero before a number when the number is less then 10.
arguments
labelnamerequiredtypedefaulthint
columntruestringnullThe SQL column name
return typestruct
getTableName
Private Function getTableName
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets the table name where the data is stored.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id of the data.
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
styleChanged
Private Function styleChanged
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/Style.cfc
Creates a new css stylesheet
arguments
labelnamerequiredtypedefaulthint
sst_idtruenumericnullThe ID of the style
return typestruct