Development:Moodle API - Revision history

Jmouneyrac: /* Functions List */

2008-11-12T01:49:06Z

Functions List

← Older revision		Revision as of 01:49, 12 November 2008
Line 53:		Line 53:
	=Functions List=		=Functions List=
	The names of each of the sections below represent a pathname in Moodle, where the api.php for that code will be located.<br>		The names of each of the sections below represent a pathname in Moodle, where the api.php for that code will be located.<br>
	In order to keep this Moodle API page easy to ~~review~~, we wrote the [https://docs.moodle.org/en/Development:Moodle_API_Function_List Moodle API functions] on another page.		In order to keep this Moodle API page easy to read, we wrote the [https://docs.moodle.org/en/Development:Moodle_API_Function_List Moodle API functions] on another page. Please review them as well.

Jmouneyrac: /* Functions List */

2008-11-10T07:46:02Z

Functions List

← Older revision		Revision as of 07:46, 10 November 2008
Line 53:		Line 53:
	=Functions List=		=Functions List=
	The names of each of the sections below represent a pathname in Moodle, where the api.php for that code will be located.<br>		The names of each of the sections below represent a pathname in Moodle, where the api.php for that code will be located.<br>
	In order to keep ~~the~~ Moodle API page easy to review, we wrote the [https://docs.moodle.org/en/Development:Moodle_API_Function_List Moodle API functions] on another page.		In order to keep this Moodle API page easy to review, we wrote the [https://docs.moodle.org/en/Development:Moodle_API_Function_List Moodle API functions] on another page.

Jmouneyrac: /* Functions List */

2008-11-10T07:44:40Z

Functions List

← Older revision		Revision as of 07:44, 10 November 2008
Line 53:		Line 53:
	=Functions List=		=Functions List=
	The names of each of the sections below represent a pathname in Moodle, where the api.php for that code will be located.<br>		The names of each of the sections below represent a pathname in Moodle, where the api.php for that code will be located.<br>
	In order to keep the Moodle API page easy to review, we wrote the ~~Moodle API functions on~~ [https://docs.moodle.org/en/Development:Moodle_API_Function_List another page].		In order to keep the Moodle API page easy to review, we wrote the [https://docs.moodle.org/en/Development:Moodle_API_Function_List Moodle API functions] on another page.

Jmouneyrac: /* Functions List */

2008-11-10T07:44:03Z

Functions List

Show changes

Dougiamas: /* Functions List */

2008-11-10T05:59:10Z

Functions List

← Older revision		Revision as of 05:59, 10 November 2008
Line 52:		Line 52:

	=Functions List=		=Functions List=
	~~All following paragraph matches~~ a Moodle ~~folder. All described functions should be included in a class named from~~ the ~~folder path, into an~~ api.php ~~file~~.		The names of each of the sections below represent a pathname in Moodle, where the api.php for that code will be located.

	== admin ==		== admin ==
	~~These~~ API ~~would be~~ used ~~in order~~ to ~~configurate~~ Moodle.		This API is used to change Moodle configuration variables.
	<code php>		<code php>
	...		...

Dougiamas: /* Standard function names */

2008-11-10T05:56:25Z

Standard function names

← Older revision		Revision as of 05:56, 10 November 2008
Line 28:		Line 28:

	=== Standard function names ===		=== Standard function names ===
	So that the whole API is consistent, we recommend to use methods:		So that the whole API is consistent, we recommend to use methods with names like this:
	<code php>		<code php>
	get_xxx() //for retrieving one or more objects named xxx		get_xxx() //for retrieving one or more objects named xxx

Dougiamas: /* Convention */

2008-11-10T05:56:06Z

Convention

← Older revision		Revision as of 05:56, 10 November 2008
Line 15:		Line 15:
	=Implementation=		=Implementation=
	==Convention==		==Convention==
	A new '''api.php''' file can be created for each module/block folder, and also the current admin/user/course/... common moodle folders. ~~<br>~~These files must contain a class named after the unique module path:		A new '''api.php''' file can be created for each module/block folder, and also the current admin/user/course/... common moodle folders. These files must contain a class named after the unique module path:
	''class mod_forum_api''		''class mod_forum_api''
	''class user_api''		''class user_api''

Dougiamas: Just tidying up

2008-11-10T05:55:46Z

Just tidying up

← Older revision		Revision as of 05:55, 10 November 2008
Line 15:		Line 15:
	=Implementation=		=Implementation=
	==Convention==		==Convention==
	A new '''api.php''' file ~~should~~ be created ~~into~~ each module/block folder, and also the current admin/user/course/... common moodle folders. <br>~~This file should contains~~ a class named ~~from~~ the module:		A new '''api.php''' file can be created for each module/block folder, and also the current admin/user/course/... common moodle folders. <br>These files must contain a class named after the unique module path:
	''class mod_forum_api''		''class mod_forum_api''
	''class user_api''		''class user_api''
	''class course_api''		''class course_api''
	...		...
	~~Into~~ this class, static ~~function~~ will provide ~~requested~~ information and ~~operation~~:		In this class, static methods will provide information and operations to external callers, eg:
	''create_forum()''		''create_forum()''
	''get_user()''		''get_user()''
Line 28:		Line 28:

	=== Standard function names ===		=== Standard function names ===
	~~In order to manipulate object and to be~~ consistent ~~for all API~~, we recommend to use:		So that the whole API is consistent, we recommend to use methods:
	<code php>		<code php>
	get_xxx() //for retrieving one or more objects named xxx		get_xxx() //for retrieving one or more objects named xxx
	set_xxx() //for updating or creating one or more object xxx		set_xxx() //for updating OR creating one or more object xxx (ie when you don't care if it exists yet)
	update_xxx() //for updating one or more xxx objects, throws an exception if the object doesn't exist		update_xxx() //for updating one or more xxx objects, throws an exception if the object doesn't exist
	create_xxx() //for creating an object, throws an exception if the object (primary key) already exist		create_xxx() //for creating an object, throws an exception if the object (primary key) already exist
Line 38:		Line 38:

	==API functions must be defined/declared==		==API functions must be defined/declared==
	The web services module needs to know what ~~parameter~~ are required and what information are returned. ~~So we~~ need a way to ~~generate all~~ these ~~information~~. ~~<br>~~		The web services module needs to know what parameters are required and what information are returned. We need a way to define these parameters so that web service descriptions can be automatically generated and so that incoming data can be cleaned/checked.
	'''~~TO BE DEFINED~~:''' ~~have a look~~ at PHPdoc if we can ~~generate~~ all ~~needed~~ information ~~from~~ the documentation. ~~Then we~~ cache ~~it in a file~~. The web services module will look at this file in order to create a WSDL file for soap, in order to know what function are available in REST,...

			'''TODO:''' Look closely at PHPdoc to see if we can represent all required information as part of the standard function documentation. We can scan all these whenever files change, and then store the result as XML or something in dataroot/cache. The web services module will look at this file in order to create a WSDL file for soap, in order to know what function are available in REST, to check the range and types of incoming parameters, etc.

	==Call the API functions==		==Call the API functions==
	~~These~~ functions ~~are called inside Moodle~~ by ~~the modules, block and others plugin, and also~~ web services ~~module~~. As they are static ~~function~~, they should be called as:		The API functions will not only be used by web services, but by any code that needs to talk to those modules. As they are static methods, they should be called as:

	mod_forum_api::get_discussions		mod_forum_api::get_discussions
	user_api::create_users		user_api::create_users

Jmouneyrac: /* forum */

2008-11-07T01:27:02Z

forum

← Older revision		Revision as of 01:27, 7 November 2008
Line 165:		Line 165:
	delete_forum_discussions($discussions)		delete_forum_discussions($discussions)
	delete_forum_posts($posts)		delete_forum_posts($posts)
	~~search_forum~~($stringtosearch, $forumids=null, $discussionids=null)		search_forum_string($stringtosearch, $forumids=null, $discussionids=null)
	</code>		</code>

Jmouneyrac: /* forum */

2008-11-07T01:26:50Z

forum

← Older revision		Revision as of 01:26, 7 November 2008
Line 165:		Line 165:
	delete_forum_discussions($discussions)		delete_forum_discussions($discussions)
	delete_forum_posts($posts)		delete_forum_posts($posts)
			search_forum($stringtosearch, $forumids=null, $discussionids=null)
	</code>		</code>