You are here

Home » API reference » Zircon Profile 8 » file.inc

File interface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/includes/file.inc \file

Common file handling functions.

Fields on the file entity:

  • 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.
  • uri: URI of the file.
  • 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 significant bit indicates temporary (0) or permanent (1). Temporary files will be removed during cron runs if they are older than the configuration value "system.file.temporary_maximum_age", and if clean-up is enabled. Permanent files will not be removed.
  • timestamp: UNIX timestamp for the date the file was added to the database.

File

core/includes/file.inc, line 32
API for handling file uploads and server file management.

Functions

Namesort descending Location Description
drupal_basename Deprecated core/includes/file.inc Gets the filename from a given path.
drupal_chmod Deprecated core/includes/file.inc Sets the permissions on a file or directory.
drupal_dirname Deprecated core/includes/file.inc Gets the name of the directory from a given path.
drupal_mkdir Deprecated core/includes/file.inc Creates a directory, optionally creating missing components in the path to the directory.
drupal_move_uploaded_file Deprecated core/includes/file.inc Moves an uploaded file to a new location.
drupal_realpath Deprecated core/includes/file.inc Resolves the absolute filepath of a local URI or filepath.
drupal_rmdir Deprecated core/includes/file.inc Removes a directory.
drupal_tempnam Deprecated core/includes/file.inc Creates a file with a unique filename in the specified directory.
drupal_unlink Deprecated core/includes/file.inc Deletes a file.
file_build_uri core/includes/file.inc Constructs a URI to Drupal's default files location given a relative path.
file_create_filename core/includes/file.inc Creates a full file path from a directory and filename.
file_create_url core/includes/file.inc Creates a web-accessible URL for a stream to an external or local file.
file_default_scheme core/includes/file.inc Gets the default file stream implementation.
file_delete core/includes/file.inc Deletes a file and its database record.
file_delete_multiple core/includes/file.inc Deletes files.
file_destination core/includes/file.inc Determines the destination path for a file.
file_directory_os_temp core/includes/file.inc Discovers a writable system-appropriate temporary directory.
file_directory_temp core/includes/file.inc Gets and sets the path of the configured temporary directory.
file_ensure_htaccess core/includes/file.inc Creates a .htaccess file in each Drupal files directory if it is missing.
file_get_file_references core/modules/file/file.module Retrieves a list of references to a file.
file_htaccess_lines Deprecated core/includes/file.inc Returns the standard .htaccess lines that Drupal writes to file directories.
file_munge_filename core/includes/file.inc Modifies a filename as needed for security purposes.
file_prepare_directory core/includes/file.inc Checks that the directory exists and is writable.
file_save_htaccess core/includes/file.inc Creates a .htaccess file in the given directory.
file_scan_directory core/includes/file.inc Finds all files that match a given mask in a given directory.
file_stream_wrapper_uri_normalize core/includes/file.inc Normalizes a URI by making it syntactically correct.
file_stream_wrapper_valid_scheme Deprecated core/includes/file.inc Checks that the scheme of a stream URI is valid.
file_unmanaged_copy core/includes/file.inc Copies a file to a new location without invoking the file API.
file_unmanaged_delete core/includes/file.inc Deletes a file without database changes or hook invocations.
file_unmanaged_delete_recursive core/includes/file.inc Deletes all files and directories in the specified filepath recursively.
file_unmanaged_move core/includes/file.inc Moves a file to a new location without database changes or hook invocation.
file_unmanaged_save_data core/includes/file.inc Saves a file to the specified destination without invoking file API.
file_unmunge_filename core/includes/file.inc Undoes the effect of file_munge_filename().
file_upload_max_size core/includes/file.inc Determines the maximum file upload size by querying the PHP settings.
file_uri_scheme Deprecated core/includes/file.inc Returns the scheme of a URI (e.g. a stream).
file_uri_target core/includes/file.inc Returns the part of a URI after the schema.
file_url_transform_relative core/includes/file.inc Transforms an absolute URL of a local file to a relative URL.
file_valid_uri core/includes/file.inc Determines whether the URI has a valid scheme for file API operations.

Constants

Namesort descending Location Description
FILE_CREATE_DIRECTORY core/includes/file.inc Flag used by file_prepare_directory() -- create directory if not present.
FILE_EXISTS_ERROR core/includes/file.inc Flag for dealing with existing files: Do nothing and return FALSE.
FILE_EXISTS_RENAME core/includes/file.inc Flag for dealing with existing files: Appends number until name is unique.
FILE_EXISTS_REPLACE core/includes/file.inc Flag for dealing with existing files: Replace the existing file.
FILE_MODIFY_PERMISSIONS core/includes/file.inc Flag used by file_prepare_directory() -- file permissions may be changed.
FILE_STATUS_PERMANENT core/includes/file.inc Indicates that the file is permanent and should not be deleted.