/includes/module.inc

Description
Functions
module_alter (line 555)

调用指定模块实现的 hook,引用传值

void module_alter ( $modules, (array $hook,  &$data, [ &$value1 = NULL], [ &$value2 = NULL], [ &$value3 = NULL], (*) &$data,)
  • (array $hook: || string) $modules 一个或一组模块的系统名称
  • (*) &$data,: &$value1, &$value2, &$value3 最多传递 4 个参数
  • $modules
  • &$data
  • &$value1
  • &$value2
  • &$value3
module_alter_all (line 589)

调用所有已启用模块实现的 hook,引用传值

返回值递归合并 module_alter_all ((string) $hook,  &$data, [ &$value1 = NULL], [ &$value2 = NULL], [ &$value3 = NULL], (*) &$data,)
  • (string) $hook: hook 名称
  • (*) &$data,: &$value1, &$value2, &$value3 最多传递 4 个参数
  • &$data
  • &$value1
  • &$value2
  • &$value3
module_clear_cache (line 383)

启用或禁用模块,缓存清除

void module_clear_cache ()
module_core_module (line 293)

系统必需的模块

void module_core_module ()
module_enabled_variable (line 40)

已启用模块、主题写入主配置表

void module_enabled_variable ([ $op = 'all'])
  • $op
module_exists (line 195)

检查模块是否已启用

void module_exists ( $module)
  • $module
module_get_info (line 277)

读取 info 文件

void module_get_info ( $module,  $filepath)
  • $module
  • $filepath
module_get_schema (line 881)
void module_get_schema ( $table, [ $clear = NULL])
  • $table
  • $clear
module_get_table (line 872)

获取指定模块表结构

void module_get_table ( $module, [ $table = NULL])
  • $module
  • $table
module_get_ver (line 769)

获取模块install文件中的升级序号

void module_get_ver ( $module, [ $load = NULL])
  • $module
  • $load
module_hook_get_cache (line 627)

获取 hook 缓存

void module_hook_get_cache ((string) $hook)
  • (string) $hook
module_hook_set_cache (line 649)

写入 hook 列表,目前仅清除旧的缓存数据,计划未来各模块的 hook 定义及实现,必须强制注册

void module_hook_set_cache ([(string) $hook = ])
  • (string) $hook
module_include_file (line 487)

加载指定文件

  • access: public
void module_include_file (string $file, [string $module = NULL])
  • string $file: 文件名称,可包含相对目录
  • string $module: 模块名称,若不指定,则为所有模块
module_init (line 7)

初始化载入已启用模块

void module_init ()
module_install_schema (line 202)

调用install创建或删除表

void module_install_schema ( $type,  $module)
  • $type
  • $module
module_invoke (line 519)

调用指定模块实现的 hook

  • return: 而定
模块返回值或递归合并,视 module_invoke ( $modules, (array $hook)
  • (array $hook: || string) $modules 一个或一组模块的系统名称
  • $modules
module_invoke_all (line 658)

调用所有已启用模块实现的 hook

返回值递归合并 module_invoke_all ()
module_invoke_first (line 702)

调用所有已启用模块实现的 hook,与 module_invoke_all 不同的是,遇到首个返回值(包括false,不包括 NULL),则结束

(*) module_invoke_first ()
module_is_dependencies (line 340)
  • return: 的模块,则返回第一个模块的系统名称
有依赖于 module_is_dependencies ($module $module, [$lists $lists = array()])
  • $module $module: 模块系统名称
  • $lists $lists: 模块列表 搜索 $lists 中是否有依赖于 $module 的模块。
module_list (line 86)

模块、主题列表,实时读取数据库

void module_list ([ $type = 'module'], [ $status = 'all'])
  • $type
  • $status
module_load (line 860)

载入文件

void module_load ( $filename,  $path)
  • $filename
  • $path
module_load_install (line 22)

载入模块安装文件,若未指定模块名称,则载入全部

void module_load_install ([ $module = NULL])
  • $module
module_set_disabled (line 351)

禁用模块

void module_set_disabled ([ $modules = array()])
  • $modules
module_set_enabled (line 397)

启用或升级模块

void module_set_enabled ( $list,  $type, [ $modules = array()])
  • $list
  • $type
  • $modules
module_set_install (line 230)

安装或升级模块数据表

void module_set_install ( $v)
  • $v
module_set_list (line 112)

注册模块、主题,或更新info信息

void module_set_list ([ $type = 'module'])
  • $type
module_set_uninstall (line 305)

卸载模块

void module_set_uninstall ( $module)
  • $module
module_tree_list (line 797)

遍历模块、主题文件夹

void module_tree_list ( $type)
  • $type
_module_invoke_all (line 737)

调用所有已启用模块实现的 hook

返回值按模块系统名称索引 _module_invoke_all ()
_module_tree_list (line 824)
void _module_tree_list ( $type,  $dir, [ &$modules = NULL])
  • $type
  • $dir
  • &$modules

Documentation generated on Wed, 04 Jul 2012 14:35:57 +0800 by phpDocumentor 1.4.3