| public |
| calcSize | Public Function calcSize source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Calculates bytes to kb, mb, gb. | | arguments | | label | name | required | type | default | hint | | size | true | numeric | null | The size to recalculate |
| | return type | struct |
|
| calculateDirectoryUsedSpace | Public Function calculateDirectoryUsedSpace source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Calculates the space used by the files in a directory (in bytes). | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The ID of the directory. |
| | return type | struct |
|
| changeLastChangeFile | Public Function changeLastChangeFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Changes the last changed of a file in now and the session user. | | arguments | | label | name | required | type | default | hint | | wf_id | true | numeric | null | The ID of the file. |
| | return type | struct |
|
| checkNumericList | Public Function checkNumericList source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Checks if each element in a list is numeric | | arguments | | label | name | required | type | default | hint | | list | true | string | null | The list to check | | add | false | numeric | null | If a list is empty, then add the add |
| | return type | any |
|
| COMPONENTCACHE | |
| 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 |
|
| copyDirectory | Public Function copyDirectory source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Copies a WIS directory to another directory | | arguments | | label | name | required | type | default | hint | | copy_wfd_id | true | numeric | null | A list of directories to copy. | | wfd_id | true | numeric | null | The directory to copy the directories in. |
| | return type | struct |
|
| copyFile | Public Function copyFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Copies a WIS file to another directory | | arguments | | label | name | required | type | default | hint | | wf_id_list | true | string | null | A list of files to copy. | | wfd_id | true | numeric | null | The directory to copy the files in. |
| | return type | struct |
|
| copyObjects | Public Function copyObjects source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Copies directories and files to another directory | | arguments | | label | name | required | type | default | hint | | wfd_id_list | true | string | null | A list of directories to copy. | | wf_id_list | true | string | null | A list of files to copy. | | wfd_id | true | numeric | null | The directory to copy the objects in. |
| | return type | struct |
|
| createCompanyDisc | Public Function createCompanyDisc source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Creates a disk for a new 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 |
|
| createDirectory | Public Function createDirectory source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Creates a directory in the WIS FS. It checks the rights for the sessionuser. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The ID of the WIS directory where the new directory has to be created. | | wfd_name | true | string | null | The name of the new directory |
| | return type | struct |
|
| createPersonalDisc | Public Function createPersonalDisc source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Creates a disk for a new user | | arguments | | label | name | required | type | default | hint | | wu_id | true | numeric | null | The id of the user |
| | return type | struct |
|
| deleteDirectory | Public Function deleteDirectory source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Removes a directory with content Checks for rights | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory |
| | return type | struct |
|
| deleteFile | Public Function deleteFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Removes a file Checks for rights | | arguments | | label | name | required | type | default | hint | | wf_id | true | numeric | null | The id of the file |
| | return type | struct |
|
| DIRECTORYVALUESCACHE | |
| 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 |
|
| fileSystemSync | Public Function fileSystemSync source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | De directory die gesynchroniseerd moet worden | | sync_dir | true | String | null | De directory waarmee gesynchroniseerd moet worden | | also_sync_subdirs | false | boolean | false | Geeft aan of ook subdirectories meegenomen moeten worden (standaard: geen subdirectories meenemen) | | update_existing | false | boolean | true | Geeft aan of bestanden die nieuwer zijn geupdate moeten worden (standaard: nieuwe versie updaten) | | delete_removed | false | boolean | true | Geeft aan of bestanden die verwijderd zijn ook in wis moeten worden verwijderd(standaard: verwijderen) |
| | return type | any |
|
| 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 |
|
| getAllFileCategories | Public Function getAllFileCategories source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Get all the values of all images which are in the fs | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getAllFileTypes | Public Function getAllFileTypes source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Get all the values of all images which are in the fs | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getAllSubDirectories | Public Function getAllSubDirectories source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns all the directories below a given directory | | arguments | | label | name | required | type | default | hint | | wfd_id_list | true | string | null | The directory id of the directory from which you want to get all the sub directories. This is a list to handle a smart recursion. You need to give one wfd_id. |
| | return type | struct |
|
| getCategoryFromType | Public Function getCategoryFromType source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns the mfc_id for the given mft_id | | arguments | | label | name | required | type | default | hint | | mft_id | true | numeric | null | The mft_id for which to return the mfc_id |
| | return type | struct |
|
| getCompanyDiscs | Public Function getCompanyDiscs source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns all the discs of a company. It includes the companies main disc and the shared discs. | | 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 |
|
| getDirectoriesTo | Public Function getDirectoriesTo source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns a query with all directories above the current. It includes the start dir. | | arguments | | label | name | required | type | default | hint | | above_wfd_id | true | numeric | null | The directory id of the directory from which you want to get all the parent directories. | | bottom_wfd_id | true | numeric | null | The directory id of the directory from which you want to get all the parent directories. | | return_bottom | true | numeric | null | The directory id of the directory from which you want to get all the parent directories. |
| | return type | struct |
|
| getDirectoryByName | Public Function getDirectoryByName source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the id of an existing directory. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory where to search in | | wfd_name | true | string | null | The complete name of the directory. |
| | return type | struct |
|
| getDirectoryGroupRights | Public Function getDirectoryGroupRights source: /usr/local/tomcat/webapps/ROOT/Components/FS/ReadAuthorization.cfc Returns all right properties for a group. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory. | | wg_id | true | numeric | null | The id of the group for which you want to get the rights. |
| | return type | struct |
|
| getDirectoryGroupsRights | Public Function getDirectoryGroupsRights source: /usr/local/tomcat/webapps/ROOT/Components/FS/ReadAuthorization.cfc Returns all group for which rights are defined for a directory. It returns also the right properties. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The wfd_id from wich you want to get the groups. |
| | return type | struct |
|
| getDirectoryUserRights | Public Function getDirectoryUserRights source: /usr/local/tomcat/webapps/ROOT/Components/FS/ReadAuthorization.cfc Returns all right properties for a user. Does intelligent check for administrators who are above the company of the directory. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory. | | wu_id | true | numeric | null | The id of the user for which you want to get the rights. |
| | return type | struct |
|
| getDirectoryUserSessionRights | Public Function getDirectoryUserSessionRights source: /usr/local/tomcat/webapps/ROOT/Components/FS/ReadAuthorization.cfc Returns all right properties for a user | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory. |
| | return type | struct |
|
| getDirectoryValues | Public Function getDirectoryValues source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the properties of the given disks | | arguments | | label | name | required | type | default | hint | | fd_id_list | true | string | null | The list of folders to get the properties of | | dir_img_id | false | any | -1 | The id of the directory image for in the tree. | | verity_img_id | false | any | -1 | The id of the verity image for in the tree. | | wu_id | false | numeric | -1 | Can return the a_read property. | | getEntireCompanyDisk | false | boolean | false | |
| | return type | struct |
|
| getDirsToRoot | Public Function getDirsToRoot source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns a query with all directories above the current. It includes the start dir. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The directory id of the directory from which you want to get all the parent directories. |
| | return type | struct |
|
| getDiscValues | Public Function getDiscValues source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the values of a disc. It returns the language specific words for main disc and personal disk. | | arguments | | label | name | required | type | default | hint | | wfd_id_list | true | string | null | The id list of the discs |
| | return type | struct |
|
| getExtensionFromFileType | Public Function getExtensionFromFileType source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns the extension for the given mft_id | | arguments | | label | name | required | type | default | hint | | mft_id | true | numeric | null | The mft_id |
| | return type | struct |
|
| getFileByName | Public Function getFileByName source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the id of an existing file. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory where to search in | | wf_name | true | string | null | The complete name of the file. |
| | return type | struct |
|
| getFileCustomInfo | Public Function getFileCustomInfo source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the info about the custom names for files. | | arguments | | label | name | required | type | default | hint | | ml_id | true | numeric | null | The ID of the language. |
| | return type | struct |
|
| getFileCustomSelectInfo | Public Function getFileCustomSelectInfo source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the options of a selectfield for users. | | arguments | | label | name | required | type | default | hint | | wcf_id | true | numeric | null | The ID of the field. | | ml_id | true | numeric | null | The ID of the language. |
| | return type | struct |
|
| getFileNameWithoutExtension | Public Function getFileNameWithoutExtension source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns a filename without extension | | arguments | | label | name | required | type | default | hint | | filename | true | string | null | The filename to strip the extension of |
| | return type | string |
|
| getFilePointersTo | Public Function getFilePointersTo source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns all pointers to a file | | arguments | | label | name | required | type | default | hint | | wf_id | true | numeric | null | The id of the file |
| | return type | struct |
|
| getFileProperties | Public Function getFileProperties source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns the properties of a file from the OS, not from the WIS FS, like size, type etc. | | arguments | | label | name | required | type | default | hint | | fileName | true | string | null | The file to insert, this must include the path |
| | return type | struct |
|
| getFilesFromDirectory | Public Function getFilesFromDirectory source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Get all wf_id's of the files in (multiple/a) director(ies/y) | | arguments | | label | name | required | type | default | hint | | wfd_id_list | true | string | null | The id list of the directories | | mftc_id_list | false | string | 0 | The category type | | orderby | false | any | | | | order | false | any | | |
| | return type | struct |
|
| getFileSize | Public Function getFileSize source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc | | arguments | | label | name | required | type | default | hint | | path | true | any | null | |
| | return type | numeric |
|
| getFileTypeFromExtension | Public Function getFileTypeFromExtension source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns the mft_id for the given extension | | arguments | | label | name | required | type | default | hint | | extension | true | string | null | The extension |
| | return type | struct |
|
| getFileTypes | Public Function getFileTypes source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Gets all filetypes. | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getFileTypeValues | Public Function getFileTypeValues source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns the values of a file type. | | arguments | | label | name | required | type | default | hint | | mft_id | true | numeric | null | The id of the file type |
| | return type | struct |
|
| getFileUsage | Public Function getFileUsage source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc | | arguments | | label | name | required | type | default | hint | | wf_id | true | numeric | null | |
| | return type | struct |
|
| getFileValues | Public Function getFileValues source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc | | arguments | | label | name | required | type | default | hint | | wf_id_list | true | string | null | A list of wf_id's | | ml_id | false | numeric | 1 | The ID of the language (used for description). | | getCV | false | boolean | false | Boolean indicating if the custom values should be fetched |
| | return type | struct |
|
| getFileValuesFromDirectory | Public Function getFileValuesFromDirectory source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc | | arguments | | label | name | required | type | default | hint | | wfd_id_list | true | numeric | null | | | ml_id | false | numeric | 1 | | | sort_order | false | string | name_asc | | | wfp_id | false | numeric | -1 | | | wf_id | false | numeric | -1 | |
| | return type | any |
|
| getFileValuesIntern | Public Function getFileValuesIntern source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Get all the values of a list of files | | arguments | | label | name | required | type | default | hint | | wf_id_list | true | string | null | A list of wf_id's | | ml_id | false | numeric | 1 | The ID of the language (used for description). |
| | return type | struct |
|
| getMainDisc | Public Function getMainDisc source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the main disc of a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The id of the company |
| | return type | struct |
|
| getNearestDisc | Public Function getNearestDisc source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the nearest share above a directory, it can the directory itselfs | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The directory to check |
| | return type | struct |
|
| getOSDirectories | Public Function getOSDirectories source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Retrieves all directories below a given path. | | arguments | | label | name | required | type | default | hint | | path | true | string | null | The path to examine. | | recursive | false | boolean | false | Recurse all subdirectories? | | includeGiven | false | boolean | false | Include the given directory? |
| | return type | struct |
|
| getPathToFile | Public Function getPathToFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc | | arguments | | label | name | required | type | default | hint | | wf_id | false | numeric | null | |
| | return type | string |
|
| getPersonalDisc | Public Function getPersonalDisc source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the personal disc of a user. | | arguments | | label | name | required | type | default | hint | | wu_id | true | numeric | null | The id of the user |
| | return type | struct |
|
| getProcessFileForFile | Public Function getProcessFileForFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Get's the file's process file for the given process | | arguments | | label | name | required | type | default | hint | | wf_id | true | string | null | The id's of the files | | pid | true | numeric | null | The process id |
| | return type | struct |
|
| getProcessFilesForFiles | Public Function getProcessFilesForFiles source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Get's the file id's of all the process files in a directory | | arguments | | label | name | required | type | default | hint | | wf_id_list | true | string | null | The id's of the files | | pid | true | numeric | null | The process id |
| | return type | struct |
|
| getQuery | Public Function getQuery source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Allows you to create a query in a cfscript. | | arguments | | label | name | required | type | default | hint | | body | true | string | null | The body of the query |
| | return type | query |
|
| getQueryRecords | Public Function getQueryRecords source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns the specified amount of records. | | arguments | | label | name | required | type | default | hint | | query | true | query | null | The query. | | recordCount | true | numeric | null | The amount of records to return. |
| | return type | query |
|
| getShares | Public Function getShares source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns all shares from above a company and from the company itselfs. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The id of the company |
| | return type | struct |
|
| getSharesAsDisc | Public Function getSharesAsDisc source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns all shares from above a company and from the company itselfs. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The id of the company |
| | return type | struct |
|
| getShareValues | Public Function getShareValues source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Gets all values from a share. | | arguments | | label | name | required | type | default | hint | | wfds_id | true | string | null | The id of the share |
| | return type | struct |
|
| getShareValuesFromDirectories | Public Function getShareValuesFromDirectories source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Gets all values from a share. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | string | null | The id of the directory |
| | return type | struct |
|
| getSubDirectories | Public Function getSubDirectories source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the directories direct below a given directory | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The directory id of the directory from which you want to get the sub directories. | | orderby | false | any | | | | order | false | any | | |
| | return type | struct |
|
| getSubDirectoriesWithValues | Public Function getSubDirectoriesWithValues source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc | | arguments | | label | name | required | type | default | hint | | wfd_id | true | string | null | The list of folders to get the properties of | | dir_img_id | false | any | -1 | The id of the directory image for in the tree. | | verity_img_id | false | any | -1 | The id of the verity image for in the tree. | | wu_id | false | numeric | -1 | Can return the a_read property. | | orderby | false | any | | | | order | false | any | | |
| | return type | struct |
|
| getSumSizeFiles | Public Function getSumSizeFiles source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Sums all the sizes of the files in multiple directories | | arguments | | label | name | required | type | default | hint | | wfd_id | true | string | null | The id list of the directories |
| | return type | struct |
|
| getToNearestDisc | Public Function getToNearestDisc source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns the nearest share above a directory, it can the directory itselfs | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The directory to check | | get_disc | true | boolean | null | Returns the share also? |
| | return type | struct |
|
| getTotalSpace | Public Function getTotalSpace source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns the total space in the FS. | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getUsedSpace | Public Function getUsedSpace source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns the used space in the FS. | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getUsedSpaceForCompany | Public Function getUsedSpaceForCompany source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns the used space for a company in the FS. | | arguments | | label | name | required | type | default | hint | | wc_id | true | string | null | The ID(s) of the company. |
| | return type | struct |
|
| getUserSessionDiscs | Public Function getUserSessionDiscs source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Returns all the discs of the current session user. It includes the companies main disc, the users personal disk and the shared discs. | | arguments | | label | name | required | type | default | hint |
| | 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 |
|
| isExistingDirectory | Public Function isExistingDirectory source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Checks if a directory already exists in a directory. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory where to search in | | wfd_name | true | string | null | The complete name of the directory. |
| | return type | boolean |
|
| isExistingFile | Public Function isExistingFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Checks if a file already exists in a directory. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory where to search in | | wf_name | true | string | null | The complete name of the file. |
| | return type | boolean |
|
| isExistingFileID | Public Function isExistingFileID source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Checks if a file exists. | | arguments | | label | name | required | type | default | hint | | wf_id | true | numeric | null | The id of the file. |
| | return type | boolean |
|
| isSharedDirectory | Public Function isSharedDirectory source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The directory to check |
| | 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 |
|
| moveObjects | Public Function moveObjects source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Moves directories and files to another directory | | arguments | | label | name | required | type | default | hint | | wfd_id_list | true | string | null | A list of directories to move. | | wf_id_list | true | string | null | A list of files to move. | | wfd_id | true | numeric | null | The directory to move the objects in. |
| | return type | struct |
|
| 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 |
|
| removeOSFile | Public Function removeOSFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Removes a file from the OS | | arguments | | label | name | required | type | default | hint | | fileName | true | string | null | The file to remove |
| | return type | struct |
|
| removeTempFilesForFile | Public Function removeTempFilesForFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc removes all temp-files from temp-images folder that are applied for the given file | | arguments | | label | name | required | type | default | hint | | wf_id | true | numeric | null | |
| | return type | any |
|
| renameDirectory | Public Function renameDirectory source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Renames a directory | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory | | wfd_name | true | string | null | The new name of the directory |
| | return type | struct |
|
| renameFile | Public Function renameFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Renames a file. | | arguments | | label | name | required | type | default | hint | | wf_id | true | numeric | null | The ID of the file. | | wf_name | true | string | null | The new name of the file. |
| | return type | struct |
|
| 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 |
|
| searchFile | Public Function searchFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc search files by filename or wf_id | | arguments | | label | name | required | type | default | hint | | searchString | true | any | null | | | wu_id | false | any | -1 | | | maxRows | false | any | | | | ml_id | false | any | 1 | | | wc_id | false | any | -1 | |
| | return type | any |
|
| setDescription | Public Function setDescription source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Sets the description of a file. | | arguments | | label | name | required | type | default | hint | | wf_id | true | numeric | null | The ID of the file. | | ml_id | true | numeric | null | The ID of the language. | | wf_description | true | string | null | The new description of the file. |
| | return type | struct |
|
| stripFileName | Public Function stripFileName source: /usr/local/tomcat/webapps/ROOT/Components/FS/Util.cfc Returns a valid file path. It remove double slashes... | | arguments | | label | name | required | type | default | hint | | fileName | true | string | null | The file name and path |
| | return type | struct |
|
| textToNumber | Public Function textToNumber source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns a number for the english word | | arguments | | label | name | required | type | default | hint | | text | true | any | null | |
| | return type | numeric |
|
| trueFalseFormat | Public Function trueFalseFormat source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc convert cf string to boolean | | arguments | | label | name | required | type | default | hint | | exp | true | any | null | |
| | return type | any |
|
| uniqueListAppend | Public Function uniqueListAppend source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Adds an item to the list if that list does not contain it already. | | arguments | | label | name | required | type | default | hint | | list | true | string | null | The list. | | items | true | string | null | The item(s) to add. | | delimiter | false | string | , | The delimiter (optional). |
| | return type | string |
|
| unZipFile | Public Function unZipFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Unzips a zip file, and places the whole content in the WIS FS. | | arguments | | label | name | required | type | default | hint | | wf_id | true | numeric | null | The ID of the zip file te be extracted. | | wfd_id | true | numeric | null | The ID of the WIS directory where the archive has to be extracted. |
| | return type | struct |
|
| uploadFile | Public Function uploadFile source: /usr/local/tomcat/webapps/ROOT/Components/FS/FileIO.cfc Puts an uploaded file into the db. | | arguments | | label | name | required | type | default | hint | | wfd_id | true | numeric | null | The id of the directory where to put the file in | | cffile | true | struct | null | The complete path to the file. | | overwrite | true | boolean | null | If there exists already a file with the same name, overwrite? | | deleteAfterUpload | false | boolean | true | |
| | return type | struct |
|