File interface

drupal
1. drupal6
2. drupal7

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 first 8 bits are reserved for Drupal core. The least sigifigant bit indicates temporary (0) or permanent (1). Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during cron runs.
timestamp - UNIX timestamp for the date the file was added to the database.

Funktionen & Methoden

Name	Beschreibung
drupal_chmod	Set the permissions on a file or directory.
file_check_directory	Check that the directory exists and is writable.
file_check_location	Check if a file is really located inside $directory.
file_check_path	Checks path to see if it is a directory, or a directory/file.
file_copy	Copy a file to a new location and adds a file record to the database.
file_create_filename	Create a full file path from a directory and filename.
file_create_path	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	Create the download path to a file.
file_delete	Delete a file and its database record.
file_destination	Determines the destination path for a file depending on how replacement of existing files should be handled.
file_directory_path	Determine the default 'files' directory.
file_directory_temp	Determine the default temporary directory.
file_download	Menu handler for private file transfers.
file_get_mimetype	Determine an Internet Media Type, or MIME type from a filename.
file_load	Load a file object from the database.
file_load_multiple	Load file objects from the database.
file_move	Move a file to a new location and update the file's database entry.
file_munge_filename	Munge the filename as needed for security purposes.
file_save	Save a file object to the database.
file_save_data	Save a string to the specified destination and create a database file entry.
file_save_upload	Saves a file upload to a new location.
file_scan_directory	Finds all files that match a given mask in a given directory.
file_space_used	Determine total disk space used by a single user or the whole filesystem.
file_transfer	Transfer file using HTTP to client. Pipes a file through Drupal to the client.
file_unmanaged_copy	Copy a file to a new location without calling any hooks or making any changes to the database.
file_unmanaged_delete	Delete a file without calling any hooks or making any changes to the database.
file_unmanaged_delete_recursive	Recursively delete all files and directories in the specified filepath.
file_unmanaged_move	Move a file to a new location without calling any hooks or making any changes to the database.
file_unmanaged_save_data	Save a string to the specified destination without calling any hooks or making any changes to the database.
file_unmunge_filename	Undo the effect of upload_munge_filename().
file_upload_max_size	Determine the maximum file upload size by querying the PHP settings.
file_validate	Check that a file meets the criteria specified by the validators.
file_validate_extensions	Check that the filename ends with an allowed extension.
file_validate_image_resolution	If the file is an image verify that its dimensions are within the specified maximum and minimum dimensions.
file_validate_is_image	Check that the file is recognized by image_get_info() as an image.
file_validate_name_length	Check for files with names longer than we can store in the database.
file_validate_size	Check that the file's size is below certain limits.

Konstanten

Name	Beschreibung
FILE_CREATE_DIRECTORY	Flag used by file_check_directory() -- create directory if not present.
FILE_DOWNLOADS_PRIVATE	Flag to indicate that the 'private' file download method is enabled.
FILE_DOWNLOADS_PUBLIC	Flag to indicate that the 'public' file download method is enabled.
FILE_EXISTS_ERROR	Flag for dealing with existing files: Do nothing and return FALSE.
FILE_EXISTS_RENAME	Flag for dealing with existing files: Appends number until name is unique.
FILE_EXISTS_REPLACE	Flag for dealing with existing files: Replace the existing file.
FILE_MODIFY_PERMISSIONS	Flag used by file_check_directory() -- file permissions may be changed.
FILE_STATUS_PERMANENT	File status -- This bit in the status indicates that the file is permanent and should not be deleted during file garbage collection process. Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during cron runs.

includes/file.inc, line 9

DrupalAPI.de

API Seiten

drupal7 durchsuchen

Nützliche Verweise

File interface

Funktionen & Methoden

Konstanten

Kommentare

Kommentar hinzufügen

Kommentar hinzufügen