annotate core/lib/Drupal/Core/Extension/ModuleInstallerInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Extension;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Provides the installation of modules with creating the db schema and more.
Chris@0 7 */
Chris@0 8 interface ModuleInstallerInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Installs a given list of modules.
Chris@0 12 *
Chris@0 13 * Order of events:
Chris@0 14 * - Gather and add module dependencies to $module_list (if applicable).
Chris@0 15 * - For each module that is being installed:
Chris@0 16 * - Invoke hook_module_preinstall().
Chris@0 17 * - Install module schema and update system registries and caches.
Chris@0 18 * - Invoke hook_install() and add it to the list of installed modules.
Chris@0 19 * - Invoke hook_modules_installed().
Chris@0 20 *
Chris@0 21 * To install test modules add
Chris@0 22 * @code
Chris@0 23 * $settings['extension_discovery_scan_tests'] = TRUE;
Chris@0 24 * @endcode
Chris@0 25 * to your settings.php.
Chris@0 26 *
Chris@0 27 * @param string[] $module_list
Chris@0 28 * An array of module names.
Chris@0 29 * @param bool $enable_dependencies
Chris@0 30 * (optional) If TRUE, dependencies will automatically be installed in the
Chris@0 31 * correct order. This incurs a significant performance cost, so use FALSE
Chris@0 32 * if you know $module_list is already complete.
Chris@0 33 *
Chris@0 34 * @return bool
Chris@0 35 * TRUE if the modules were successfully installed.
Chris@0 36 *
Chris@0 37 * @throws \Drupal\Core\Extension\MissingDependencyException
Chris@0 38 * Thrown when a requested module, or a dependency of one, can not be found.
Chris@0 39 *
Chris@0 40 * @see hook_module_preinstall()
Chris@0 41 * @see hook_install()
Chris@0 42 * @see hook_modules_installed()
Chris@0 43 */
Chris@0 44 public function install(array $module_list, $enable_dependencies = TRUE);
Chris@0 45
Chris@0 46 /**
Chris@0 47 * Uninstalls a given list of modules.
Chris@0 48 *
Chris@0 49 * @param string[] $module_list
Chris@0 50 * The modules to uninstall.
Chris@0 51 * @param bool $uninstall_dependents
Chris@0 52 * (optional) If TRUE, dependent modules will automatically be uninstalled
Chris@0 53 * in the correct order. This incurs a significant performance cost, so use
Chris@0 54 * FALSE if you know $module_list is already complete.
Chris@0 55 *
Chris@0 56 * @return bool
Chris@0 57 * FALSE if one or more dependencies are missing, TRUE otherwise.
Chris@0 58 *
Chris@0 59 * @see hook_module_preuninstall()
Chris@0 60 * @see hook_uninstall()
Chris@0 61 * @see hook_modules_uninstalled()
Chris@0 62 */
Chris@0 63 public function uninstall(array $module_list, $uninstall_dependents = TRUE);
Chris@0 64
Chris@0 65 /**
Chris@0 66 * Adds module a uninstall validator.
Chris@0 67 *
Chris@0 68 * @param \Drupal\Core\Extension\ModuleUninstallValidatorInterface $uninstall_validator
Chris@0 69 * The uninstall validator to add.
Chris@0 70 */
Chris@0 71 public function addUninstallValidator(ModuleUninstallValidatorInterface $uninstall_validator);
Chris@0 72
Chris@0 73 /**
Chris@0 74 * Determines whether a list of modules can be uninstalled.
Chris@0 75 *
Chris@0 76 * @param string[] $module_list
Chris@0 77 * An array of module names.
Chris@0 78 *
Chris@0 79 * @return string[]
Chris@0 80 * An array of reasons the module can not be uninstalled, empty if it can.
Chris@0 81 */
Chris@0 82 public function validateUninstall(array $module_list);
Chris@0 83
Chris@0 84 }