File interface
Common file handling functions.
File
- drupal-6.x/
includes/ file.inc, line 8 - API for handling file uploads and server file management.
Functions
Name |
Location | Description |
|---|---|---|
| file_check_directory |
drupal-6.x/ |
Checks whether a directory exists and is writable. |
| file_check_location |
drupal-6.x/ |
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 |
drupal-6.x/ |
Checks path to see if it is a directory, or a dir/file. |
| file_copy |
drupal-6.x/ |
Copies a file to a new location. |
| file_create_filename |
drupal-6.x/ |
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_htaccess |
drupal-6.x/ |
Creates a .htaccess file in the given directory. |
| file_create_path |
drupal-6.x/ |
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 |
drupal-6.x/ |
Create the download path to a file. |
| file_delete |
drupal-6.x/ |
Delete a file. |
| file_destination |
drupal-6.x/ |
Determines the destination path for a file depending on how replacement of existing files should be handled. |
| file_directory_path |
drupal-6.x/ |
Determine the default 'files' directory. |
| file_directory_temp |
drupal-6.x/ |
Determine the default temporary directory. |
| file_download |
drupal-6.x/ |
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 |
drupal-6.x/ |
Determine an Internet Media Type, or MIME type from a filename. |
| file_htaccess_lines |
drupal-6.x/ |
Returns the standard .htaccess lines that Drupal writes to file directories. |
| file_move |
drupal-6.x/ |
Moves a file to a new location. |
| file_munge_filename |
drupal-6.x/ |
Modify a filename as needed for security purposes. |
| file_save_data |
drupal-6.x/ |
Save a string to the specified destination. |
| file_save_upload |
drupal-6.x/ |
Saves a file upload to a new location. |
| file_scan_directory |
drupal-6.x/ |
Finds all files that match a given mask in a given directory. |
| file_set_status |
drupal-6.x/ |
Set the status of a file. |
| file_space_used |
drupal-6.x/ |
Determine total disk space used by a single user or the whole filesystem. |
| file_transfer |
drupal-6.x/ |
Transfer file using http to client. Pipes a file through Drupal to the client. |
| file_unmunge_filename |
drupal-6.x/ |
Undo the effect of upload_munge_filename(). |
| file_upload_max_size |
drupal-6.x/ |
Determine the maximum file upload size by querying the PHP settings. |
| file_validate_extensions |
drupal-6.x/ |
Check that the filename ends with an allowed extension. This check is not enforced for the user #1. |
| file_validate_image_resolution |
drupal-6.x/ |
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 |
drupal-6.x/ |
Check that the file is recognized by image_get_info() as an image. |
| file_validate_name_length |
drupal-6.x/ |
Check for files with names longer than we can store in the database. |
| file_validate_size |
drupal-6.x/ |
Check that the file's size is below certain limits. This check is not enforced for the user #1. |
Constants
|
Name |
Location | Description |
|---|---|---|
| FILE_CREATE_DIRECTORY |
drupal-6.x/ |
|
| FILE_DOWNLOADS_PRIVATE |
drupal-6.x/ |
|
| FILE_DOWNLOADS_PUBLIC |
drupal-6.x/ |
|
| FILE_EXISTS_ERROR |
drupal-6.x/ |
|
| FILE_EXISTS_RENAME |
drupal-6.x/ |
|
| FILE_EXISTS_REPLACE |
drupal-6.x/ |
|
| FILE_MODIFY_PERMISSIONS |
drupal-6.x/ |
|
| FILE_STATUS_PERMANENT |
drupal-6.x/ |
|
| FILE_STATUS_TEMPORARY |
drupal-6.x/ |
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… |