install.inc

  • API functions for installing modules and themes.

File

includes/install.inc

Functions

Name Description
db_installer_object Returns a database installer object.
db_run_tasks Ensures the environment for a Drupal database on a predefined connection.
drupal_check_module Checks a module's requirements.
drupal_check_profile Checks an installation profile's requirements.
drupal_current_script_url Returns the URL of the current script, with modified query parameters.
drupal_detect_baseurl Detects the base URL using the PHP $_SERVER variables.
drupal_detect_database_types Detects all supported databases that are compiled into PHP.
drupal_get_database_types Returns all supported database installer objects that are compiled into PHP.
drupal_get_installed_schema_version Returns the currently installed schema version for a module.
drupal_get_schema_versions Returns an array of available schema versions for a module.
drupal_install_fix_file Attempts to fix file permissions.
drupal_install_mkdir Creates a directory with the specified permissions.
drupal_install_profile_distribution_name Loads the installation profile, extracting its defined distribution name.
drupal_install_system Installs the system module.
drupal_load_updates Loads .install files for installed modules to initialize the update system.
drupal_requirements_severity Extracts the highest severity from the requirements array.
drupal_requirements_url Returns a URL for proceeding to the next page after a requirements problem.
drupal_rewrite_settings Replaces values in settings.php with values in the submitted array.
drupal_set_installed_schema_version Update the installed version information for a module.
drupal_uninstall_modules Uninstalls a given list of disabled modules.
drupal_verify_install_file Verifies the state of the specified file.
drupal_verify_profile Verifies an installation profile for installation.
install_goto Sends the user to a different installer page.
install_profile_info Retrieves information about an installation profile from its .info file.
st Translates a string when some systems are not available.

Constants

Name Description
FILE_EXECUTABLE File permission check -- File is executable.
FILE_EXIST File permission check -- File exists.
FILE_NOT_EXECUTABLE File permission check -- File is not executable.
FILE_NOT_EXIST File permission check -- File does not exist.
FILE_NOT_READABLE File permission check -- File is not readable.
FILE_NOT_WRITABLE File permission check -- File is not writable.
FILE_READABLE File permission check -- File is readable.
FILE_WRITABLE File permission check -- File is writable.
REQUIREMENT_ERROR Requirement severity -- Error condition; abort installation.
REQUIREMENT_INFO Requirement severity -- Informational message only.
REQUIREMENT_OK Requirement severity -- Requirement successfully met.
REQUIREMENT_WARNING Requirement severity -- Warning condition; proceed but flag warning.
SCHEMA_INSTALLED Indicates that a module has been installed.
SCHEMA_UNINSTALLED Indicates that a module has not been installed yet.

Classes

Name Description
DatabaseTaskException Exception thrown if the database installer fails.
DatabaseTasks Database installer structure.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/includes!install.inc/7.x