Moodle关键函数和模组功能说明书.doc

关键函数和模组功能说明书关键函数和模组功能说明书 文件标识关键函数和模组功能说明书 当前版本版本 v1 0 撰写 完成日期 版本历史 版本 状态撰写起止日期备注 目目 录录 1 引言 1 2 关键函数功能说明 2 2 1 常用的通用 API 2 3 关键模组功能 71 3 1 Assign 71 3 2 Assignment 71 3 3 Book 72 3 4 Chat 72 3 5 Choice 72 3 6 Data 73 3 7 Feedback 73 3 8 Folder 74 3 9 Forum 74 3 10 Glossary 74 3 11 Imscp 75 3 12 Label 75 3 13 Lesson 76 3 14 Lti 76 3 15 Page 76 3 16 Quiz 77 3 17 Resource 77 3 18 Scorm 78 3 19 Survey 78 3 20 url 78 3 21 wiki 79 3 22 workshop 79 4 配置参数详细说明 80 关键函数和模块功能说明书 第 1 页 共 84 页 1 引言引言 Moodle 网络教学平台支持多样化的教学方式 可以为学习者的自主学习 协作学习及个性化 学习创造一个良好的网络学习环境 目前已经在世界上很多国家和地区得到广泛的应用 并且取 得很好的教学效果 但随着互联网进入 Web2 0 时代 大量计算机新技术 新应用不断涌现 这 对于网络课程的开发也势必要求引入更多新的计算机应用技术 同时这也给基于 Moodle 平台的 网络课程建设提出了更多新要求 目前 国内对 Moodle 平台的研究主要集中在网络课程实现与应用方面的探讨 而对平台自 身的技术研究则略显不足 本文将详细的阐述与讲解 Moodle v2 3 1 平台的关键函数和模组功 能 对 moodle 二次开发和网络课程建设及教学实践进行将有很大的价值与意义 关键函数和模块功能说明书 第 2 页 共 84 页 2 关键函数功能说明关键函数功能说明 2 1 常用的通用常用的通用 API 2 1 1 2 1 1 访问权限访问权限 APIAPI 主要功能是判断当前用户权限 同时还允许模块用来扩展 Moodle 功能 2 1 1 1 提取上下文功能 1 context instance by id contextid 2 参数说明 参数名参数说明 contextid上下文 Id 3 返回值 context 4 函数功能 用于实例化对象 对象将在实例化后被系统自动删除 5 注意事项 1 如果对象没有被成功创建将抛出异常 2 被删除的用户将不再拥有对象 6 范例 systemcontext context system instance usercontext context user instance user id categorycontext context coursecat instance category id coursecontext context course instance course id contextmodule context module instance cm id 2 1 1 2 Determining that a user has a given capability 2 1 1 2 1 has capability 1 参数说明 参数名参数说明 context当前上下文 User当前用户 2 返回值 true false 3 函数功能 检查用户在一个给定的环境下是否拥有一个特定的权限 默认值是检查当前用户 的权限 4 注意事项 1 默认值是检查当前用户的权限 不过也可以传给这个函数一个其他的用户 id 默认的情况下 管理员账户将返回 true 关键函数和模块功能说明书 第 3 页 共 84 页 5 范例 context context module instance cm id has capability mod folder managefiles context 2 1 1 2 2 require capability 1 参数说明 参数名参数说明 context当前上下文 User当前用户 2 返回值 无 3 函数功能 检查用户在一个给定的环境下是否拥有一个特定的权限 当用户没有权限的时候 抛出权限控制异常 4 注意事项 1 和has capability 不同的是 require capability 不返回布尔值 5 范例 require capability moodle site config context 2 1 1 3 Enrolment functions 2 1 1 3 1 is enrolled 1 参数说明 参数名参数说明 user被判断的用户 context当前课程 2 返回值 true false 3 函数功能 判断用户是否参加该课程 对学生和教师返回 ture 值 对系统管理员和其他管理 人员返回 false 值 用户的注册可以被激活或者被暂停 被暂停的用户一般隐藏在用户界面而不能 进入该课程 4 注意事项 无 5 范例 function is enrolled context context user null withcapability onlyactive false 2 1 1 3 2 get enrolled users 1 参数说明 参数名参数说明 context当前活动 2 返回值 list 关键函数和模块功能说明书 第 4 页 共 84 页 3 函数功能 显示能够参与某些活动的用户名单 4 注意事项 此函数可获取能够参与某些活动的所有用户名单 包括没有任何角色的用户 活动管理者可 以决定清除所有的非参与活动用户的数据 5 范例 function get enrolled sql context context withcapability groupid 0 onlyactive false function get enrolled users context context withcapability groupid 0 userfields u orderby limitfrom 0 limitnum 0 function count enrolled users context context withcapability groupid 0 2 1 1 4 Other related functions 2 1 1 4 1 require login 1 参数说明 无 2 返回值 无 3 函数功能 验证用户在访问任何课程或活动之前是否已登录 验证用户以游客身份登录 验证隐藏课程和活动的访问 验证仅允许实验小组成员的访问 验证是否注册用户 是否有浏览权限用户 是否有其他一些注册插件允许以临时访客访问 记录课程访问日志 4 注意事项 某一个插件脚本在设置页面地址后都应当包含 require login 和 require course login 函数 5 范例 function require login courseorid NULL autologinguest true cm NULL setwantsurltome true preventredirect false 2 1 1 4 2 require course login 1 参数说明 参数名参数说明 courseorid课程 id 2 返回值 无 3 函数功能 该函数仅用于允许在未登录情况下只读访问网页内容的活动 比如浏览资源文件 阅读词汇 条目等 4 注意事项 某一个插件脚本在设置页面地址后都应当包含 require login 和 require course login 函数 关键函数和模块功能说明书 第 5 页 共 84 页 5 范例 function require course login courseorid autologinguest true cm NULL setwantsurltome true preventredirect false 2 1 1 4 3 isguestuser isloggedin and is siteadmin 1 参数说明 无 2 返回值 无 3 函数功能 这些函数需要被预先设置来限制某些特殊帐户的访问 很多时候不必要调用他们 因为任何 写入或危险的操作都会被 has capability 阻挡 4 注意事项 在活动模块中 强烈建议不要使用 is siteadmin 请用标准的权限状态判断函数代替 5 范例 function isguestuser user null function isloggedin function is siteadmin user or id null 2 1 1 4 4 is guest is viewing and is enrolled 1 参数说明 无 2 返回值 true false 3 函数功能 is guest 用户通过某些插件被赋予临时访客访问权限 is viewing 用户具有课程浏览权限 可以进入课程 但是不能视为参加该课程 is enrolled 在用户注册表上记录用户活动 4 注意事项 为了获取课程数据 用户的上述的某个函数必须返回 true 5 范例 function is guest context context user null function is viewing context context user null withcapability 2 1 1 4 5 get users by capability 1 参数说明 参数名参数说明 context当前活动 2 返回值 list 3 函数功能 关键函数和模块功能说明书 第 6 页 共 84 页 该函数具有返回用户及其权限列表功能 忽略注册状态 这个方法应该只用于课程内容的上一 级 4 注意事项 无 5 范例 function get users by capability context context capability fields sort limitfrom limitnum groups exceptions doanything ignored null view ignored null useviewallgroups false 2 1 2 2 1 2 数据操作数据操作 APIAPI 2 1 2 1 获得一个记录 2 1 2 1 1 moodle database get record 2 参数说明 参数名参数说明 table查询的表名 conditions条件的参数 strictness查询模式 3 返回值 单一数据记录 4 函数功能 以单一对象形式获得符合给定条件的一些数据 5 注意事项 无 6 范例 get record table array conditions fields strictness IGNORE MISSING 2 1 2 1 2 moodle database get record select 2 参数说明 参数名参数说明 table查询的表名 conditions条件的参数 strictness查询模式 3 返回值 单一数据记录 4 函数功能 以单一对象形式获得符合给定 where 条件的一些数据 5 注意事项 无 6 范例 get record select table select array params null fields strictness IGNORE MISSING 2 1 2 1 3 moodle database get record sql 2 参数说明 关键函数和模块功能说明书 第 7 页 共 84 页 参数名参数说明 sql查询的 sql 语句 3 返回值 单一数据记录 4 函数功能 以单一对象形式获得符合给定 sql 语句的一些数据 5 注意事项 无 6 范例 get record sql sql array params null strictness IGNORE MISSING 2 1 2 2 获得一个散列数组的记录 2 1 2 2 1 moodle database get records 2 参数说明 参数名参数说明 table查询的表名 conditions条件的参数 3 返回值 对象数组 4 函数功能 以对象数组形式获得符合给定条件的一些数据 5 注意事项 无 6 范例 get records table array conditions null sort fields limitfrom 0 limitnum 0 2 1 2 2 2 moodle database get records select 2 参数说明 参数名参数说明 table查询的表名 conditions条件的参数 3 返回值 对象数组 4 函数功能 以对象数组形式获得符合给定 where 条件的一些数据 5 注意事项 无 6 范例 get records select table select array params null sort fields limitfrom 0 limitnum 0 2 1 2 2 3 moodle database get records sql 2 参数说明 参数名参数说明 sql查询的 sql 语句 3 返回值 对象数组 关键函数和模块功能说明书 第 8 页 共 84 页 4 函数功能 通过使用 SQL 语句以对象数组形式获得一些数据 该方法作为 moodle 数据库的一 个抽象函数 被应用于每个数据库类型 5 注意事项 无 6 范例 get records sql sql array params null limitfrom 0 limitnum 0 2 1 2 2 4 moodle database get records list 2 参数说明 参数名参数说明 table查询的表名 field匹配的字段 3 返回值 对象数组 4 函数功能 以对象数组形式获得一些数据 其中一个字段的值匹配一个列表 5 注意事项 无 6 范例 get records list table field array values sort fields limitfrom limitnum 2 1 2 2 5 moodle database get records menu 2 参数说明 参数名参数说明 table查询的表名 3 返回值 对象数组 4 函数功能 以一个符合所有给定的条件的关联数组形式 从一些记录中获得前两列数据 可 以选择前两个字段或者让该参数保持空白 该方法以一个关联数组形式返回表中的前两列 5 注意事项 无 6 范例 get records menu table array conditions null sort fields limitfrom 0 limitnum 0 2 1 2 2 6 moodle database get records select menu 2 参数说明 参数名参数说明 table查询的表名 Select条件语句 3 返回值 对象数组 4 函数功能 从一些记录中获得匹配特定的 WHERE 语句的前两列数据 5 注意事项 无 6 范例 关键函数和模块功能说明书 第 9 页 共 84 页 get records select menu table select array params null sort fields limitfrom 0 limitnum 0 2 1 2 2 7 moodle database get records sql menu 2 参数说明 参数名参数说明 Sql查询的 sql 语句 3 返回值 对象数组 4 函数功能 通过使用 SQL 语句以一个关联数组形式从一些记录中获得前两列数据 5 注意事项 无 6 范例 get records sql menu sql array params null limitfrom 0 limitnum 0 2 1 2 3 检查有多少匹配给定标准的记录 2 1 2 3 1 moodle database count records 2 参数说明 参数名参数说明 table查询的表名 3 返回值 数字 4 函数功能 返回表中符合条件的记录数 5 注意事项 无 6 范例 count records table array conditions null 2 1 2 3 2 moodle database count records select 2 参数说明 参数名参数说明 table查询的表名 Select条件语句 3 返回值 数字 4 函数功能 返回表中符合条件的记录数 必须匹配特定的 WHERE 语句 5 注意事项 无 6 范例 count records select table select array params null countitem COUNT x 关键函数和模块功能说明书 第 10 页 共 84 页 2 1 2 3 3 moodle database count records sql 2 参数说明 参数名参数说明 Sql查询的 sql 语句 3 返回值 数字 4 函数功能 返回表中符合条件的记录数 必须匹配特定的 sql 语句 5 注意事项 无 6 范例 count records sql sql array params null 2 1 2 4 检查某个记录是否存在 2 1 2 4 1 moodle database record exists 2 参数说明 参数名参数说明 table查询的表名 3 返回值 true false 4 函数功能 检查某个记录是否存在在被查询的表中 5 注意事项 无 6 范例 record exists table array conditions null 2 1 2 4 2 moodle database record exists select 2 参数说明 参数名参数说明 table查询的表名 Select条件语句 3 返回值 true false 4 函数功能 检查某个记录是否存在在被查询的表中 查询必须符合某种 where 条件 5 注意事项 无 6 范例 record exists select table select array params null 2 1 2 4 3 moodle database record exists sql 2 参数说明 参数名参数说明 Sql查询的 sql 语句 关键函数和模块功能说明书 第 11 页 共 84 页 3 返回值 true false 4 函数功能 检查某个记录是否存在在被查询的表中 查询必须符合 sql 条件 5 注意事项 无 6 范例 record exists sql sql array params null 2 1 2 5 从一个记录获得一个特定的字段值 2 1 2 5 1 moodle database get field 2 参数说明 参数名参数说明 table查询的表名 conditions查询的条件 return返回的字段名 3 返回值 单个字段值 4 函数功能 在符合条件的基础上从一个记录获得一个特定的字段值 5 注意事项 无 6 范例 get field table return array conditions strictness IGNORE MISSING 2 1 2 5 2 moodle database get field select 2 参数说明 参数名参数说明 table查询的表名 select查询的条件 return返回的字段名 3 返回值 单个字段值 4 函数功能 在符合 Where 条件的基础上从一个记录获得一个特定的字段值 5 注意事项 无 6 范例 get field select table return select array params null strictness IGNORE MISSING 2 1 2 5 3 moodle database get field sql 2 参数说明 参数名参数说明 sql查询的 sql 条件 3 返回值 单个字段值 4 函数功能 在符合 sql 条件的基础上从一个记录获得单个的字段值 关键函数和模块功能说明书 第 12 页 共 84 页 5 注意事项 无 6 范例 get field sql sql array params null strictness IGNORE MISSING 2 1 2 6 从不同的记录获得一个特定的字段值 2 1 2 6 1 moodle database get fieldset select 2 参数说明 参数名参数说明 table查询的表名 select查询的条件 return返回的字段名 3 返回值 单个字段值 4 函数功能 在符合条件的基础上从多个记录获得一个特定的字段值 5 注意事项 无 6 范例 get fieldset select table return select array params null 2 1 2 6 2 moodle database get fieldset sql 2 参数说明 参数名参数说明 sql查询的 sql 条件 3 返回值 单个字段值 4 函数功能 在符合 sql 条件的基础上从多个记录获得单个的字段值 5 注意事项 无 6 范例 get fieldset sql sql array params null 2 1 2 7 在数据库设定一个特定字段 2 1 2 7 1 moodle database set field 2 参数说明 参数名参数说明 table查询的表名 newfield字段名称 newvalue字段值 3 返回值 无 关键函数和模块功能说明书 第 13 页 共 84 页 4 函数功能 在符合条件的基础上在数据表上设定一个特定的字段值 5 注意事项 无 6 范例 set field table newfield newvalue array conditions null 2 1 2 7 2 moodle database set field select 2 参数说明 参数名参数说明 table查询的表名 newfield字段名称 newvalue字段值 3 返回值 无 4 函数功能 在符合 where 条件的基础上在数据表上设定一个特定的字段值 5 注意事项 无 6 范例 set field select table newfield newvalue select array params null 2 1 2 8 删除记录 2 1 2 8 1 moodle database delete records 2 参数说明 参数名参数说明 table查询的表名 3 返回值 无 4 函数功能 在特定表中删除记录 5 注意事项 无 6 范例 delete records table array conditions null 2 1 2 8 2 moodle database delete records select 2 参数说明 参数名参数说明 table查询的表名 select查询的条件 3 返回值 无 4 函数功能 在符合条件的基础上在特定表中删除记录 5 注意事项 无 关键函数和模块功能说明书 第 14 页 共 84 页 6 范例 delete records select table select array params null 2 1 2 9 插入记录 2 1 2 9 1 moodle database insert record 2 参数说明 参数名参数说明 table查询的表名 dataobject插入的数据 3 返回值 插入的数据行的 id 4 函数功能 在特定的表中插入特定是数据 并返回插入的数据行的 id 5 注意事项 无 6 范例 insert record table dataobject returnid true bulk false 2 1 2 10 更新记录 2 1 2 10 1 moodle database update record 2 参数说明 参数名参数说明 table查询的表名 dataobject更新的数据 3 返回值 true false 4 函数功能 在数据表中更新记录 5 注意事项 无 6 范例 update record table dataobject bulk false 2 1 2 11 使用记录集 2 1 2 11 1 moodle database get recordset 2 参数说明 参数名参数说明 table查询的表名 3 返回值 数据集 4 函数功能 获得符合条件的数据集 关键函数和模块功能说明书 第 15 页 共 84 页 5 注意事项 无 6 范例 get recordset table array conditions null sort fields limitfrom 0 limitnum 0 2 1 2 11 2 moodle database get recordset select 2 参数说明 参数名参数说明 table查询的表名 select查询的条件 3 返回值 数据集 4 函数功能 获得符合 where 条件的数据集 5 注意事项 无 6 范例 get recordset select table select array params null sort fields limitfrom 0 limitnum 0 2 1 2 11 3 moodle database get recordset sql 2 参数说明 参数名参数说明 sql查询的 sql 条件 3 返回值 数据集 4 函数功能 获得符合 sql 条件的数据集 5 注意事项 无 6 范例 get recordset sql sql array params null limitfrom 0 limitnum 0 2 1 2 11 4 moodle database get recordset list 2 参数说明 参数名参数说明 table查询的表名 3 返回值 数据集 4 函数功能 获得符合列表的值的数据集 5 注意事项 无 6 范例 get recordset list table field values sort fields limitfrom limitnum 关键函数和模块功能说明书 第 16 页 共 84 页 2 1 2 12 委托事务 请注意有些数据库不支持事物 比如 MyISAM MySQL 数据库引擎 然而强力建议所有的服务 器管理员迁移到支持事物的数据库 比如 InnoDB MySQL 数据库引擎 以前的版本只支持一个级别的事务 自从 Moodle 2 0 DML 层可以仿真授权的允许嵌套的事务 在 Moodle 的核心中不应使用过多的事物 他们主要服务于比如网络服务器 登记 和身份验证 插件这类各种插件 一些子系统 比如消息传送 不支持事物 因为在外部系统中实现回滚是不可能的 2 1 2 12 1 start delegated transaction 2 参数说明 无 3 返回值 无 4 函数功能 开始一个委托事务 5 注意事项 无 6 范例 transaction DB start delegated transaction 2 1 2 12 2 allow commit 2 参数说明 无 3 返回值 无 4 函数功能 提交一个委托事务 5 注意事项 无 6 范例 transaction allow commit 2 1 2 12 3 rollback ex 2 参数说明 Ex 异常信息 3 返回值 无 4 函数功能 在程序中遇到异常时 抛出异常信息 5 注意事项 如果在出现异常的地方没有加入 rollback 处理 则异常将不会被捕捉 抛出 系统将出现错 误 6 范例 transaction rollback ex 关键函数和模块功能说明书 第 17 页 共 84 页 2 1 2 13 帮助模块 2 1 2 13 1 sql bitand int1 int2 2 参数说明 2 个整数 3 返回值 sql 语句 4 函数功能 返回一个 sql 语句返回 2 个数之间的 and 运算 5 注意事项 无 6 范例 DB sql bitand int1 int2 2 1 2 13 2 sql bitnot int1 2 参数说明 1 个整数 3 返回值 sql 语句 4 函数功能 返回一个 sql 语句返回 1 个数的 not 运算 5 注意事项 无 6 范例 DB sql bitnot int1 2 1 2 13 3 sql bitor int1 int2 2 参数说明 2 个整数 3 返回值 sql 语句 4 函数功能 返回一个 sql 语句返回 2 个数之间的 or 运算 5 注意事项 无 6 范例 DB sql bitor int1 int2 2 1 2 13 4 sql bitxor int1 int2 2 参数说明 2 个整数 3 返回值 sql 语句 4 函数功能 返回一个 sql 语句返回 2 个数之间的 xor 运算 5 注意事项 无 6 范例 DB sql bitxor int1 int2 关键函数和模块功能说明书 第 18 页 共 84 页 2 1 2 13 5 sql null from clause 2 参数说明 无 3 返回值 sql 从句 4 函数功能 返回某些数据库查询需要的 from 从句 5 注意事项 无 6 范例 DB sql null from clause 2 1 2 13 6 sql ceil fieldname 2 参数说明 字段名 3 返回值 sql 从句 4 函数功能 返回运用在某个字段上的正确的 CEIL 表达式 5 注意事项 无 6 范例 DB sql ceil fieldname 2 1 2 13 7 sql like fieldname param casesensitive true accentsensitive true notlike false escapechar 2 参数说明 参数名参数说明 fieldname字段名 param匹配参数 casesensitive是否大小写敏感 accentsensitive是否需要账号验证 notlike是否模糊查询 escapechar查询结果分隔符 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句处理 like 匹配操作 5 注意事项 无 6 范例 DB get records sql SELECT A WHERE DB sql like idnumber idnum array idnum foo 关键函数和模块功能说明书 第 19 页 共 84 页 2 1 2 13 8 sql length fieldname 2 参数说明 参数名参数说明 fieldname字段名 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句计算某个表达式的字符长度 5 注意事项 无 6 范例 DB sql length fieldname 2 1 2 13 9 sql modulo int1 int2 2 参数说明 参数名参数说明 int1 被除数 int2 除数 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句计算一个数字被另外一个数字整除的余数 5 注意事项 无 6 范例 DB sql modulo int1 int2 2 1 2 13 10 sql position needle haystack 2 参数说明 参数名参数说明 needle 子串 haystack 母串 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句查询一个字符串在另外一个字符串中的位置 5 注意事项 无 6 范例 DB sql position needle haystack 关键函数和模块功能说明书 第 20 页 共 84 页 2 1 2 13 11 sql substr expr start length false 2 参数说明 参数名参数说明 expr 查询条件 start 子串查询开始位置 length 是否限定长度 3 返回值 sql 从句 4 函数功能 返回合适的 sql 语句用于查询数据库中查询返回合适的字符子串 5 注意事项 无 6 范例 DB sql substr expr start length false 2 1 2 13 12 sql cast char2int fieldname 2 参数说明 参数名参数说明 fieldname 字段名 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句用于转化一个字符型字段为整数型 5 注意事项 整数型字段和字符型字段必须都被数据库兼容 6 范例 DB sql cast char2int fieldname text false 2 1 2 13 13 sql cast char2real fieldname 2 参数说明 参数名参数说明 fieldname 字段名 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句用于转化一个字符型字段为实数型 5 注意事项 实数型字段和字符型字段必须都被数据库兼容 6 范例 DB sql cast char2real fieldname text false 2 1 2 13 14 sql compare text fieldname 2 参数说明 参数名参数说明 关键函数和模块功能说明书 第 21 页 共 84 页 fieldname text 型的字段的字段名 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句用于比较一个字符型的字段和 text 型的字段 5 注意事项 Text 型字段和字符型字段必须都被数据库兼容 6 范例 DB sql compare text fieldname 2 1 2 13 15 sql order by text fieldname 2 参数说明 参数名参数说明 fieldname text 型的字段的字段名 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句用于排序 text 型的字段 5 注意事项 无 6 范例 DB sql order by text fieldname 2 1 2 13 16 sql concat 2 参数说明 无 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句在一系列元素中做连接运算 5 注意事项 6 范例 DB sql concat 2 1 2 13 17 sql concat join separator elements array 2 参数说明 参数名参数说明 separator 分隔符号 elements 元素数组 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句在一系列以分隔符为分隔的元素中做连接运算 5 注意事项 6 范例 DB sql concat join separator elements array 关键函数和模块功能说明书 第 22 页 共 84 页 2 1 2 13 18 sql fullname first firstname last lastname 2 参数说明 参数名参数说明 first 姓 last 名 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句连接姓和名 5 注意事项 6 范例 DB sql fullname first firstname last lastname 2 1 2 13 19 sql isempty tablename fieldname nullablefield textfield 2 参数说明 参数名参数说明 tablename 查询表名 fieldname 查询字段名 nullablefield 字段是否允许为空 textfield 字段类型 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句查询是否某个表的某字段为空 5 注意事项 6 范例 DB sql isempty tablename fieldname nullablefield textfield 2 1 2 13 20 sql isnotempty tablename fieldname nullablefield textfie ld 2 参数说明 参数名参数说明 tablename 查询表名 fieldname 查询字段名 nullablefield 字段是否允许为空 textfield 字段类型 3 返回值 sql 从句 4 函数功能 返回一个 sql 语句查询是否某个表的某字段不为空 5 注意事项 6 范例 DB sql isnotempty tablename fieldname nullablefield textfield 关键函数和模块功能说明书 第 23 页 共 84 页 2 1 2 13 21 sql empty 2 参数说明 无 3 返回值 字符串 4 函数功能 返回数据库支持的空字符串 5 注意事项 6 范例 DB sql empty 2 1 3 2 1 3 文件文件 APIAPI 文件 API 用于管理所有存储在 Moodle 上的文件 功能包括 1 命名文件区域 2 向用户提供文件 3 从用户获得文件 4 各种文件操作 请注意在实际的开发中 开发者一般不直接与文件 API 打交道 而是操作 formslib 元素自动 操作文件 所以以下的文件操作功能只举例 不讲解函数 2 1 3 1 浏览文件 2 1 3 1 1 get file browser 2 参数说明 无 3 返回值 页面的浏览器对象 4 函数功能 获取当前使用的浏览器对象 5 注意事项 无 6 范例 browser get file browser 2 1 3 1 2 get system context 2 参数说明 无 3 返回值 系统内容 4 函数功能 获取当前系统内容 当系统内容不能被创建的时候就返回空 5 注意事项 无 6 范例 context get system context 关键函数和模块功能说明书 第 24 页 共 84 页 2 1 3 1 3 get file info filename 2 参数说明 参数名参数说明 currentfile 查询文件名 3 返回值 文件内容的数组 4 函数功能 查找一个文件的具体信息 5 注意事项 无 6 范例 browser get file info filename 2 1 3 1 4 get parent 2 参数说明 无 3 返回值 父对象的所有信息数组 4 函数功能 返回父对象的所有信息 5 注意事项 无 6 范例 fileinfo get parent 2 1 3 1 5 get visible name 2 参数说明 无 3 返回值 父对象的所有信息数组 4 函数功能 返回父对象的所有信息 5 注意事项 无 6 范例 name get visible name 2 1 3 1 6 get children 2 参数说明 无 3 返回值 子对象的所有信息数组 4 函数功能 返回父对象的所有的子对象的所有信息 在默认的情况下仅仅返回第一级子对象 的信息 其他的子对象的信息也可返回 5 注意事项 所有的子对象信息都被默认排序 6 范例 name get children 关键函数和模块功能说明书 第 25 页 共 84 页 2 1 3 1 7 get children 2 参数说明 无 3 返回值 布尔值 指示是否为字典索引 4 函数功能 返回当前对象是否为字典索引 5 注意事项 无 6 范例 child is directory 2 1 3 2 移动文件 2 1 3 2 1 get file storage 2 参数说明 无 3 返回值 返回文件存储实例 4 函数功能 返回当前对象的文件存储实例 5 注意事项 无 6 范例 file get file storage 2 1 3 2 2 create file from pathname file Path file 2 参数说明 参数名参数说明 file Path 创建文件的路径 file 创建文件的实例 3 返回值 返回文件对象 4 函数功能 在指定的路径创建指定的文件 5 注意事项 无 6 范例 fs create file from pathname file record from zip file 2 1 3 3 获取列表区域文件 2 1 3 3 1 get area files contextid component filearea itemid false sort sortorder itemid filepath filename 关键函数和模块功能说明书 第 26 页 共 84 页 includedirs true 2 参数说明 参数名参数说明 contextid 内容 id component创建文件的实例 filearea文件位置 itemid可选 子项的 id sort排序方式 includedirs是否包括子目录文件 3 返回值 所有指定位置文件对象 4 函数功能 返回所有指定位置的文件对象 5 注意事项 无 6 范例 fs get area files contextid component filearea itemid false sort sortorder itemid filepath filename includedirs true 2 1 3 3 2 get filename 2 参数说明 无 3 返回值 返回文件名 4 函数功能 为指定的文件对象返回文件名 5 注意事项 无 6 范例 f get filename 2 1 3 3 3 get filepath 2 参数说明 无 3 返回值 返回文件深度 4 函数功能 为指定的文件对象返回文件深度 5 注意事项 无 6 范例 f get filepath 2 1 3 3 4 get itemid 2 参数说明 无 3 返回值 项目 id 关键函数和模块功能说明书 第 27 页 共 84 页 4 函数功能 返回和评论相关的项目 id 5 注意事项 无 6 范例 f get itemid 2 1 3 4 创建文件 2 1 3 4 1 create file from string fileinfo filecontent 2 参数说明 参数名参数说明 fileinfo 文件信息 filecontent 文件的内容 3 返回值 文件对象 4 函数功能 创建指定文件内容的对象 5 注意事项 无 6 范例 f create file from string fileinfo hello world 2 1 3 5 读取文件 请注意只可于 mod mymodule cod