Component (Components.ContentMngt.SeboEngine)
Only the functions and data members that are accessible from your location are displayed
ExtendsComponents.Result.ReturnStruct
HintProvides functions for searching websitecontent.
this
public
checkNumericList
Public Function checkNumericList
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Checks if each element in a list is numeric
arguments
labelnamerequiredtypedefaulthint
listtruestringnullThe list to check
addfalsenumericnullIf a list is empty, then add the add
return typeany
COMPONENTCACHE
Struct
concatQuery
Public Function concatQuery
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Concats two queries, and returns one query
arguments
labelnamerequiredtypedefaulthint
query1truequerynullThe first query.
query2truequerynullThe second query.
columnListfalsestring*If you want to select only some columns in stead of of all columns. Usefull if you want to concat queries with different columns.
return typequery
createCatalog
Public Function createCatalog
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Creates a searchable index for a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
createComponent
Public Function createComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
return typeany
deleteCatalog
Public Function deleteCatalog
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Deletes a website catalog
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
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
getAllCatalogsOfSite
Public Function getAllCatalogsOfSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Returns all catalogs which are defined for a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
getCatalogValues
Public Function getCatalogValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Returns the values of a catalog
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
ml_idtruenumericnullThe id of the language.
return typestruct
getComponent
Public Function getComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
componentNametruestringnull
return typeany
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
getSearchSuggestions
Public Function getSearchSuggestions
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Returns search suggestions
arguments
labelnamerequiredtypedefaulthint
searchtruestringnullThe search string
site_idtruenumericnullThe ID of the website.
ml_idtruenumericnullThe ID of the language.
return typeany
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
isSearchableWebsite
Public Function isSearchableWebsite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Checks wether a website is searchable.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
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
removeTags
Public Function removeTags
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
arguments
labelnamerequiredtypedefaulthint
htmltruestringnull
return typestring
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
searchCollectionContent
Public Function searchCollectionContent
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Searches the content of a website.
arguments
labelnamerequiredtypedefaulthint
wfv_idfalsenumericnullThe ID of the collection.
ml_idtruenumericnullThe ID of the language.
wc_idtruenumericnullThe ID of the language.
searchtruestringnullThe search string.
startIndexfalsenumeric0Startindex
itemsPerPagefalsenumeric10Number of items per page
customfalseStringCustom search parameters
return typeany
searchNext
Public Function searchNext
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Searches the content of a website.
arguments
labelnamerequiredtypedefaulthint
searchIDtrueStringnullThe ID of the search.
return typeany
searchPrevious
Public Function searchPrevious
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Searches the content of a website.
arguments
labelnamerequiredtypedefaulthint
searchIDtrueStringnullThe ID of the search.
return typeany
searchSiteContent
Public Function searchSiteContent
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Searches the content of a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
ml_idtruenumericnullThe ID of the language.
wc_idtruenumericnullThe ID of the language.
searchtruestringnullThe search string.
itemsPerPagefalsenumeric10Number of items per page
customfalseStringCustom search parameters
return typeany
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
updateActiveSiteCatalogs
Public Function updateActiveSiteCatalogs
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Updates the catalogs of active websites
arguments
labelnamerequiredtypedefaulthint
return typestruct
updateCatalog
Public Function updateCatalog
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Updates the catalog of a website
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
private
createCatalogForLanguage
Private Function createCatalogForLanguage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Creates a website catalog for a specified language
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
ml_idtruenumericnullThe id of the language.
return typestruct
createUrlForPage
Private Function createUrlForPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page.
ml_idtruenumericnullThe id of the language.
return typestring
deleteCatalogForLanguage
Private Function deleteCatalogForLanguage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Deletes a website catalog for a specified language
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
ml_idtruenumericnullThe id of the language.
return typestruct
getActiveSiteCatalogs
Private Function getActiveSiteCatalogs
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Returns active catalogs.
arguments
labelnamerequiredtypedefaulthint
return typestruct
getAllCatalogs
Private Function getAllCatalogs
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Returns all catalogs which are defined.
arguments
labelnamerequiredtypedefaulthint
return typestruct
getAllCatalogsToCreate
Private Function getAllCatalogsToCreate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Returns all active site catalogs which are not defined(happens when a language is added for a website, after the creation of the catalog).
arguments
labelnamerequiredtypedefaulthint
return typestruct
getAllCatalogsToCreateOfSite
Private Function getAllCatalogsToCreateOfSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Returns all catalogs which are not defined for a website(happens when a language is added for a website, after the creation of the catalog).
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
getLanguageCatalogs
Private Function getLanguageCatalogs
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Returns the catalogs for every language of a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
getSPIDFromKey
Private Function getSPIDFromKey
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
arguments
labelnamerequiredtypedefaulthint
keytruestringnull
return typestruct
getSystemIDFromKey
Private Function getSystemIDFromKey
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
arguments
labelnamerequiredtypedefaulthint
keytruestringnull
return typestruct
getVerityCollectionName
Private Function getVerityCollectionName
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Returns the CF-name of the verity collection.
arguments
labelnamerequiredtypedefaulthint
wfv_idtruenumericnullThe ID of the collection.
return typestring
resultSetToString
Private Function resultSetToString
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Pastes the contents from a JDCResultSets columns into one string.
arguments
labelnamerequiredtypedefaulthint
resultSettrueanynullThe JDCResultSet.
return typestring
stringCatalogName
Private Function stringCatalogName
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Gives the name of a catalog. Thus the name of the verity collection.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
ml_idtruenumericnullThe id of the language.
return typestring
updateCatalogForLanguage
Private Function updateCatalogForLanguage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Updates the catalog for a given website and language.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
ml_idtruenumericnullThe id of the language.
return typestruct
updateCatalogForLanguageGateways
Private Function updateCatalogForLanguageGateways
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Updates gatewayitems in a searchcatalog.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
ml_idtruenumericnullThe ID of the language.
return typestruct
updateCatalogForLanguagePages
Private Function updateCatalogForLanguagePages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
ml_idtruenumericnullThe id of the language.
return typestruct
xmlToString
Private Function xmlToString
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SeboEngine.cfc
Gets the data from a xml document.
arguments
labelnamerequiredtypedefaulthint
xmlDocfalseanynull
return typestring