Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

External functions API: Difference between revisions

From MoodleDocs
Line 4: Line 4:
== externallib.php ==
== externallib.php ==
* This file is located at the root of your plugin.
* This file is located at the root of your plugin.
* This file is composed by a class that contains the external function referenced in services.php
* This file is composed by a class that contains the external functions and their descriptions.
 
For more information on how to implement the external function read the [[External_functions_API|External functions API]] documentation.


== Example ==
== Example ==

Revision as of 09:04, 16 January 2012

Overview

The External functions API allows you to create fully parameterised methods that can be accessed by external programs (such as Web services).

externallib.php

  • This file is located at the root of your plugin.
  • This file is composed by a class that contains the external functions and their descriptions.

Example

You will find an example of an external.php file in the web service template plugin. This plugin contains a web service hello_world function. To make testing easy for you, the plugin is distributed with a test client in the folder /client.

See also