[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/includes/ -> module.inc (summary)

(no description)

File Size: 518 lines (17 kb)
Included or required: 5 times
Referenced: 0 times
Includes or requires: 1 file
 includes/install.inc

Defines 16 functions

  module_load_all()
  module_iterate()
  module_list()
  module_rebuild_cache()
  _module_build_dependencies()
  module_exists()
  module_load_install()
  module_load_include()
  module_load_all_includes()
  module_enable()
  module_disable()
  module_hook()
  module_implements()
  module_invoke()
  module_invoke_all()
  drupal_required_modules()

Functions
Functions that are not part of a class:

module_load_all()   X-Ref
Load all the modules that have been enabled in the system table.


module_iterate($function, $argument = '')   X-Ref
Call a function repeatedly with each module in turn as an argument.


module_list($refresh = FALSE, $bootstrap = TRUE, $sort = FALSE, $fixed_list = NULL)   X-Ref
Collect a list of all loaded modules. During the bootstrap, return only
vital modules. See bootstrap.inc

param: $refresh
param: $bootstrap
param: $sort
param: $fixed_list
return:

module_rebuild_cache()   X-Ref
Rebuild the database cache of module files.

return:

_module_build_dependencies($files)   X-Ref
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.

param: $files
return:

module_exists($module)   X-Ref
Determine whether a given module exists.

param: $module
return:

module_load_install($module)   X-Ref
Load a module's installation hooks.


module_load_include($type, $module, $name = NULL)   X-Ref
Load a module include file.

Examples:
param: $type
param: $module
param: $name

module_load_all_includes($type, $name = NULL)   X-Ref
Load an include file for each of the modules that have been enabled in
the system table.


module_enable($module_list)   X-Ref
Enable a given list of modules.

param: $module_list

module_disable($module_list)   X-Ref
Disable a given set of modules.

param: $module_list

module_hook($module, $hook)   X-Ref
Determine whether a module implements a hook.

param: $module
param: $hook
return:

module_implements($hook, $sort = FALSE, $refresh = FALSE)   X-Ref
Determine which modules are implementing a hook.

param: $hook
param: $sort
param: $refresh
return:

module_invoke()   X-Ref
Invoke a hook in a particular module.

param: $module
param: $hook
param: ...
return:

module_invoke_all()   X-Ref
Invoke a hook in all enabled modules that implement it.

param: $hook
param: ...
return:

drupal_required_modules()   X-Ref
Array of modules required by core.




Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7