Repository API - Revision history

Devdocsbot: Update migration status and path

2022-06-24T14:03:53Z

Update migration status and path

← Older revision		Revision as of 14:03, 24 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/plugintypes/repository}}
	#REDIRECT [[Repository plugins]]		#REDIRECT [[Repository plugins]]

Andrewnicols: Protected "Repository API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-23T04:15:34Z

Protected "Repository API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 04:15, 23 June 2022
(No difference)

Dougiamas: Redirected page to Repository plugins

2012-07-05T07:23:45Z

Redirected page to Repository plugins

Show changes

Doctorlard at 23:59, 28 June 2012

2012-06-28T23:59:46Z

← Older revision		Revision as of 23:59, 28 June 2012
Line 105:		Line 105:
	# Provide copyright and usage rules (or just information about the rules)		# Provide copyright and usage rules (or just information about the rules)

	==~~Repository~~ plugins==		==Suggested repository plugins==

	Some plugins I'd like to see developed for the first version are:		Some plugins I'd like to see developed for the first version are:
Line 337:		Line 337:

	==Repository plugins==		==Repository plugins==

			For a more detailed specification of the API for developers, see [[Repository plugins]].

	===Required elements===		===Required elements===

Bobpuffer: /* CAN'T FIND THIS DIRECTORY */

2012-05-17T23:58:20Z

CAN'T FIND THIS DIRECTORY

← Older revision		Revision as of 23:58, 17 May 2012
Line 416:		Line 416:
	====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] '''CAN'T FIND THIS DIRECTORY''' 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] '''CAN'T FIND THIS DIRECTORY''' file in lib/file/file_types.mm

	~~== '''CAN'T FIND THIS DIRECTORY''' ==~~
	~~file in lib/file/file_types.mm~~

	====supported_returntypes()====		====supported_returntypes()====

Bobpuffer: /* supported_filetypes() */

2012-05-17T23:57:30Z

supported_filetypes()

← Older revision		Revision as of 23:57, 17 May 2012
Line 415:		Line 415:

	====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]		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] '''CAN'T FIND THIS DIRECTORY''' file in lib/file/file_types.mm

	== '''CAN'T FIND THIS DIRECTORY''' ==		== '''CAN'T FIND THIS DIRECTORY''' ==
	file in lib/file/file_types.mm		file in lib/file/file_types.mm

Bobpuffer: /* supported_filetypes() */

2012-05-17T23:54:35Z

supported_filetypes()

← Older revision		Revision as of 23:54, 17 May 2012
Line 415:		Line 415:

	====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] CAN'T FIND THIS DIRECTORY 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]
			== '''CAN'T FIND THIS DIRECTORY''' ==
			file in lib/file/file_types.mm

	====supported_returntypes()====		====supported_returntypes()====

Bobpuffer: /* supported_filetypes() */

2012-05-17T23:51:24Z

supported_filetypes()

← Older revision		Revision as of 23:51, 17 May 2012
Line 415:		Line 415:

	====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] CAN'T FIND THIS DIRECTORY file in lib/file/file_types.mm

	====supported_returntypes()====		====supported_returntypes()====

Dongsheng: /* supported_returntypes() */

2012-04-26T08:20:16Z

supported_returntypes()

← Older revision		Revision as of 08:20, 26 April 2012
Line 418:		Line 418:

	====supported_returntypes()====		====supported_returntypes()====
	The repository plugin could ~~support~~ external link, ~~copying~~ files to moodle, create a file ~~reference~~ to external repository. 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, if ~~support create~~ file ~~reference~~ only, it returns FILE_REFERENCE. If repository ~~support~~ more than one return types, use bit operation, for example <code php>return FILE_INTERNAL \| FILE_REFERENCE;</code>		The repository plugin could return external link, copy files to moodle or create file references to external repository. If the plugin supports file links only, developer should override this function to return FILE_EXTERNAL, if the plugin supports copying files only, it should return FILE_INTERNAL, if supports creating file references only, it returns FILE_REFERENCE. If repository supports more than one return types, use bit operation, for example <code php>return FILE_INTERNAL \| FILE_REFERENCE;</code>

	On the other hand, form elements filemanager and filepicker can indicate what types of file ~~are~~ accepted, for example, in assignment module, only ~~FILE_INTERNAL~~ accepted (to prevent cheating), so when adding filemanager element: <code php>$options['return_types'] = FILE_INTERNAL;</code>~~, moodle~~ 2.3 onward, filemanager's default return_types is FILE_INTERNAL \| FILE_REFERENCE		On the other hand, form elements, such as filemanager and filepicker can indicate what types of file can be accepted, for example, in assignment module, only copying file is accepted (to prevent cheating), so when adding filemanager element to moodle form, we use this option: <code php>$options['return_types'] = FILE_INTERNAL;</code>

			Moodle 2.3 onward, filemanager's default return_types is FILE_INTERNAL \| FILE_REFERENCE

	====filter()====		====filter()====

Dongsheng: /* supported_returntypes() */

2012-04-26T08:17:25Z

supported_returntypes()

← Older revision		Revision as of 08:17, 26 April 2012
Line 418:		Line 418:

	====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, copying files to moodle, create a file reference to external repository. 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, if support create file reference only, it returns FILE_REFERENCE. If repository support more than one return types, use bit operation, for example <code php>return FILE_INTERNAL \| FILE_REFERENCE;</code>

			On the other hand, form elements filemanager and filepicker can indicate what types of file are accepted, for example, in assignment module, only FILE_INTERNAL accepted (to prevent cheating), so when adding filemanager element: <code php>$options['return_types'] = FILE_INTERNAL;</code>, moodle 2.3 onward, filemanager's default return_types is FILE_INTERNAL \| FILE_REFERENCE

	====filter()====		====filter()====