File interface
Common file handling functions.
Fields on the file object:
- fid - File ID
- uid - The {users}.uid of the user who is associated with the file.
- filename - Name of the file with no path components. This may differ from the basename of the filepath if the file is renamed to avoid overwriting an existing file.
- filepath - Path of the file relative to Drupal root.
- filemime - The file's MIME type.
- filesize - The size of the file in bytes.
- status - A bitmapped field indicating the status of the file the least sigifigant bit indicates temporary (1) or permanent (0). Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during a cron run.
- timestamp - UNIX timestamp for the date the file was added to the database.
Constants
Name | Location | Description |
|---|---|---|
| FILE_CREATE_DIRECTORY | drupal/includes/file.inc | Flag used by file_check_directory() -- create directory if not present. |
| FILE_DOWNLOADS_PRIVATE | drupal/includes/file.inc | Flag to indicate that the 'private' file download method is enabled. |
| FILE_DOWNLOADS_PUBLIC | drupal/includes/file.inc | Flag to indicate that the 'public' file download method is enabled. |
| FILE_EXISTS_ERROR | drupal/includes/file.inc | Flag for dealing with existing files: Do nothing and return FALSE. |
| FILE_EXISTS_RENAME | drupal/includes/file.inc | Flag for dealing with existing files: Appends number until name is unique. |
| FILE_EXISTS_REPLACE | drupal/includes/file.inc | Flag for dealing with existing files: Replace the existing file. |
| FILE_MODIFY_PERMISSIONS | drupal/includes/file.inc | Flag used by file_check_directory() -- file permissions may be changed. |
| FILE_STATUS_PERMANENT | drupal/includes/file.inc | File status -- File has been permanently saved to the {files} tables. |
| FILE_STATUS_TEMPORARY | drupal/includes/file.inc | File status -- File has been temporarily saved to the {files} tables. |
Functions
| Name | Location | Description |
|---|---|---|
| file_check_directory | drupal/includes/file.inc | Check that the directory exists and is writable. |
| file_check_location | drupal/includes/file.inc | Check if a file is really located inside $directory. |
| file_check_path | drupal/includes/file.inc | Checks path to see if it is a directory, or a directory/file. |
| file_copy | drupal/includes/file.inc | Copy a file to a new location and adds a file record to the database. |
| file_create_filename | drupal/includes/file.inc | Create a full file path from a directory and filename. |
| file_create_path | drupal/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 | drupal/includes/file.inc | Create the download path to a file. |
| file_delete | drupal/includes/file.inc | Delete a file and its database record. |
| file_destination | drupal/includes/file.inc | Determines the destination path for a file depending on how replacement of existing files should be handled. |
| file_directory_path | drupal/includes/file.inc | Determine the default 'files' directory. |
| file_directory_temp | drupal/includes/file.inc | Determine the default temporary directory. |
| file_download | drupal/includes/file.inc | Menu handler for private file transfers. |
| file_get_mimetype | drupal/includes/file.inc | Determine an Internet Media Type, or MIME type from a filename. |
| file_load | drupal/includes/file.inc | Load a file object from the database. |
| file_move | drupal/includes/file.inc | Move a file to a new location and update the file's database entry. |
| file_munge_filename | drupal/includes/file.inc | Munge the filename as needed for security purposes. |
| file_save | drupal/includes/file.inc | Save a file object to the database. |
| file_save_data | drupal/includes/file.inc | Save a string to the specified destination and create a database file entry. |
| file_save_upload | drupal/includes/file.inc | Saves a file upload to a new location. |
| file_scan_directory | drupal/includes/file.inc | Finds all files that match a given mask in a given directory. |
| file_space_used | drupal/includes/file.inc | Determine total disk space used by a single user or the whole filesystem. |
| file_transfer | drupal/includes/file.inc | Transfer file using HTTP to client. Pipes a file through Drupal to the client. |
| file_unmanaged_copy | drupal/includes/file.inc | Copy a file to a new location without calling any hooks or making any changes to the database. |
| file_unmanaged_delete | drupal/includes/file.inc | Delete a file without calling any hooks or making any changes to the database. |
| file_unmanaged_move | drupal/includes/file.inc | Move a file to a new location without calling any hooks or making any changes to the database. |
| file_unmanaged_save_data | drupal/includes/file.inc | Save a string to the specified destination without calling any hooks or making any changes to the database. |
| file_unmunge_filename | drupal/includes/file.inc | Undo the effect of upload_munge_filename(). |
| file_upload_max_size | drupal/includes/file.inc | Determine the maximum file upload size by querying the PHP settings. |
| file_validate | drupal/includes/file.inc | Check that a file meets the criteria specified by the validators. |
| file_validate_extensions | drupal/includes/file.inc | Check that the filename ends with an allowed extension. |
| file_validate_image_resolution | drupal/includes/file.inc | If the file is an image verify that its dimensions are within the specified maximum and minimum dimensions. |
| file_validate_is_image | drupal/includes/file.inc | Check that the file is recognized by image_get_info() as an image. |
| file_validate_name_length | drupal/includes/file.inc | Check for files with names longer than we can store in the database. |
| file_validate_size | drupal/includes/file.inc | Check that the file's size is below certain limits. |