Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Extension;
Chris@0: 
Chris@0: /**
Chris@0:  * Interface for classes that manage a set of enabled modules.
Chris@0:  *
Chris@0:  * Classes implementing this interface work with a fixed list of modules and are
Chris@0:  * responsible for loading module files and maintaining information about module
Chris@0:  * dependencies and hook implementations.
Chris@0:  */
Chris@0: interface ModuleHandlerInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Includes a module's .module file.
Chris@0:    *
Chris@0:    * This prevents including a module more than once.
Chris@0:    *
Chris@0:    * @param string $name
Chris@0:    *   The name of the module to load.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if the item is loaded or has already been loaded.
Chris@0:    */
Chris@0:   public function load($name);
Chris@0: 
Chris@0:   /**
Chris@0:    * Loads all enabled modules.
Chris@0:    */
Chris@0:   public function loadAll();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns whether all modules have been loaded.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   A Boolean indicating whether all modules have been loaded. This means all
Chris@0:    *   modules; the load status of bootstrap modules cannot be checked.
Chris@0:    */
Chris@0:   public function isLoaded();
Chris@0: 
Chris@0:   /**
Chris@0:    * Reloads all enabled modules.
Chris@0:    */
Chris@0:   public function reload();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the list of currently active modules.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Extension\Extension[]
Chris@0:    *   An associative array whose keys are the names of the modules and whose
Chris@0:    *   values are Extension objects.
Chris@0:    */
Chris@0:   public function getModuleList();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns a module extension object from the currently active modules list.
Chris@0:    *
Chris@0:    * @param string $name
Chris@0:    *   The name of the module to return.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Extension\Extension
Chris@0:    *   An extension object.
Chris@0:    *
Chris@17:    * @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
Chris@0:    *   Thrown when the requested module does not exist.
Chris@0:    */
Chris@0:   public function getModule($name);
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets an explicit list of currently active modules.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Extension\Extension[] $module_list
Chris@0:    *   An associative array whose keys are the names of the modules and whose
Chris@0:    *   values are Extension objects.
Chris@0:    */
Chris@0:   public function setModuleList(array $module_list = []);
Chris@0: 
Chris@0:   /**
Chris@0:    * Adds a module to the list of currently active modules.
Chris@0:    *
Chris@0:    * @param string $name
Chris@0:    *   The module name; e.g., 'node'.
Chris@0:    * @param string $path
Chris@0:    *   The module path; e.g., 'core/modules/node'.
Chris@0:    */
Chris@0:   public function addModule($name, $path);
Chris@0: 
Chris@0:   /**
Chris@0:    * Adds an installation profile to the list of currently active modules.
Chris@0:    *
Chris@0:    * @param string $name
Chris@0:    *   The profile name; e.g., 'standard'.
Chris@0:    * @param string $path
Chris@0:    *   The profile path; e.g., 'core/profiles/standard'.
Chris@0:    */
Chris@0:   public function addProfile($name, $path);
Chris@0: 
Chris@0:   /**
Chris@0:    * Determines which modules require and are required by each module.
Chris@0:    *
Chris@0:    * @param array $modules
Chris@0:    *   An array of module objects keyed by module name. Each object contains
Chris@0:    *   information discovered during a Drupal\Core\Extension\ExtensionDiscovery
Chris@0:    *   scan.
Chris@0:    *
Chris@0:    * @return
Chris@0:    *   The same array with the new keys for each module:
Chris@0:    *   - requires: An array with the keys being the modules that this module
Chris@0:    *     requires.
Chris@0:    *   - required_by: An array with the keys being the modules that will not work
Chris@0:    *     without this module.
Chris@0:    *
Chris@0:    * @see \Drupal\Core\Extension\ExtensionDiscovery
Chris@0:    */
Chris@0:   public function buildModuleDependencies(array $modules);
Chris@0: 
Chris@0:   /**
Chris@0:    * Determines whether a given module is enabled.
Chris@0:    *
Chris@0:    * @param string $module
Chris@0:    *   The name of the module (without the .module extension).
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if the module is both installed and enabled.
Chris@0:    */
Chris@0:   public function moduleExists($module);
Chris@0: 
Chris@0:   /**
Chris@0:    * Loads an include file for each enabled module.
Chris@0:    *
Chris@0:    * @param string $type
Chris@0:    *   The include file's type (file extension).
Chris@0:    * @param string $name
Chris@0:    *   (optional) The base file name (without the $type extension). If omitted,
Chris@0:    *   each module's name is used; i.e., "$module.$type" by default.
Chris@0:    */
Chris@0:   public function loadAllIncludes($type, $name = NULL);
Chris@0: 
Chris@0:   /**
Chris@0:    * Loads a module include file.
Chris@0:    *
Chris@0:    * Examples:
Chris@0:    * @code
Chris@0:    *   // Load node.admin.inc from the node module.
Chris@0:    *   $this->loadInclude('node', 'inc', 'node.admin');
Chris@0:    *   // Load content_types.inc from the node module.
Chris@0:    *   $this->loadInclude('node', 'inc', 'content_types');
Chris@0:    * @endcode
Chris@0:    *
Chris@0:    * @param string $module
Chris@0:    *   The module to which the include file belongs.
Chris@0:    * @param string $type
Chris@0:    *   The include file's type (file extension).
Chris@0:    * @param string $name
Chris@0:    *   (optional) The base file name (without the $type extension). If omitted,
Chris@0:    *   $module is used; i.e., resulting in "$module.$type" by default.
Chris@0:    *
Chris@0:    * @return string|false
Chris@0:    *   The name of the included file, if successful; FALSE otherwise.
Chris@0:    */
Chris@0:   public function loadInclude($module, $type, $name = NULL);
Chris@0: 
Chris@0:   /**
Chris@0:    * Retrieves a list of hooks that are declared through hook_hook_info().
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An associative array whose keys are hook names and whose values are an
Chris@0:    *   associative array containing a group name. The structure of the array
Chris@0:    *   is the same as the return value of hook_hook_info().
Chris@0:    *
Chris@0:    * @see hook_hook_info()
Chris@0:    */
Chris@0:   public function getHookInfo();
Chris@0: 
Chris@0:   /**
Chris@0:    * Determines which modules are implementing a hook.
Chris@0:    *
Chris@0:    * @param string $hook
Chris@0:    *   The name of the hook (e.g. "help" or "menu").
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An array with the names of the modules which are implementing this hook.
Chris@0:    */
Chris@0:   public function getImplementations($hook);
Chris@0: 
Chris@0:   /**
Chris@0:    * Write the hook implementation info to the cache.
Chris@0:    */
Chris@0:   public function writeCache();
Chris@0: 
Chris@0:   /**
Chris@0:    * Resets the cached list of hook implementations.
Chris@0:    */
Chris@0:   public function resetImplementations();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns whether a given module implements a given hook.
Chris@0:    *
Chris@0:    * @param string $module
Chris@0:    *   The name of the module (without the .module extension).
Chris@0:    * @param string $hook
Chris@0:    *   The name of the hook (e.g. "help" or "menu").
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if the module is both installed and enabled, and the hook is
Chris@0:    *   implemented in that module.
Chris@0:    */
Chris@0:   public function implementsHook($module, $hook);
Chris@0: 
Chris@0:   /**
Chris@0:    * Invokes a hook in a particular module.
Chris@0:    *
Chris@0:    * @param string $module
Chris@0:    *   The name of the module (without the .module extension).
Chris@0:    * @param string $hook
Chris@0:    *   The name of the hook to invoke.
Chris@0:    * @param array $args
Chris@0:    *   Arguments to pass to the hook implementation.
Chris@0:    *
Chris@0:    * @return mixed
Chris@0:    *   The return value of the hook implementation.
Chris@0:    */
Chris@0:   public function invoke($module, $hook, array $args = []);
Chris@0: 
Chris@0:   /**
Chris@0:    * Invokes a hook in all enabled modules that implement it.
Chris@0:    *
Chris@0:    * @param string $hook
Chris@0:    *   The name of the hook to invoke.
Chris@0:    * @param array $args
Chris@0:    *   Arguments to pass to the hook.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An array of return values of the hook implementations. If modules return
Chris@0:    *   arrays from their implementations, those are merged into one array
Chris@0:    *   recursively. Note: integer keys in arrays will be lost, as the merge is
Chris@0:    *   done using array_merge_recursive().
Chris@0:    */
Chris@0:   public function invokeAll($hook, array $args = []);
Chris@0: 
Chris@0:   /**
Chris@14:    * Invokes a deprecated hook in a particular module.
Chris@14:    *
Chris@14:    * Invoking a deprecated hook adds the behavior of triggering an
Chris@14:    * E_USER_DEPRECATED error if any implementations are found.
Chris@14:    *
Chris@14:    * API maintainers should use this method instead of invoke() when their hook
Chris@14:    * is deprecated. This method does not detect when a hook is deprecated.
Chris@14:    *
Chris@14:    * @param string $description
Chris@14:    *   Helpful text describing what to do instead of implementing this hook.
Chris@14:    * @param string $module
Chris@14:    *   The name of the module (without the .module extension).
Chris@14:    * @param string $hook
Chris@14:    *   The name of the hook to invoke.
Chris@14:    * @param array $args
Chris@14:    *   Arguments to pass to the hook implementation.
Chris@14:    *
Chris@14:    * @return mixed
Chris@14:    *   The return value of the hook implementation.
Chris@14:    *
Chris@14:    * @see \Drupal\Core\Extension\ModuleHandlerInterface::invoke()
Chris@14:    * @see https://www.drupal.org/core/deprecation#how-hook
Chris@14:    */
Chris@14:   public function invokeDeprecated($description, $module, $hook, array $args = []);
Chris@14: 
Chris@14:   /**
Chris@14:    * Invokes a deprecated hook in all enabled modules that implement it.
Chris@14:    *
Chris@14:    * Invoking a deprecated hook adds the behavior of triggering an
Chris@14:    * E_USER_DEPRECATED error if any implementations are found.
Chris@14:    *
Chris@14:    * API maintainers should use this method instead of invokeAll() when their
Chris@14:    * hook is deprecated. This method does not detect when a hook is deprecated.
Chris@14:    *
Chris@14:    * @param string $description
Chris@14:    *   Helpful text describing what to do instead of implementing this hook.
Chris@14:    * @param string $hook
Chris@14:    *   The name of the hook to invoke.
Chris@14:    * @param array $args
Chris@14:    *   Arguments to pass to the hook.
Chris@14:    *
Chris@14:    * @return array
Chris@14:    *   An array of return values of the hook implementations. If modules return
Chris@14:    *   arrays from their implementations, those are merged into one array
Chris@14:    *   recursively. Note: integer keys in arrays will be lost, as the merge is
Chris@14:    *   done using array_merge_recursive().
Chris@14:    *
Chris@14:    * @see \Drupal\Core\Extension\ModuleHandlerInterface::invokeAll()
Chris@14:    * @see https://www.drupal.org/core/deprecation#how-hook
Chris@14:    */
Chris@14:   public function invokeAllDeprecated($description, $hook, array $args = []);
Chris@14: 
Chris@14:   /**
Chris@0:    * Passes alterable variables to specific hook_TYPE_alter() implementations.
Chris@0:    *
Chris@0:    * This dispatch function hands off the passed-in variables to type-specific
Chris@0:    * hook_TYPE_alter() implementations in modules. It ensures a consistent
Chris@0:    * interface for all altering operations.
Chris@0:    *
Chris@0:    * A maximum of 2 alterable arguments is supported. In case more arguments need
Chris@0:    * to be passed and alterable, modules provide additional variables assigned by
Chris@0:    * reference in the last $context argument:
Chris@0:    * @code
Chris@0:    *   $context = array(
Chris@0:    *     'alterable' => &$alterable,
Chris@0:    *     'unalterable' => $unalterable,
Chris@0:    *     'foo' => 'bar',
Chris@0:    *   );
Chris@0:    *   $this->alter('mymodule_data', $alterable1, $alterable2, $context);
Chris@0:    * @endcode
Chris@0:    *
Chris@0:    * Note that objects are always passed by reference in PHP5. If it is absolutely
Chris@0:    * required that no implementation alters a passed object in $context, then an
Chris@0:    * object needs to be cloned:
Chris@0:    * @code
Chris@0:    *   $context = array(
Chris@0:    *     'unalterable_object' => clone $object,
Chris@0:    *   );
Chris@0:    *   $this->alter('mymodule_data', $data, $context);
Chris@0:    * @endcode
Chris@0:    *
Chris@0:    * @param string|array $type
Chris@0:    *   A string describing the type of the alterable $data. 'form', 'links',
Chris@0:    *   'node_content', and so on are several examples. Alternatively can be an
Chris@0:    *   array, in which case hook_TYPE_alter() is invoked for each value in the
Chris@0:    *   array, ordered first by module, and then for each module, in the order of
Chris@0:    *   values in $type. For example, when Form API is using $this->alter() to
Chris@0:    *   execute both hook_form_alter() and hook_form_FORM_ID_alter()
Chris@0:    *   implementations, it passes array('form', 'form_' . $form_id) for $type.
Chris@0:    * @param mixed $data
Chris@0:    *   The variable that will be passed to hook_TYPE_alter() implementations to be
Chris@0:    *   altered. The type of this variable depends on the value of the $type
Chris@0:    *   argument. For example, when altering a 'form', $data will be a structured
Chris@0:    *   array. When altering a 'profile', $data will be an object.
Chris@0:    * @param mixed $context1
Chris@0:    *   (optional) An additional variable that is passed by reference.
Chris@0:    * @param mixed $context2
Chris@0:    *   (optional) An additional variable that is passed by reference. If more
Chris@0:    *   context needs to be provided to implementations, then this should be an
Chris@0:    *   associative array as described above.
Chris@0:    */
Chris@0:   public function alter($type, &$data, &$context1 = NULL, &$context2 = NULL);
Chris@0: 
Chris@0:   /**
Chris@14:    * Passes alterable variables to deprecated hook_TYPE_alter() implementations.
Chris@14:    *
Chris@14:    * This method triggers an E_USER_DEPRECATED error if any implementations of
Chris@14:    * the alter hook are found. It is otherwise identical to alter().
Chris@14:    *
Chris@14:    * See the documentation for alter() for more details.
Chris@14:    *
Chris@14:    * @param string $description
Chris@14:    *   Helpful text describing what to do instead of implementing this alter
Chris@14:    *   hook.
Chris@14:    * @param string|array $type
Chris@14:    *   A string describing the type of the alterable $data. 'form', 'links',
Chris@14:    *   'node_content', and so on are several examples. Alternatively can be an
Chris@14:    *   array, in which case hook_TYPE_alter() is invoked for each value in the
Chris@14:    *   array, ordered first by module, and then for each module, in the order of
Chris@14:    *   values in $type. For example, when Form API is using $this->alter() to
Chris@14:    *   execute both hook_form_alter() and hook_form_FORM_ID_alter()
Chris@14:    *   implementations, it passes array('form', 'form_' . $form_id) for $type.
Chris@14:    * @param mixed $data
Chris@14:    *   The variable that will be passed to hook_TYPE_alter() implementations to be
Chris@14:    *   altered. The type of this variable depends on the value of the $type
Chris@14:    *   argument. For example, when altering a 'form', $data will be a structured
Chris@14:    *   array. When altering a 'profile', $data will be an object.
Chris@14:    * @param mixed $context1
Chris@14:    *   (optional) An additional variable that is passed by reference.
Chris@14:    * @param mixed $context2
Chris@14:    *   (optional) An additional variable that is passed by reference. If more
Chris@14:    *   context needs to be provided to implementations, then this should be an
Chris@14:    *   associative array as described above.
Chris@14:    *
Chris@14:    * @see \Drupal\Core\Extension\ModuleHandlerInterface::alter()
Chris@14:    * @see https://www.drupal.org/core/deprecation#how-hook
Chris@14:    */
Chris@14:   public function alterDeprecated($description, $type, &$data, &$context1 = NULL, &$context2 = NULL);
Chris@14: 
Chris@14:   /**
Chris@0:    * Returns an array of directories for all enabled modules. Useful for
Chris@0:    * tasks such as finding a file that exists in all module directories.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    */
Chris@0:   public function getModuleDirectories();
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the human readable name of a given module.
Chris@0:    *
Chris@0:    * @param string $module
Chris@0:    *   The machine name of the module which title should be shown.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   Returns the human readable name of the module or the machine name passed
Chris@0:    *   in if no matching module is found.
Chris@0:    */
Chris@0:   public function getName($module);
Chris@0: 
Chris@0: }