定义在moodle/lib/externallib.php

概观

外部函数API允许您创建可由外部程序(如Web服务API)访问的完全参数化的方法。

外部函数位于externallib.php文件中。每个外部函数都是在一个类中实现的,并辅之以两个描述函数:

  • FUNCTIONNAME_parameters()描述函数的参数
  • FUNCTIONNAME_returns()描述了返回值

描述函数使用为此目的而创建的external_description类。

externallib.php

<?PHP

/ **
* PLUGIN外部文件
*
* @package local_PLUGIN
* @copyright 20XX YOURSELF
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3或更高版本
* /
require_once($CFG->libdir . "/externallib.php"); class local_PLUGIN_external extends external_api { / **
*返回方法参数的描述
* @return external_function_parameters
* /
public static function FUNCTIONNAME_parameters() {
// FUNCTIONNAME_parameters()总是返回一个external_function_parameters()。
// external_function_parameters构造函数需要一个external_description数组。
return new external_function_parameters(
// external_description可以是:external_value,external_single_structure或external_multiple结构
array('PARAM1' => new external_value(PARAM_TYPE, 'human description of PARAM1'))
);
}
/ **
*功能本身
* @返回字符串欢迎消息
* /
public static function FUNCTIONNAME($PARAM1) { //参数验证
$params = self::validate_parameters(self::FUNCTIONNAME_parameters(),
array('PARAM1' => $PARAM1)); //注意:不要忘记验证上下文并检查功能 return $returnedvalue;
} / **
*返回方法结果值的描述
* @return external_description
* /
public static function FUNCTIONNAME_returns() {
return new external_value(PARAM_TYPE, 'human description of the returned value');
} }

要进一步阅读这个核心开发者教程:Creating_a_web_service_and_a_web_service_function

安全

在对外部函数中的任何数据进行操作之前,必须在数据最具体的上下文中调用external_api::validate_context()。这将执行一些理智和安全检查,以及为渲染内容设置正确的主题,语言和过滤器。如果你的函数只使用一个上下文,在你的外部函数启动时验证一次。如果您的函数在多个上下文(如课程列表)上运行,则必须在生成与该上下文相关的任何响应数据(例如调用任何 $OUTPUT 函数或$PAGE->get_renderer())之前验证每个上下文。不要从外部函数调用require_login,该函数是为PHP脚本返回一个网页保留的。不要手动调用 $PAGE->set_context(),这会产生警告通知。

还要确保在使用external_api::validate_parameters()之前传递所有参数,以确保正确清理输入。

还要确保在任何地方执行适当的功能检查 - 外部功能是一个公共API。

您将在Web服务模板插件中找到external.php文件的示例。这个插件包含一个web服务hello_world函数。为了使测试变得容易,插件将在文件夹/客户端中与测试客户端一起分发

外部函数/external的更多相关文章

  1. c语言3种链接属性: 外部(external), 内部(internal),无设置(none)

    c语言中,多个文件组合的时候,有可能标示名相同,那么这个时候编译器如何判别的呢?    c语言中有3种链接属性: 外部(external), 内部(internal),无设置(none)    外部( ...

  2. Clickhouse 用户自定义外部函数

    写在前面 Clickhouse 从 21.11 版本开始,除了提供类似SqlServer.MySQL CREATE FUNCTION 的自定义函数之外,还有一个用户自定义函数(UDF),与其说是&qu ...

  3. 【C语言】外部函数和内部函数

    目录 [外部函数]  [内部函数] 1.外部函数  定义的函数能被本文件和其它文件访问(默认). 注:不允许有同名的外部函数. 2.内部函数  定义的函数只能被本文件访问,其它文件不能访问. 注:允许 ...

  4. 如何在 ejs 模板中使用 helper function 外部函数进行特殊处理?

    一般我们想要在 ejs 模板中使用外部函数用于特殊的处理,比如:<%= ellipsis(title, 30) %> 通常的做法是: 使用 app.locals 来定义: app.loca ...

  5. Jmeter外部函数引用

    Jmeter外部函数引用 1.Beanshell引用Jmeter变量 添加用户自定义变量,输入变量名称和变量值,添加Debug sampler,用于输出初始变量值.

  6. pbfunc外部函数扩展应用-直接在Datawindow中生成QR二维码,非图片方式

    利用pbfunc外部函数在Datawindow中直接生成QR二维码,非图片方式.需要注意以下面几点: Datawindow的DataObject的单位必须为像素(Pixels). Datawindow ...

  7. c语言,全局变量,局部变量,外部函数,内部函数,stasic和extern的复习总结

    @import url(http://i.cnblogs.com/Load.ashx?type=style&file=SyntaxHighlighter.css);@import url(/c ...

  8. 用static声明外部变量与内、外部函数

    1.用static声明外部变量 若希望某些外部变量只限于被本文件引用,而不能被其他文件引用,可以在定义外部变量时加一个static声明. 例:(file1.c) #include <stdafx ...

  9. JNI的又一替代者—使用JNR访问Java外部函数接口(jnr-ffi)

    1. JNR简单介绍 继上文“JNI的替代者—使用JNA访问Java外部函数接口”,我们知道JNI越来越不受欢迎,JNI是编写Java本地方法以及将Java虚拟机嵌入本地应用程序的标准编程接口.它管理 ...

随机推荐

  1. zabbix 在图形中显示网络设备的接口描述

    zabbix原始模板没有提供来显示网络设备接口的描述,我们通常看到的图形显示是下面这样的: zabbix 3之后图形显示变化蛮大的,但我们乍一看,并不知道这个ethernet0/1是什么接口,网络设备 ...

  2. python - 系统交互操作(subprocess)

    本文摘于云游道士 链接:https://www.cnblogs.com/yyds/p/7288916.html 个人简化,便于查询. 命令行指令的执行通常有两个比较关注的结果: 命令执行的状态码--表 ...

  3. composer设计原理与基本用法

    原文地址:http://blog.turn.tw/?p=1039 COMPOSER進階原理:PHP命名空間與PSR-0   http://blog.turn.tw/?p=1122 Moving PHP ...

  4. android 基础题

    1. Android的四大组件是哪些,它们的作用? (1).Activity:Activity是Android程序与用户交互的窗口,是Android构造块中最基本的一种,它需要为保持各界面的状态,做很 ...

  5. Informatic学习总结_day03_update组件学习

  6. Linux注销&登陆

    ⒈注销 ①在命令行使用logout,此指令在图形界面无效.

  7. AT91RM9200---定时器简介

    1.前言 系统定时器模块集成了3个不同的定时器 一个周期性间隔的定时器,用来为操作系统设置时基 一个看门狗定时器,可用于软件死锁时进行系统复位 一个实时时钟计数器用来记录流逝的时间 系统定时器时钟 这 ...

  8. 嵌入式系统C编程之堆栈回溯

    前言 在嵌入式系统C语言开发调试过程中,常会遇到各类异常情况.一般可按需添加打印信息,以便观察程序执行流或变量值是否异常.然而,打印操作会占用CPU时间,而且代码中添加过多打印信息时会显得很凌乱.此外 ...

  9. 汇编语言转换成c语言,或者汇编语言转换成golang的汇编,c语言转换成golang的方法

    https://github.com/minio/c2goasm http://microapl.com/asm2c/index.html               收费的 https://gith ...

  10. win10安装virtualBox创建CentOS6.5虚拟机

    1.安装virtualBox 1.1.下载安装包,安装 搜索一下,或者去 VirtualBox官网下载一个. 下载第一个,兼容64,32位. 2.创建64位虚拟机 2.1.解决无法创建64位的问题 2 ...