File interface in Drupal 4
Same name and namespace in other branches
- 8 core/includes/file.inc \file
- 5 includes/file.inc \file
- 6 includes/file.inc \file
- 7 includes/file.inc \file
- 9 core/includes/file.inc \file
Common file handling functions.
File
- includes/
file.inc, line 14 - API for handling file uploads and server file management.
Functions
Name |
Location | Description |
|---|---|---|
| file_check_directory |
includes/ |
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/ |
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/ |
Checks path to see if it is a directory, or a dir/file. |
| file_check_upload |
includes/ |
Check if $source is a valid file upload. If so, move the file to Drupal's tmp dir and return it as an object. |
| file_copy |
includes/ |
Copies a file to a new location. This is a powerful function that in many ways performs like an advanced version of copy(). |
| file_create_filename |
includes/ |
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/ |
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/ |
Create the download path to a file. |
| file_delete |
includes/ |
Delete a file. |
| file_directory_path |
includes/ |
Determine the default 'files' directory. |
| file_directory_temp |
includes/ |
Determine the default temporary directory. |
| file_download |
includes/ |
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_move |
includes/ |
Moves a file to a new location. |
| file_save_data |
includes/ |
Save a string to the specified destination. |
| file_save_upload |
includes/ |
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/ |
Finds all files that match a given mask in a given directory. Directories and files beginning with a period are excluded. |
| file_transfer |
includes/ |
Transfer file using http to client. Pipes a file through Drupal to the client. |
| file_upload_max_size |
includes/ |
Determine the maximum file upload size by querying the PHP settings. |
| _file_convert_to_mb |
includes/ |
Helper function for file_upload_max_size(). |
Constants
|
Name |
Location | Description |
|---|---|---|
| FILE_CREATE_DIRECTORY |
includes/ |
|
| FILE_DOWNLOADS_PRIVATE |
includes/ |
|
| FILE_DOWNLOADS_PUBLIC |
includes/ |
|
| FILE_EXISTS_ERROR |
includes/ |
|
| FILE_EXISTS_RENAME |
includes/ |
|
| FILE_EXISTS_REPLACE |
includes/ |
|
| FILE_MODIFY_PERMISSIONS |
includes/ |