moodle php代码解读_Moodle二次开发指南-代码编写指南

3.

所有文本文件应当使用

Unix

风格的文本格式(多数的文本编辑器都有这个选项)。

4.

所有

php

标记都必须是

“

完整

”

标记，如

?> ……

而非如

 ?>

的短标记。

5.

所有已经存在的版权声明应当被保留。如果有必要，您可以加入自己的。

6.

每个文件都应当包含主

config.php

文件。

7.

每个文件都应当检查用户的身份是否正确，可以使用函数

require_login()

和

isadmin()

、

isteacher()

、

iscreator()

或者

isstudent()

。

8.

所有访问数据库的操作都应当使用

lib/datalib.php

中的函数

――

这样可以兼容更多的

数据库服务器。所有的事情都应当是可以用这些函数来完成的，如果遇到必须要写

SQL

代码的情况，请记住这些代码应当是跨平台的，且仅仅对您代码中的特定函数

(

通常在

一个

lib.php

文件中

)

有效，且代码中用注释进行明确说明。

9.

不要建立和使用标准全局变量

$CFG

、

$SESSION

、

$THEME

、

$SITE

、

$COURSE

和

$USER

之外的全局变量。

10.

所有变量都应当被初始化或者至少在使用前用

isset()

或

empty()

等函数进行检测。

11.

所有字符串都应当可翻译

――

在

“lang/en_utf8”

目录中创建新的文本文件

，

字符串应当

使用简洁的英文小写名称，并通过函数

get_string()

或

print_string()

来取得。为了保

证语言包的向后兼容，绝对不要删除字符串。

12.

所有帮助文件应当可翻译

――

在

“lang/en_utf8/help”

目录中创建文本文件并且通过

helpbutton()

函数来调用它们。如果要更新帮助文件：



对于小的修改，旧的翻译文件仍然可以继续使用时，可以直接进行修改，但您

应当通知

translation AT moodle DOT org

。



对于大的修改，应当创建新的文件，新文件的文件名是在原文件名的末尾添加

一个数字，并在以后逐渐增加

(

如

filename2.html)

，这样翻译人员就可以方便地知

道文件有了一个新的版本。很显然，新的代码和帮助索引文件都必须修改以指向新

版本的文件。

13.

从浏览器发来的信息

(以

GET

或

POST

形式发送)

都应用了

magic_quotes

(无论

PHP

的设置如何)，因此直接将它们插入到数据库中是安全的。所有其它的原始数据(来自

文件或数据库的)都必须在插入数据库前使用

addslashes()

进行预处理。由于在这个

问题上人们经常出错，我们编写了一个

独立的页面

来介绍如何添加和删除

“

\

”

符号。

14.

非常重要：

Moodle

中所有的文本，

特别是用户提供的文本，

都必须使用

format_text()

函数来输出。这样就可以确保文本已经正确地过滤。在

输出函数

页面上有关于这个问题

的更多信息。

.

15.

用户的动作应当用

add_to_log()

函数记录下来，这些信息会被用于

活动报告

和

日志

。

编码风格