Development:Repository API - Revision history

Odoardo: /* Repository plugins */

2010-11-03T10:48:27Z

Repository plugins

← Older revision		Revision as of 10:48, 3 November 2010
Line 122:		Line 122:
	* myspace - an interface to MySpace files (perhaps via [http://www.programmableweb.com/api/myspace this MySpace API])		* myspace - an interface to MySpace files (perhaps via [http://www.programmableweb.com/api/myspace this MySpace API])
	* skydrive - an interface to Microsoft's [http://skydrive.live.com/ SkyDrive] files		* skydrive - an interface to Microsoft's [http://skydrive.live.com/ SkyDrive] files
			* Dropbox - an interface to Dropbox files [http://www.dropbox.com]
	* facebook - an interface to Facebook files		* facebook - an interface to Facebook files
	* [http://www.dspace.org/ Dspace] - a repository from MIT		* [http://www.dspace.org/ Dspace] - a repository from MIT

Dongsheng: fixed syntax

2010-05-11T02:59:03Z

fixed syntax

← Older revision		Revision as of 02:59, 11 May 2010
Line 389:		Line 389:
	get option list or a specific option from database		get option list or a specific option from database

	====get_type_option_names====		====get_type_option_names()====
	If this plugin needs admin settings, please refine this function to return option names.		If this plugin needs admin settings, please refine this function to return option names.

	====type_config_form====		====type_config_form()====
	If get_type_option_names return non empty array, this function '''MUST''' redefine, it will help to build the setting form.		If get_type_option_names return non empty array, this function '''MUST''' redefine, it will help to build the setting form.

	====get_instance_option_names====		====get_instance_option_names()====
	If plugin instance needs settings, this function will return instance option names.		If plugin instance needs settings, this function will return instance option names.

	====instance_config_form====		====instance_config_form()====
	If get_instance_option_names return non empty array, this function '''MUST''' redefine, it will help to build the instance setting form.		If get_instance_option_names return non empty array, this function '''MUST''' redefine, it will help to build the instance setting form.


	====supported_filetypes====		====supported_filetypes()====
	What file types are supported by this repository plugin, it will return an array, the file type name is defined in a [http://freemind.sourceforge.net/wiki/index.php/Main_Page freemind] file in lib/file/file_types.mm		What file types are supported by this repository plugin, it will return an array, the file type name is defined in a [http://freemind.sourceforge.net/wiki/index.php/Main_Page freemind] file in lib/file/file_types.mm

	====supported_returntypes====		====supported_returntypes()====
	The repository plugin could support external link or copying files to moodle. If the plugin support file link only, developer should override this function to return FILE_EXTERNAL, if plugin support copying file only, it should return FILE_INTERNAL, by default, plugin supports both.		The repository plugin could support external link or copying files to moodle. If the plugin support file link only, developer should override this function to return FILE_EXTERNAL, if plugin support copying file only, it should return FILE_INTERNAL, by default, plugin supports both.

	====filter====		====filter()====
	Filter file listing to exclude specific file types		Filter file listing to exclude specific file types

Dongsheng: update

2010-05-11T02:58:06Z

update

Show changes

Dongsheng: api changed

2009-06-03T08:50:46Z

api changed

← Older revision		Revision as of 08:50, 3 June 2009
Line 366:		Line 366:
	Print the search form, it will return a json string		Print the search form, it will return a json string

	====~~ajax_info~~()====		====get_meta()====
	Return information for creating ajax request, it is private function, you don't need to rewrite it.		Return information for creating ajax request, it is private function, you don't need to rewrite it.

Dongsheng: /* class repository() */

2009-04-21T09:41:11Z

class repository()

← Older revision		Revision as of 09:41, 21 April 2009
Line 344:		Line 344:
	Repositories can redefine any of these methods as required (and in some instances, MUST redefine them):		Repositories can redefine any of these methods as required (and in some instances, MUST redefine them):

	====__construct($repositoryid, $contextid, $options=array())====		====__construct($repositoryid, $contextid, $options=array(), $readonly)====

	'''MUST''' redefine		'''MUST''' redefine
Line 350:		Line 350:
	Accept necessary parameters, and do initialization of repository.		Accept necessary parameters, and do initialization of repository.

	====get_file($url)====		====get_file($url, $file = '')====

	Given a URL, download a file from there, save the file in a temporary directory.		Given a URL, download a file from there, save the file in a temporary directory.

	====get_listing($~~parent~~='/', $~~search~~='''''''')====		====get_listing($path='/', $page='''''''')====

	Given a path, and perhaps a search, get a listing of files. In the case of AJAX file picker, this function should return json format Javascript array.		Given a path, and perhaps a search, get a listing of files. In the case of AJAX file picker, this function should return json format Javascript array.

	====print_login()====		====print_login()====

	~~'''MUST''' redefine~~

	Show the login screen, if required. In the case of AJAX file picker, this function should return json format array which defined the login form.		Show the login screen, if required. In the case of AJAX file picker, this function should return json format array which defined the login form.

	~~====print_listing====~~

	~~Get a listing from get_listing, print it or return HTML code.~~

	====print_search====		====print_search====

	~~'''MUST''' redefine~~		Print the search form, it will return a json string

	Print the search form

	~~@TODO:~~
	~~Think about are we really need~~ it?

	~~====store_login($username, $password, $userid='''''''')====~~

	~~If you do want to cache login details for various repositories, then use this method.~~

	~~====cron()====~~

	~~Defines operations that happen occasionally on cron.~~

	====ajax_info()====		====ajax_info()====
	Return information for creating ajax request		Return information for creating ajax request, it is private function, you don't need to rewrite it.

	====create()====		====create()====

Kyke01 at 10:16, 29 January 2009

2009-01-29T10:16:32Z

← Older revision		Revision as of 10:16, 29 January 2009
Line 123:		Line 123:
	* youtube - an interface to [http://youtube.com YouTube]		* youtube - an interface to [http://youtube.com YouTube]
	* mahara - an interface to a Mahara installation		* mahara - an interface to a Mahara installation
	* Dspace - a repository from MIT		* [http://www.dspace.org/ Dspace] - a repository from MIT
	* DOOR - another popular open source repository		* DOOR - another popular open source repository
	* SMB shares - An interface for windows shares e.g. personal folders on network drives. Would need to link with LDAP as usernames will often be wholly/partially the same as network folder names. This could be done using SAMBA, but would also need to work on windows machines natively. See [http://moodle.org/mod/data/view.php?d=13&rid=991 this block] for a linux implementation.		* SMB shares - An interface for windows shares e.g. personal folders on network drives. Would need to link with LDAP as usernames will often be wholly/partially the same as network folder names. This could be done using SAMBA, but would also need to work on windows machines natively. See [http://moodle.org/mod/data/view.php?d=13&rid=991 this block] for a linux implementation.

Mits: ja link

2008-12-31T22:11:45Z

ja link

← Older revision		Revision as of 22:11, 31 December 2008
Line 429:		Line 429:

	[[Category:Repositories]]		[[Category:Repositories]]

			[[ja:開発:リポジトリAPI]]

Tsala: category

2008-09-25T06:43:38Z

Tsala: /* See also */ tracker issue links

2008-09-22T08:26:23Z

Dougiamas: /* See also */

2008-09-17T02:12:33Z

← Older revision		Revision as of 06:43, 25 September 2008
Line 427:		Line 427:
	* [[Development:Portfolio API]]		* [[Development:Portfolio API]]
	* MDL-13766 and MDL-16543 Repository API Meta issues		* MDL-13766 and MDL-16543 Repository API Meta issues

			[[Category:Repositories]]

← Older revision		Revision as of 08:26, 22 September 2008
Line 426:		Line 426:
	* [[Development:File API]]		* [[Development:File API]]
	* [[Development:Portfolio API]]		* [[Development:Portfolio API]]
			* MDL-13766 and MDL-16543 Repository API Meta issues

← Older revision		Revision as of 02:12, 17 September 2008
Line 422:		Line 422:
	* [[Development:Repository Administration Specification]]		* [[Development:Repository Administration Specification]]
	* [[Development:Repository Interface for Moodle/Course/User]]		* [[Development:Repository Interface for Moodle/Course/User]]
	* [[Development:Repository ~~Plugins]]~~		* [[Development:Repository plugins]]
	* [[Development:Repository How to Create Plugin]]
	* [[Development:Repository File Picker]]		* [[Development:Repository File Picker]]
	* [[Development:File API]]		* [[Development:File API]]
	* [[Development:Portfolio API]]		* [[Development:Portfolio API]]