C:/drupal/includes/module.inc File Reference

Go to the source code of this file.


Functions

 module_load_all ()
 module_iterate ($function, $argument= '')
 module_list ($refresh=FALSE, $bootstrap=TRUE, $sort=FALSE, $fixed_list=NULL)
 module_rebuild_cache ()
 _module_build_dependencies ($files)
 module_exists ($module)
 module_load_install ($module)
 module_load_include ($type, $module, $name=NULL)
 module_load_all_includes ($type, $name=NULL)
 module_enable ($module_list)
 module_disable ($module_list)
 module_hook ($module, $hook)
 module_implements ($hook, $sort=FALSE, $refresh=FALSE)
 module_invoke ()
 module_invoke_all ()
 drupal_required_modules ()


Detailed Description

API for loading and interacting with Drupal modules.

Definition in file module.inc.


Function Documentation

_module_build_dependencies ( files  ) 

Find dependencies any level deep and fill in dependents information too.

If module A depends on B which in turn depends on C then this function will add C to the list of modules A depends on. This will be repeated until module A has a list of all modules it depends on. If it depends on itself, called a circular dependency, that's marked by adding a nonexistent module, called -circular- to this list of modules. Because this does not exist, it'll be impossible to switch module A on.

Also we fill in a dependents array in $file->info. Using the names above, the dependents array of module B lists A.

Parameters:
$files The array of filesystem objects used to rebuild the cache.
Returns:
The same array with dependencies and dependents added where applicable.

Definition at line 165 of file module.inc.

References drupal_set_message(), and t().

Referenced by module_rebuild_cache().

Here is the call graph for this function:

drupal_required_modules (  ) 

End of "defgroup hooks". Array of modules required by core.

Definition at line 493 of file module.inc.

Referenced by drupal_check_profile(), drupal_verify_profile(), and system_modules().

module_disable ( module_list  ) 

Disable a given set of modules.

Parameters:
$module_list An array of module names.

Definition at line 317 of file module.inc.

References $module_list, db_query(), drupal_rebuild_code_registry(), module_exists(), module_hook(), module_implements(), module_invoke(), module_list(), and module_load_install().

Referenced by system_modules_submit().

Here is the call graph for this function:

module_enable ( module_list  ) 

Enable a given list of modules.

Parameters:
$module_list An array of module names.

Definition at line 280 of file module.inc.

References $module_list, db_fetch_object(), db_query(), drupal_function_exists(), drupal_load(), drupal_rebuild_code_registry(), module_hook(), module_invoke(), module_list(), and module_load_install().

Referenced by _install_module_batch(), drupal_install_modules(), and system_modules_submit().

Here is the call graph for this function:

module_exists ( module  ) 

Determine whether a given module exists.

Parameters:
$module The name of the module (without the .module extension).
Returns:
TRUE if the module is both installed and enabled.

Definition at line 222 of file module.inc.

References module_list().

Referenced by drupal_lookup_path(), DrupalWebTestCase::drupalModuleDisable(), DrupalWebTestCase::drupalModuleEnable(), garland_preprocess_page(), language_list(), menu_get_active_help(), module_disable(), node_admin_nodes(), node_filters(), node_revision_revert_confirm_submit(), path_admin_overview(), system_admin_by_module(), system_modules(), system_theme_settings(), template_preprocess_node(), theme_get_settings(), and update_results_page().

Here is the call graph for this function:

module_iterate ( function,
argument = '' 
)

Call a function repeatedly with each module in turn as an argument.

Definition at line 21 of file module.inc.

References $name, and module_list().

Here is the call graph for this function:

module_list ( refresh = FALSE,
bootstrap = TRUE,
sort = FALSE,
fixed_list = NULL 
)

Collect a list of all loaded modules. During the bootstrap, return only vital modules. See bootstrap.inc

Parameters:
$refresh Whether to force the module list to be regenerated (such as after the administrator has changed the system settings).
$bootstrap Whether to return the reduced set of modules loaded in "bootstrap mode" for cached pages. See bootstrap.inc.
$sort By default, modules are ordered by weight and filename, settings this option to TRUE, module list will be ordered by module name.
$fixed_list (Optional) Override the module list with the given modules. Stays until the next call with $refresh = TRUE.
Returns:
An associative array whose keys and values are the names of all loaded modules.

Definition at line 47 of file module.inc.

References $name, $result, db_fetch_object(), db_query(), drupal_get_filename(), and name.

Referenced by _drupal_maintenance_theme(), _theme_process_registry(), bootstrap_invoke_all(), install_main(), menu_get_active_help(), module_disable(), module_enable(), module_exists(), module_implements(), module_iterate(), module_load_all(), module_load_all_includes(), search_admin_settings(), system_modules_submit(), and user_admin_perm().

Here is the call graph for this function:

module_load_all (  ) 

Load all the modules that have been enabled in the system table.

Definition at line 12 of file module.inc.

References drupal_load(), and module_list().

Referenced by _drupal_bootstrap_full().

Here is the call graph for this function:

module_load_all_includes ( type,
name = NULL 
)

Load an include file for each of the modules that have been enabled in the system table.

Definition at line 267 of file module.inc.

References $name, $type, module_list(), and module_load_include().

Referenced by drupal_get_schema().

Here is the call graph for this function:

module_load_include ( type,
module,
name = NULL 
)

Load a module include file.

Parameters:
$type The include file's type (file extension).
$module The module to which the include file belongs.
$name Optionally, specify the file name. If not set, the module's name is used.

Definition at line 247 of file module.inc.

References $name, and drupal_get_path().

Referenced by _update_refresh(), forum_overview(), module_load_all_includes(), module_load_install(), and update_status().

Here is the call graph for this function:

module_load_install ( module  ) 

Load a module's installation hooks.

Definition at line 230 of file module.inc.

References module_load_include().

Referenced by _drupal_install_module(), drupal_get_schema_unprocessed(), drupal_load_updates(), drupal_uninstall_module(), module_disable(), module_enable(), and system_modules_uninstall().

Here is the call graph for this function:

module_rebuild_cache (  ) 


Generated on Mon Jun 2 15:08:07 2008 for SimpleTest by  1.5.5