Moodle中文API之导航API

最新推荐文章于 2022-12-08 12:02:22 发布
最新推荐文章于 2022-12-08 12:02:22 发布
阅读量711 收藏
点赞数

Navigation API  导航API

目录

1. 概述

2. 什么是导航

3. 导航不是什么

4. 导航如何工作

5. 导航扩展

  5.1代码扩展

     5.1.1 导航

     5.1.2 设置导航

     5.1.3 导航条 （面包屑）

  5.2 回调插件

   5.2.1 模块

   5.2.2 课程格式

   5.2.3 课程报表

   5.2.4 本地插件

 

1. 概述

导航 API在 Moodle 中使用多类系统导航.

2. 什么是导航

他是十分重要的去准确弄明白Moodle中的导航 .  Moodle 2.0 的目标就是规范整个moodle站点的导航结构. 导航可以通过页面对象 $PAGE, 对应于您设置页面标题部分, title部分, 任何必要的 JavaScript , 等等. 导航的结构使用信息 $PAGE 包含继承站点的导航结构. 导航或设置 blocks 是对moodle创建导航结构的解释.

导航的结构可以通过三个变量来展现:

[php] view plain copy
  1. $PAGE->navigation  

这是最主要的导航结构, 它包含了所有允许用户在其他页面浏览的项目.

[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. $PAGE->settingsnav   

设置导航结构允许用户可编辑的导航项目.

[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. $PAGE->navbar   

这个用来设置页面的面包屑.

1. 导航不是什么

导航不是导航模块或设置模块! 这两个模块是用来创建显示导航结构的. 导航模块可以参考 $PAGE->navigation, 设置模块可以参考 $PAGE->settingsnav. 两个模块解释它们的数据成HTML并被渲染.

1. 导航是后台显示的结构没有直接调用的显示方法.

2. 导航和设置模块显示后端的导航模块，但是不能添加.

在MVC模式中, $PAGE->navigation, $PAGE->settingsnav, 和 $PAGE->navbar 是模型, 而块是视图.

 navbar 仅仅是活动的导航或设置项目的路径. navbar 不会显示在一个模块中; 代替他的是添加在主题布局文件（layout） 和显示通过核心渲染(config.php/render.php).

 

4. 导航如何工作

主要的导航结构通过设置 $PAGE->navigation. 导航和设置是用户查看的上下文相关的页面. 他们通过 $PAGE 对象的其他属性进行展示:

· $PAGE->context 是一个 Moodle 的上下文能力及标出用户查看的上下文页面结构.

· $PAGE->course 用户正在查看的课程. 他是十分必要的如果上下文是 CONTEXT_COURSE 或 更大. 然而, 他也是十分有用的在其他上下文中 像 CONTEXT_USER.

· $PAGE->cm 是课程模块的实例化. 他是十分必要的如果上下文是CONTEXT_MODULE 或者更大.

· $PAGE->url 用来匹配活动导航项目.

几乎每个页面设置  $PAGE->url  通过调用   $PAGE->set_url   没有多少明确设置  context, course,  或  cm.  当你调用   require_login   伴随着  course  或  cm  它会自动调用下面的 :
[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. if ($cm) {  
  2.     $PAGE->set_cm($cm, $course); // 设置全局变量$COURSE  
  3. } else {  
  4.     $PAGE->set_course($course);// 设置全局变量$COURSE  
  5. }  

一个页面只需要明确设置一个 context, course, 或 cm 在下面这些条件中:

1. require_login 没有正确调用

2. 页面使用CONTEXT_SYSTEM, CONTEXT_COURSECAT, 或 CONTEXT_USER (调用 $PAGE->set_context ).

3. 页面使用一个 course 或 cm 而且也是用了上面的一个上下文 (调用 $PAGE->set_course 或 $PAGE->set_cm ).

导航结构不能生成在 $PAGE对象设置之前. 它仅仅在他第一次使用的时候生成, 或者当一些试图访问的结构或在代码尝试添加到它. 导航初始化有特别的顺序:

1. 主导航结构

2. 设置导航部分

3. 导航条 (不是必须生成的因为它的简单内容和结构)

5. 导航扩展

  5.1代码扩展

这个方法是在代码执行中对导航做任意扩展, 他将显示在你扩展代码被调用的页面里 (你最好把它放在lib.php的一个函数里).

这儿有个例子来自 一般开发论坛: Moodle 2 - 如何为一个模块设置面包屑. 它值得一读.

     5.1.1 导航

这是扩展主导航的结构.

[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. $previewnode = $PAGE->navigation->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);  
  2. $thingnode = $previewnode->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));  
  3. $thingnode->make_active();  

上面的几行代码是添加一个预览节点在导航的底部 然后添加一个实际事情节点给预览节点 (就像给我们的树加了一片叶子). 最后一行代码是将事情节点变成可活动节点，以便于navbar 能找到他 但是如果你给他的 URL 和当前页面的url相同，你就不必在调用，因为他会自动进行创建.

下一个扩展导航是课程导航. 那么你需要知道课程id 然后调用require_login($courseorid); 以便于课程导航加载到对应的课程.

[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. $coursenode = $PAGE->navigation->find($courseid, navigation_node::TYPE_COURSE);  
  2. $thingnode = $coursenode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));  
  3. $thingnode->make_active();  

代码的第一行是简单的查找课程节点, 找到他我们需要提供课程id 和节点的类型 TYPE_COURSE. 我们正在做的是依赖导航生成 导航然后添加到课程.

注意Moodle 加载插件是按字母顺序. 因此插件b 能被找到通过插件 a 的添加 而不是其他的方式.

 

     5.1.2 设置导航

添加导航和设置导航 到导航节点是非常相似的

[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. $settingnode = $PAGE->settingsnav->add(get_string('setting'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);  
  2. $thingnode = $settingnode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));  
  3. $thingnode->make_active();  

5.1.3 导航条 （面包屑）

这是扩展的设置导航

[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. $PAGE->navbar->ignore_active();  
  2. $PAGE->navbar->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'));  
  3. $PAGE->navbar->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));  

上面的代码告诉 navbar 忽略之前添加的面包屑,只显示现在加的两个面包屑.

  5.2 回调插件

这些特殊的函是数关于导航的查找和调用 如果他们存在于插件中的话是十分有意义的, 目前只有三种插件可以通过回调扩展导航.

理想情况是所有入口通过 "Administration / Site administration" 树可以通过修改文件 settings.php 来实现 但有时他会更容易通过admin settings 设置导航树 (比如添加链接到扩展页面).

   5.2.1 模块

模块有两种回调方法,第一种是扩展导航, 第二种是扩展设置. 他们决定用户能够查看到的导航的样子.

[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. function {modulename}_extend_navigation(${modulename}node, $course, $module, $cm)  
  2. function {modulename}_extend_settings_navigation($settings, ${modulename}node)  

 5.2.2 课程格式

课程格式都能够完全地重新定义在其中的过程中生成的导航的方式，以及本它们也有几种方法，以确保正确地产生导航.

   5.2.3 课程报表

默认情况下，报表不添加自己或任何其他的导航但有回调，可以实现允许他们这样做。

   5.2.4 本地插件

本地插件也有两种回调方法,第一种是扩展导航, 第二种是扩展设置.

[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. function local_{pluginname}_extends_navigation(global_navigation $nav)  
  2. function local_{pluginname}_extends_settings_navigation(settings_navigation $nav, context $context)  

问：我的页面放在导航里但是它不能找到他?

首先你要坚持你为这个页面设置的URL。他应该和你设置在导航里的一样. 如果不满足这两个条件, 首先你可以改变自己的url通过调用 $PAGE->set_url , 或者使用第二种方式冲在导航里的URL就像下面这样:

[php] view plain copy 在CODE上查看代码片 派生到我的代码片
  1. navigation_node::override_active_url(new moodle_url('/your/url/here.php', array('param'=>'value'))); 

文章转载自：栁罗风尘

Lylofe
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
muddle.py:Python Moodle 2 Web服务API库
04-30
Moodle 2.0 Web API的一个相当不完整的python客户端。 随时给它一些爱。 API覆盖率 19％的核心API覆盖率 完成：core_course_ * 用法 基本用法： import muddle API_KEY = '133bf54a4adf1e21aff0c29034c038e2' API_...
moodle中文API
不忘初心，才能始终
12-11 2446
做Moodle平台快一年了，最近觉得累了，想歇歇，于是决定给后来做Moodle平台开发的提供一些资料福利。 希望对你们能有所帮助。         我会陆陆续续将一些常用的API翻译出来，当然，本人英文水平有限，有不当之处，敬请拍砖。 我提前说下一要翻译的API目录，有空就传上来。 API 目录：       Access API   ======  权限控制API       Dat
Moodle平台——API
eduedu530的博客
10-13 517
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。 本文链接：https://blog.csdn.net/wujiangwei567/article/details/41877483         做Moodle平台快一年了，最近觉得累了，想歇歇，于是决定给后来做Moodle平台开发的提供一些资料福利。...
驾车线路导航api
chunlian3944的博客
08-09 190
驾车线路导航api 导航api是提供驾车导航,语音播报,地图搜索,实时路况功能， 详情：http://www.haoservice.com/docs/24 示例： { "error_code": 0, "reason": "Success", "result...
Moodle 中文 API 之 文件管理API
不忘初心，才能始终
12-16 2554
File API  文件管理 目录 1. 概述 2. 文件域    2.1 命名文件域 3. 提供文件给用户 4. 从用户那获取文件 5. 例子    5.1 浏览文件    5.2 移动文件    5.3 文件列表    5.4创建文件    5.5 读文件    5.6 删除文件   1. 概述  文件 API 是讲述在Moodle中的所有的文件存储. 如果你对
moodle-local_navigation:Moodle本地插件自定义导航
05-19
本地插件-自定义导航 信息 此插件允许在“导航菜单”的末尾添加新菜单项，以自定义选项菜单。 版本 Moodle 3.5 +，3.4 +，3.3 +和3.2+ 安装： git方式 要使用git进行安装，请在Moodle安装的根目录中键入以下命令：...
Moodle课程设计
07-22
资源名称：Moodle课程设计 内容简介： 《MOODLE课程设计》内容简介：Moodle是Modular Object-Oriented Dynamic Learning Environment（模块化面向对象的动态学习环境）的缩写，它是一个课程管理系统（CMS），基于...
moodle-trace-reader:从moodle日志中提取知识的Web界面和REST API
06-28
这个项目是一个跟踪形式的moodle日志提取器，灵感来自ktbs标准描述的存储格式，被ktbs4js项目使用。 日志数据是从他们的 MySQL 数据库中提取的，可以是本地的（通过生产服务器的转储），也可以是直接从 Moodle ...
Moodle开源课程管理系统
09-29
Moodle是一个开源课程管理系统，也被称为学习管理系统（LMS）或虚拟学习环境（VLE）。它已成为深受世界各地教育工作者喜爱的一种为学生建立网上动态网站的工具。 Moodle开源课程管理
Moodle 中文 API 之 权限管理API
不忘初心，才能始终
12-11 1821
Access API 权限管理 目录 1.概论 2.怎样定义权限在插件里 3.有用的函数和类   3.1.获取上下文   3.2.确定一个用户有一个给定的权限     3.2.1 是否拥有权限     3.2.2 需要权限才能做   3.3 注册函数   3.4 其他相关函数 3.4.1 需要登录函数     3.4.2 需要课程登陆     3.4.3 是否为访客、登
moodle的一些api翻译~$page翻译
AGE_03的博客
07-26 3535
主页  ► Page API   Page API API页面用于创建当前页面,添加JavaScript和配置如何向用户展示内容。   内容 [隐藏] ·1概述 ·2一个简单的例子 ·3模板全局页 ·4设置页面 ·4.1 URL ·4.2内容 ·4.3选项设置 ·4.3.1页面布局 ·4.3.2基本主题页面布局 ·4.3.3标题 ·4.3.4标题 ·4.4高级
moodle中文API之表单API
不忘初心，才能始终
12-21 1733
Form API 表单API 目录  1.概述 2.亮点 3.用法 4.表单元素   4.1 基本表单元素   4.2 定制表单元素 5.常用函数   5.1  add_action_buttons($cancel =true,$submitlabel =null)   5.2 setDefault()   5.3 disableif()   5.4 addRule()
高德地图api实现导航功能（使用经验）避坑关注
weixin_56044831的博客
09-26 8758
关于导航功能的实现实际上就是使用市面上开放的地图api，按照操作文档进行开发实现功能的。 业内流行的无非是两种，一种高德地图api，另一种是百度地图api，博主这里选用了高德地图api,进行避坑讲解。只要会其中一种api，另一种也不攻自破了。 当然这篇文章也是用来记录，我在真实开发环境中，遇到的任务。 这里结合我的任务需求，来讲解api的使用。 1.任务描述及思路分析 任务描述：在原有的周边资源的marker标记点上，实现点击标记点，导航到固定的一个终点。 思路分析：这里通过看高德api大概的功
学习笔记 moodle核心API函数
mengliyuan908的博客
10-09 139
moodle核心API函数注册 注册 get_enrolled_users()     返回已注册的用户 ID 列表（首页上的每个人），可选择具有某些功能 get_enrolled_sql()     返回 get_enrolled_users() 中使用的 sql select isguest()     为来宾用户帐户和具有临时来宾访问权限的用户返回 true isguestuser(
导航寻路组件属性及API的使用
xingxing_CC的博客
12-08 237
导航寻路组件是使用：要导航的物体上挂载NavMeshAgent组件
百度地图api调用 实现车载导航功能
qq_53691157的博客
04-23 1703
百度地图api调用 实现车载导航功能 1、进入百度地图开放平台登录账号 2、百度地图api密钥获取 要想使用百度地图的api就需要申请创建对应的应用功能并获取AK密钥，从而才可以成功调用api的功能模块使用。 3、百度地图api密钥获取 选择相应的应用类型和启用服务，设置项目需求的白名单域名，没有域名限制可直接输入*，表示不限制访问，拿到对应的AK密钥就可以进行后续代码的实现了。 4、进入示例中心—...
moodle中文版下载
最新发布
11-18
要在moodle官网上下载moodle中文版，首先需要进入官网，找到“下载”页面。在下载页面中，可以根据自己的操作系统选择合适的版本进行下载，通常包括Windows、Mac和Linux版本。在选择操作系统后，需要选择适合的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值