File interface
Common file handling functions.
Constants
Name | Location | Description |
|---|---|---|
| FILE_STATUS_TEMPORARY | includes/file.inc | A files status can be one of two values: temporary or permanent. The status for each file Drupal manages is stored in the {files} tables. If the status is temporary Drupal's file garbage collection will delete the file and remove it from the... |
Functions
| Name | Location | Description |
|---|---|---|
| file_check_directory | includes/file.inc | Check that the directory exists and is writable. Directories need to have execute permissions to be considered a directory by FTP servers, etc. |
| file_check_location | includes/file.inc | Check if a file is really located inside $directory. Should be used to make sure a file specified is really located within the directory to prevent exploits. |
| file_check_path | includes/file.inc | Checks path to see if it is a directory, or a dir/file. |
| file_copy | includes/file.inc | Copies a file to a new location. This is a powerful function that in many ways performs like an advanced version of copy). Checks if $source and $dest are valid and readable/writable. Performs a file copy if $source is not equal to $dest. If file... |
| file_create_filename | includes/file.inc | Create a full file path from a directory and filename. If a file with the specified name already exists, an alternative will be used. |
| file_create_path | includes/file.inc | Make sure the destination is a complete path and resides in the file system directory, if it is not prepend the file system directory. |
| file_create_url | includes/file.inc | Create the download path to a file. |
| file_delete | includes/file.inc | Delete a file. |
| file_destination | includes/file.inc | Determines the destination path for a file depending on how replacement of existing files should be handled. |
| file_directory_path | includes/file.inc | Determine the default 'files' directory. |
| file_directory_temp | includes/file.inc | Determine the default temporary directory. |
| file_download | includes/file.inc | Call modules that implement hook_file_download() to find out if a file is accessible and what headers it should be transferred with. If a module returns -1 drupal_access_denied() will be returned. If one or more modules returned headers the download... |
| file_get_mimetype | includes/file.inc | Determine an Internet Media Type, or MIME type from a filename. |
| file_move | includes/file.inc | Moves a file to a new location. Checks if $source and $dest are valid and readable/writable. Performs a file move if $source is not equal to $dest. If file already exists in $dest either the call will error out, replace the file or rename the file... |
| file_munge_filename | includes/file.inc | Munge the filename as needed for security purposes. For instance the file name "exploit.php.pps" would become "exploit.php_.pps". |
| file_save_data | includes/file.inc | Save a string to the specified destination. |
| file_save_upload | includes/file.inc | Saves a file upload to a new location. The source file is validated as a proper upload and handled as such. |
| file_scan_directory | includes/file.inc | Finds all files that match a given mask in a given directory. Directories and files beginning with a period are excluded; this prevents hidden files and directories (such as SVN working directories) from being scanned. |
| file_set_status | includes/file.inc | Set the status of a file. |
| file_space_used | includes/file.inc | Determine total disk space used by a single user or the whole filesystem. |
| file_transfer | includes/file.inc | Transfer file using http to client. Pipes a file through Drupal to the client. |
| file_unmunge_filename | includes/file.inc | Undo the effect of upload_munge_filename(). |
| file_upload_max_size | includes/file.inc | Determine the maximum file upload size by querying the PHP settings. |
| file_validate_extensions | includes/file.inc | Check that the filename ends with an allowed extension. This check is not enforced for the user #1. |
| file_validate_image_resolution | includes/file.inc | If the file is an image verify that its dimensions are within the specified maximum and minimum dimensions. Non-image files will be ignored. |
| file_validate_is_image | includes/file.inc | Check that the file is recognized by image_get_info() as an image. |
| file_validate_name_length | includes/file.inc | Check for files with names longer than we can store in the database. |
| file_validate_size | includes/file.inc | Check that the file's size is below certain limits. This check is not enforced for the user #1. |