Development:Repository plugins - Revision history

Doctorlard: /* Standard repository plugins */

2011-01-06T13:15:21Z

Standard repository plugins

← Older revision		Revision as of 13:15, 6 January 2011
Line 289:		Line 289:
	This is the functional specification list of the officially supported repository plugins.		This is the functional specification list of the officially supported repository plugins.
	For each plugins, the two mains part we are interested in are:		For each plugins, the two mains part we are interested in are:
	* How do I ~~administrate~~ the plugin? See [[Development:Repository_Administration_Specification\| Repository Administration Specification - UC001-3]]		* How do I administer the plugin? See [[Development:Repository_Administration_Specification\| Repository Administration Specification - UC001-3]]
	* How do I set up an account for this repository? See [[Development:Repository_Interface_for_Moodle/Course/User\| Repository Interface for Moodle/Course/User]]		* How do I set up an account for this repository? See [[Development:Repository_Interface_for_Moodle/Course/User\| Repository Interface for Moodle/Course/User]]

Agwells: All the lang directories use "en" rather than "en_utf8" now

2011-01-06T04:31:48Z

All the lang directories use "en" rather than "en_utf8" now

← Older revision		Revision as of 04:31, 6 January 2011
Line 15:		Line 15:
	#* "version.php"		#* "version.php"
	# Create the language file ''repository_myplugin.php'' and add it to the plugin folder, keeping the following folder structure:		# Create the language file ''repository_myplugin.php'' and add it to the plugin folder, keeping the following folder structure:
	#*''moodle/repository/myplugin/lang/~~en_utf8~~/repository_myplugin.php'' or ''moodle/lang/~~en_utf8~~/repository_myplugin.php''		#*''moodle/repository/myplugin/lang/en/repository_myplugin.php'' or ''moodle/lang/en/repository_myplugin.php''
	# Create access.php and upgrade scripts		# Create access.php and upgrade scripts

Dongsheng at 07:39, 5 July 2010

2010-07-05T07:39:33Z

← Older revision		Revision as of 07:39, 5 July 2010
Line 11:		Line 11:
	# Create a folder for your plugin in ''moodle/repository/'' e.g. ''moodle/repository/myplugin''		# Create a folder for your plugin in ''moodle/repository/'' e.g. ''moodle/repository/myplugin''
	# Create the following files and add them to the plugin folder:		# Create the following files and add them to the plugin folder:
	#* ''~~repository.class~~.php''		#* ''lib.php''
	#* ''icon.png'' (the icon displayed in the file picker)		#* ''pix/icon.png'' (the icon displayed in the file picker)
	#* "version.php"		#* "version.php"
	# Create the language file ''repository_myplugin.php'' and add it to the plugin folder, keeping the following folder structure:		# Create the language file ''repository_myplugin.php'' and add it to the plugin folder, keeping the following folder structure:
Line 228:		Line 228:

	Example of dynamically loading		Example of dynamically loading
	See [http://cvs.moodle.org/moodle/repository/alfresco/~~repository.class~~.php?view=log Alfresco] plug-in		See [http://cvs.moodle.org/moodle/repository/alfresco/lib.php?view=log Alfresco] plug-in

	===Functions you can override===		===Functions you can override===

Dongsheng at 03:00, 11 May 2010

2010-05-11T03:00:33Z

← Older revision		Revision as of 03:00, 11 May 2010
Line 173:		Line 173:
	<code php>		<code php>
	array(		array(
	~~// iframe~~
	'iframe' => (string) the url of the iframe, once this option is set, the right panel in file picker will display a iframe instead tree view or thumbnail view, in this mode, plugin developers could design the layout of repository freely, there is a function named repository_downoload_btn, it will display a download button which can help to move files to moodle file system.
	// Used to build navegation bar, so you need to include all parents folders		// Used to build navegation bar, so you need to include all parents folders
	// array(array('name'=>'root','path'=>'/'), array('name'=>'subfolder', 'path'=>'/subfolder'))		// array(array('name'=>'root','path'=>'/'), array('name'=>'subfolder', 'path'=>'/subfolder'))
Line 269:		Line 267:
	====logout====		====logout====
	When a user clicks the logout button in file picker, this function will be called. You may clean up the session or disconnect the connection with remote server here.		When a user clicks the logout button in file picker, this function will be called. You may clean up the session or disconnect the connection with remote server here.
	~~====global_search====~~
	Moodle Repository API supports global search, this function will return a boolean value to tell Moodle if this plugin is ready to search. By default, it will return false - you need to override it to enable global search.
	====print_search====		====print_search====
	When a user clicks the search button on file picker, this function will be called to return a search form. By default, it will create a form with single search bar - you can override it to create a advanced search form.		When a user clicks the search button on file picker, this function will be called to return a search form. By default, it will create a form with single search bar - you can override it to create a advanced search form.

Dongsheng at 07:25, 19 April 2010

2010-04-19T07:25:12Z

← Older revision		Revision as of 07:25, 19 April 2010
Line 13:		Line 13:
	#* ''repository.class.php''		#* ''repository.class.php''
	#* ''icon.png'' (the icon displayed in the file picker)		#* ''icon.png'' (the icon displayed in the file picker)
			#* "version.php"
	# Create the language file ''repository_myplugin.php'' and add it to the plugin folder, keeping the following folder structure:		# Create the language file ''repository_myplugin.php'' and add it to the plugin folder, keeping the following folder structure:
	#*''moodle/repository/myplugin/lang/en_utf8/repository_myplugin.php'' or ''moodle/lang/en_utf8/repository_myplugin.php''		#*''moodle/repository/myplugin/lang/en_utf8/repository_myplugin.php'' or ''moodle/lang/en_utf8/repository_myplugin.php''
			# Create access.php and upgrade scripts

	===Overview===		===Overview===

Dongsheng: /* get_listing($path="", $page="") */

2009-05-07T06:01:53Z

get_listing($path="", $page="")

← Older revision		Revision as of 06:01, 7 May 2009
Line 178:		Line 178:
	// dynload tells file picker to fetch list dynamically, when user click		// dynload tells file picker to fetch list dynamically, when user click
	// the folder, it will send a ajax request to server side.		// the folder, it will send a ajax request to server side.
			// if you are using pagination, 'page' and 'pages' parameters should be used
			// and note, you'd better don't use pagination and page at the same time
			'page' => (int) which page is this list
			'pages' => (pages) how many pages
	'dynload' => (bool) use dynamic loading,		'dynload' => (bool) use dynamic loading,
	// will display a link in file picker		// will display a link in file picker

Dongsheng: /* get_listing($path="", $page="") */

2009-04-22T04:27:29Z

get_listing($path="", $page="")

← Older revision		Revision as of 04:27, 22 April 2009
Line 173:		Line 173:
	// iframe		// iframe
	'iframe' => (string) the url of the iframe, once this option is set, the right panel in file picker will display a iframe instead tree view or thumbnail view, in this mode, plugin developers could design the layout of repository freely, there is a function named repository_downoload_btn, it will display a download button which can help to move files to moodle file system.		'iframe' => (string) the url of the iframe, once this option is set, the right panel in file picker will display a iframe instead tree view or thumbnail view, in this mode, plugin developers could design the layout of repository freely, there is a function named repository_downoload_btn, it will display a download button which can help to move files to moodle file system.
	// ~~the current~~ path		// Used to build navegation bar, so you need to include all parents folders
			// array(array('name'=>'root','path'=>'/'), array('name'=>'subfolder', 'path'=>'/subfolder'))
	'path' => (array) this will be used to build navigation bar		'path' => (array) this will be used to build navigation bar
	// dynload tells file picker to fetch list dynamically, when user click		// dynload tells file picker to fetch list dynamically, when user click

Dongsheng: /* get_listing($path="", $page="") */

2009-04-22T04:25:21Z

get_listing($path="", $page="")

← Older revision		Revision as of 04:25, 22 April 2009
Line 159:		Line 159:
	<code php>		<code php>
	$list = array(		$list = array(
	'path'=>'/~~var/repo~~/',		//this will be used to build navigation bar
			'path'=>array(array('name'=>'root','path'=>'/'), array('name'=>'subfolder', 'path'=>'/subfolder')),
	'manage'=>'http://webmgr.moodle.com',		'manage'=>'http://webmgr.moodle.com',
	'list'=> array(		'list'=> array(
Line 167:		Line 168:
	);		);
	</code>		</code>
	'''The full specification:'''		'''The full specification of list element:'''
	<code php>		<code php>
	array(		array(
Line 173:		Line 174:
	'iframe' => (string) the url of the iframe, once this option is set, the right panel in file picker will display a iframe instead tree view or thumbnail view, in this mode, plugin developers could design the layout of repository freely, there is a function named repository_downoload_btn, it will display a download button which can help to move files to moodle file system.		'iframe' => (string) the url of the iframe, once this option is set, the right panel in file picker will display a iframe instead tree view or thumbnail view, in this mode, plugin developers could design the layout of repository freely, there is a function named repository_downoload_btn, it will display a download button which can help to move files to moodle file system.
	// the current path		// the current path
	'path' => (~~string~~) ~~path for the current folder~~		'path' => (array) this will be used to build navigation bar
	// dynload tells file picker to fetch list dynamically, when user click		// dynload tells file picker to fetch list dynamically, when user click
	// the folder, it will send a ajax request to server side.		// the folder, it will send a ajax request to server side.

Dongsheng: /* File picker APIs */

2009-04-21T09:49:55Z

File picker APIs

← Older revision		Revision as of 09:49, 21 April 2009
Line 155:		Line 155:
	# Get user name and password from HTTP POST		# Get user name and password from HTTP POST

	====get_listing($path="")====		====get_listing($path="", $page="")====
	This function will return a list of files, the list must be a array like this:		This function will return a list of files, the list must be a array like this:
	<code php>		<code php>
Line 186:		Line 186:
	// only used in upload plugin currently		// only used in upload plugin currently
	'upload' => array( // upload manager		'upload' => array( // upload manager
	'~~name~~' => (string) label of the form element,		'label' => (string) label of the form element,
	'id' => (string) id of the form element		'id' => (string) id of the form element
	),		),
Line 194:		Line 194:
	array( // file		array( // file
	'title' => (string) file name,		'title' => (string) file name,
			'shorttitle' => (string) optional, if you prefer to display a short title
	'date' => (string) file last modification time, usually userdate(...),		'date' => (string) file last modification time, usually userdate(...),
	'size' => (int) file size,		'size' => (int) file size,
Line 203:		Line 204:
	array( // folder - same as file, but no 'source'.		array( // folder - same as file, but no 'source'.
	'title' => (string) folder name,		'title' => (string) folder name,
			'shorttitle' => (string) optional, if you prefer to display a short title
	'path' => (string) path to this folder		'path' => (string) path to this folder
	'date' => (string) folder last modification time, usually userdate(...),		'date' => (string) folder last modification time, usually userdate(...),
Line 242:		Line 244:
	$ret = array();		$ret = array();
	$ret['login'] = array($user_field, $passwd_field);		$ret['login'] = array($user_field, $passwd_field);
			// if you are going to rename submit button label, use this option
			//$ret['login_btn_label'] = get_string('submit_btn_label');
			// if you are going to display a search form instead of login form
			// set this option to true
			//$ret['login_search_form'] = true;
	return $ret;		return $ret;
	}		}

Jmouneyrac: /* Functional specifications */

2009-04-06T03:31:32Z

Functional specifications

← Older revision		Revision as of 03:31, 6 April 2009
Line 284:		Line 284:
	*[[Development:Box.net Repository Plugin\|Box.net Repository Plugin]]		*[[Development:Box.net Repository Plugin\|Box.net Repository Plugin]]
	*[[Development:Flickr Repository Plugin\|Flickr Repository Plugin]]		*[[Development:Flickr Repository Plugin\|Flickr Repository Plugin]]
	*[[Development:Moodle Repository Plugin\|Moodle ~~Local Repository Plugin]]~~		*[[Development:Moodle Repository Plugin\|Remote Moodle Repository Plugin]]
	*[[Development:MNET Repository Plugin\|Moodle MNET Repository Plugin]]

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

← Older revision		Revision as of 03:31, 6 April 2009
Line 284:		Line 284:
	*[[Development:Box.net Repository Plugin\|Box.net Repository Plugin]]		*[[Development:Box.net Repository Plugin\|Box.net Repository Plugin]]
	*[[Development:Flickr Repository Plugin\|Flickr Repository Plugin]]		*[[Development:Flickr Repository Plugin\|Flickr Repository Plugin]]
	*[[Development:Moodle Repository Plugin\|Moodle ~~Local Repository Plugin]]~~		*[[Development:Moodle Repository Plugin\|Remote Moodle Repository Plugin]]
	*[[Development:MNET Repository Plugin\|Moodle MNET Repository Plugin]]

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