Development:Modules - Revision history

Antoinegr49 at 15:14, 18 June 2010

2010-06-18T15:14:13Z

← Older revision		Revision as of 15:14, 18 June 2010
Line 18:		Line 18:
	:* widget_user_outline() - given an instance, return a summary of a user's contribution		:* widget_user_outline() - given an instance, return a summary of a user's contribution
	:* widget_user_complete() - given an instance, print details of a user's contribution		:* widget_user_complete() - given an instance, print details of a user's contribution
	:* widget_get_view_actions() / ~~widget_get_view_actions~~() - Used by the participation report (course/report/participation/index.php) to classify actions in the logs table.		:* widget_get_view_actions() / widget_get_post_actions() - Used by the participation report (course/report/participation/index.php) to classify actions in the logs table.
	:* Other functions available but not required are:		:* Other functions available but not required are:
	:** widget_delete_course() - code to clean up anything that would be leftover after all instances are deleted		:** widget_delete_course() - code to clean up anything that would be leftover after all instances are deleted

Koning: /* Activity modules */

2009-08-06T17:19:59Z

Activity modules

← Older revision		Revision as of 17:19, 6 August 2009
Line 26:		Line 26:
	* ''backuplib.php'' and ''restorelib.php'' (optional)		* ''backuplib.php'' and ''restorelib.php'' (optional)
	* ''settings.php'' or ''settingstree.php'' - (optional) a definition of an admin settings page for this module. mod/assignment/settings.php is a good simple example. mod/quiz/settingstree.php is a more complex example.		* ''settings.php'' or ''settingstree.php'' - (optional) a definition of an admin settings page for this module. mod/assignment/settings.php is a good simple example. mod/quiz/settingstree.php is a more complex example.
	* ''defaults.php'' - lets you easily define default values for your configuration variables. It is included by upgrade_activity_modules in lib/adminlib.php. It should define an array $defaults. These values are then loaded into the config table. Alternatively, if you set $defaults['_use_config_plugins'] to true, the values are instead loaded into the config_plugins table, which is better practice. See mod/quiz/defaults.php for an example.		* ''defaults.php'' - lets you easily define default values for your configuration variables. It is included by upgrade_activity_modules in lib/adminlib.php. It should define an array $defaults. These values are then loaded into the config table. Alternatively, if you set $defaults['_use_config_plugins'] to true, the values are instead loaded into the config_plugins table, which is better practice. See mod/quiz/defaults.php for an example. (This apparently only works with moodle 2.x branch.)
	* ''lang/en_utf8/widget.php'' - (optional) Lastly, each module will have some language files that contain strings for that module.		* ''lang/en_utf8/widget.php'' - (optional) Lastly, each module will have some language files that contain strings for that module.

Trick: /* Activity modules */ backwards slash

2009-06-03T18:25:44Z

Activity modules: backwards slash

← Older revision		Revision as of 18:25, 3 June 2009
Line 1:		Line 1:
	=== Activity modules ===		=== Activity modules ===

	Activity modules reside in the '''\mod''' directory. Each module is in a separate subdirectory and consists of the following mandatory elements (plus extra scripts unique to each module):		Activity modules reside in the '''/mod''' directory. Each module is in a separate subdirectory and consists of the following mandatory elements (plus extra scripts unique to each module):

	* ''mod_form.php'' - a form to set up or update an instance of this module		* ''mod_form.php'' - a form to set up or update an instance of this module

Ghillenb at 07:38, 28 April 2009

2009-04-28T07:38:54Z

← Older revision		Revision as of 07:38, 28 April 2009
Line 60:		Line 60:
	[[ja:モジュール (開発者)]]		[[ja:モジュール (開発者)]]
	[[zh:开发:模块_(开发者)]]		[[zh:开发:模块_(开发者)]]
			[[de:Entwickler:Module]]

Nakohdo: /* Activity modules */

2009-03-03T11:49:54Z

Activity modules

← Older revision		Revision as of 11:49, 3 March 2009
Line 11:		Line 11:
	* ''index.php'' - a page to list all instances in a course		* ''index.php'' - a page to list all instances in a course
	* ''view.php'' - a page to view a particular instance		* ''view.php'' - a page to view a particular instance
	* ''lib.php'' - any/all functions defined by the module should be in here. If the module name is called ''widget'', then the required functions include:		* ''lib.php'' - any/all functions defined by the module should be in here. If the module name is called '''widget''', then the required functions include:
	:* widget_install() - will be called during the installation of the module		:* widget_install() - will be called during the installation of the module
	:* widget_add_instance() - code to add a new instance of widget		:* widget_add_instance() - code to add a new instance of widget

Nakohdo: minor formatting changes for better legibiltiy

2009-03-03T11:49:22Z

minor formatting changes for better legibiltiy

← Older revision		Revision as of 11:49, 3 March 2009
Line 1:		Line 1:
	~~'''~~Activity modules~~'''~~ reside in the 'mod' directory. Each module is in a separate subdirectory and consists of the following mandatory elements (plus extra scripts unique to each module):		=== Activity modules ===

			Activity modules reside in the '''\mod''' directory. Each module is in a separate subdirectory and consists of the following mandatory elements (plus extra scripts unique to each module):

	* ''mod_form.php'' - a form to set up or update an instance of this module		* ''mod_form.php'' - a form to set up or update an instance of this module
Line 9:		Line 11:
	* ''index.php'' - a page to list all instances in a course		* ''index.php'' - a page to list all instances in a course
	* ''view.php'' - a page to view a particular instance		* ''view.php'' - a page to view a particular instance
	* ''lib.php'' - any/all functions defined by the module should be in here. If the ~~modulename~~ is called widget, then the required functions include:		* ''lib.php'' - any/all functions defined by the module should be in here. If the module name is called ''widget'', then the required functions include:
	:* widget_install() - will be called during the installation of the module		:* widget_install() - will be called during the installation of the module
	:* widget_add_instance() - code to add a new instance of widget		:* widget_add_instance() - code to add a new instance of widget
Line 27:		Line 29:
	* ''lang/en_utf8/widget.php'' - (optional) Lastly, each module will have some language files that contain strings for that module.		* ''lang/en_utf8/widget.php'' - (optional) Lastly, each module will have some language files that contain strings for that module.

	IMPORTANT: When creating a new module, the new name of the module must not contain numbers or other special characters!		=== IMPORTANT: ===
			* When creating a new module, the new name of the module must not contain numbers or other special characters!

	You need a db table with the same name as your module. This table must have at least three fields: id, course ~~and~~ name.		* You need a ''data base table'' with the same name as your module. This table must have at least three fields:
			*# id
			*# course
			*# name

	You should also make sure that your activity module provides appropriate support for groups and ~~metacourses~~.		* You should also make sure that your activity module provides appropriate support for groups and meta-courses.

	== See also ==		== See also ==

Nakohdo: /* See also */ link to Development:Blocks, Category:Tutorial added

2009-03-03T11:44:22Z

See also: link to Development:Blocks, Category:Tutorial added

← Older revision		Revision as of 11:44, 3 March 2009
Line 35:		Line 35:
	== See also ==		== See also ==

	*[[Development:Backup]]		* [[Development:Blocks]]
			* [[Development:Backup]]
	* Tracker issue [http://tracker.moodle.org/browse/CONTRIB-52 CONTRIB-52 Improvements to make NEWMODULE really useful] - including download link for new module template supporting roles, formslib etc. (unfinished)		* Tracker issue [http://tracker.moodle.org/browse/CONTRIB-52 CONTRIB-52 Improvements to make NEWMODULE really useful] - including download link for new module template supporting roles, formslib etc. (unfinished)
	* http://download.moodle.org/plugins16/mod/NEWMODULE.zip - new module template for versions of Moodle prior to 1.7. Please follow the README instructions inside the zip.		* http://download.moodle.org/plugins16/mod/NEWMODULE.zip - new module template for versions of Moodle prior to 1.7. Please follow the README instructions inside the zip.
Line 47:		Line 48:
	[[Category:Developer\|Modules]]		[[Category:Developer\|Modules]]
	[[Category:Modules]]		[[Category:Modules]]
			[[Category:Tutorial]]

	[[es:Módulos de actividades (desarrollador)]]		[[es:Módulos de actividades (desarrollador)]]

Nakohdo: /* See also */ added link to https://docs.moodle.org/en/Development:NEWMODULE_Documentation

2009-01-23T16:45:13Z

See also: added link to https://docs.moodle.org/en/Development:NEWMODULE_Documentation

← Older revision		Revision as of 16:45, 23 January 2009
Line 33:		Line 33:
	You should also make sure that your activity module provides appropriate support for groups and metacourses.		You should also make sure that your activity module provides appropriate support for groups and metacourses.

	==See also==		== See also ==

	*[[Development:Backup]]		*[[Development:Backup]]
	* Tracker issue [http://tracker.moodle.org/browse/CONTRIB-52 CONTRIB-52 Improvements to make NEWMODULE really useful] - including download link for new module template supporting roles, formslib etc. (unfinished)		* Tracker issue [http://tracker.moodle.org/browse/CONTRIB-52 CONTRIB-52 Improvements to make NEWMODULE really useful] - including download link for new module template supporting roles, formslib etc. (unfinished)
	* http://download.moodle.org/plugins16/mod/NEWMODULE.zip - new module template for versions of Moodle prior to 1.7. Please follow the README instructions inside the zip.		* http://download.moodle.org/plugins16/mod/NEWMODULE.zip - new module template for versions of Moodle prior to 1.7. Please follow the README instructions inside the zip.
			* [[Development:NEWMODULE_Documentation]]

	Using Moodle forum discussions:		Using Moodle forum discussions:

TimHunt at 13:20, 14 December 2008

2008-12-14T13:20:51Z

← Older revision		Revision as of 13:20, 14 December 2008
Line 16:		Line 16:
	:* widget_user_outline() - given an instance, return a summary of a user's contribution		:* widget_user_outline() - given an instance, return a summary of a user's contribution
	:* widget_user_complete() - given an instance, print details of a user's contribution		:* widget_user_complete() - given an instance, print details of a user's contribution
			:* widget_get_view_actions() / widget_get_view_actions() - Used by the participation report (course/report/participation/index.php) to classify actions in the logs table.
	:* Other functions available but not required are:		:* Other functions available but not required are:
	:** widget_delete_course() - code to clean up anything that would be leftover after all instances are deleted		:** widget_delete_course() - code to clean up anything that would be leftover after all instances are deleted

Planetoid at 07:26, 3 December 2008

2008-12-03T07:26:56Z

← Older revision		Revision as of 07:26, 3 December 2008
Line 49:		Line 49:
	[[fr:Modules (développeur)]]		[[fr:Modules (développeur)]]
	[[ja:モジュール (開発者)]]		[[ja:モジュール (開発者)]]
			[[zh:开发:模块_(开发者)]]