Xoops模块开发 命名惯例

导航: 上一页 | 首页 | DedeCMS | 帝国CMS | Drupal | PHPCMS | PHP168 | Joomla | PowerEasy | SupeSite

模块名

• 可以是任意可显示字符
• 建议选择反映模块功能的名字

模块主目录名称

• 以小写字母开头的数字和字母的组合，允许包含下划线”_”。
• 建议采用与模块功能相关的目录名。

模块数据库表名称

• 以模块目录名称加下划线”_”为前缀
• 只用小写字母
• 用下划线“_”分隔单词

例如：

模块名：A Foo Module

目录名：foo

表格名：foo_*

一般函数名称

• 以模块目录名称加下划线”_”为前缀
• 采用camelCaps风格分隔不同单词

例如：

函数名：foo_doSomething

区块函数名称

• 总是以b_[模块目录名]_为前缀
• 采用camelCaps风格分隔不同单词

例如：

区块函数名：

• b_foo_blockContent_show
• b_foo_blockContent_edit

变量名

• 以模块目录名称为前缀
• 采用camelCaps风格分隔不同单词

例如：

变量名：$fooOneVariable

类名称

• 以模块目录名称为前缀，首字母大写
• 采用camelCaps风格分隔不同单词

例如：

类名称：fooClass

方法名称

• 首字母小写
• 采用camelCaps风格分隔不同单词

例如：

方法名：oneMethod*

语言字符串

• 以下划线开头，全部大写
• 格式：_<PREFIX>_<DIRNAME>_<STRINGNAME>
• 前缀用来突现需要字符串的地方（及存储在哪个文件中）
• 前缀：

MD - language/english/main.php（字符串在主模块脚本中使用）

MB - language/english/blocks.php（字符串在模块区块中使用）

AM - language/english/admin.php（字符串在模块管理中使用）

MI - langauge/english/modinfo.php（字符串在模块安装和配置中使用）

例如： _MI_FOO_TITLE