<cfdirectory>

Handles interactions with directories.

This tag cannot have a body.

This tag is also supported within <cfscript>


		<cfdirectory
    action=list|create|delete|forceDelete|rename|copy|info
    listInfo=string
    storeAcl=object
    storeLocation=string
    type=string
    serverPassword=string
    directory=string
    name=string
    filter=any
    filterDelimiters=string
    mode=string
    sort=string
    newDirectory=string
    destination=string
    recurse=boolean
    nameConflict=string
    createPath=boolean
>

Attribute	Description	Default
action _{string, optional}	edit Defines the action to be taken with directory(ies) specified in directory. list DirectoryList() create DirectoryCreate() delete DirectoryDelete() rename DirectoryRename() copy DirectoryCopy() forcedelete	list
listInfo _{string, optional}	edit all: includes all information in the result set. name: includes only filenames in the result set.
storeAcl _{object, optional}	edit An array of struct where each struct represents a permission or grant. Example: [{email="xxx@yyy.com", permission="full_control"}, {group="all", permission="read"}] _{Alias: acl}
storeLocation _{string, optional}	edit Only used for S3 Resources. The location of the created bucket/object. The location can either be EU,US or US-WEST. The default location is US. _{Alias: storage}
type _{string, optional}	edit file: includes only filenames. dir: includes only directory names. all: includes both filenames and directory names.
serverPassword _{string, optional}	edit Allow you to access filesystem, also when access is denied for your context
directory _{string, required}	edit The name of the directory to perform the action against.
name _{string, optional}	edit Required for action = "list". Ignored by all other actions. Name of output query for directory listing. _{Alias: variable}
filter _{any, optional}	edit Optional for action = "list". Ignored by all other actions. Can be either: a wildcard filter,e.g. "m*" or a UDF/Closure which accepts the file/directory name and returns a Boolean value to indicate whether that item should be included in the result or not.
filterDelimiters _{string, optional}	edit Optional when passing a filter pattern. This value is used as a delimiter for the patterns. Default is the pipe "\|" character.
mode _{string, optional}	edit Used with action = "Create" to define the permissions for a directory on UNIX and Linux platforms. Ignored on Windows. Options correspond to the octal values of the UNIX chmod command. From left to right, permissions are assigned for owner, group, and other.
sort _{string, optional}	edit Optional for action = "list". Ignored by all other actions. The query columns by which to sort the directory listing. Any combination of columns from query output can be specified in comma-separated list. You can specify ASC (ascending) or DESC (descending) as qualifiers for column names. ASC is the default
newDirectory _{string, optional}	edit Required for action = "rename". Ignored by all other actions. The new name of the directory specified in the directory attribute.
destination _{string, optional}	edit Required for action = "copy". Ignored by all other actions. Path of the destination directory. If not an absolute path, it is relative to the source directory.
recurse _{boolean, optional}	edit Whether or not to include the content of any sub-directories
nameConflict _{string, optional}	edit When used with action="copy" the possible values are: Overwrite Error When used with action="create" the possible values are: Error Skip Ignored for all other actions.
createPath _{boolean, optional}	edit true (default), automatically create any parent directories which don't exist false, all the parent directories must already exist or an error will be thrown

Usage Notes

edit

For ACF compatibility, on Unix Systems, the mode column is currently not populated for action="list"

https://luceeserver.atlassian.net/browse/LDEV-2118

Examples

edit

Simple format for cfdirectory

Directory Create

<cfdirectory action="create" directory="path of directory">

Directory List

<cfdirectory action = "list" directory = "pathOfDirectory" name = "list">

Directory Copy

<cfdirectory action = "copy" directory = "/pathOfDirectory" destination = "/pathOfDirector" nameconflict = "Overwrite" recurse = "true">

Directory Rename

<cfdirectory action = "rename" directory = "pathOfDirectory" newDirectory = "renameOfDirectory">

Directory Delete

<cfdirectory action = "Delete" directory = "pathOfDirectory" >

Directory Forcedelete

<cfdirectory action = "forcedelete" directory = "pathOfDirectory" >

Related System Properties / Environment Variables

LUCEE_RESOURCE_CHARSET - Default character set for reading from/writing to various resources (files)
Type: string, Default: system charset