Repository plugins embedding external file chooser: Difference between revisions
mNo edit summary |
|||
| Line 3: | Line 3: | ||
The Equella plugin is an example of doing this. | The Equella plugin is an example of doing this. | ||
=get_listing= | ==get_listing== | ||
The returned array should return an 'object' element, containing the following: | The returned array should return an 'object' element, containing the following: | ||
* type - a string with the mime type of the item to display (e.g. 'text/html', 'application/x-shockwave-flash') | * type - a string with the mime type of the item to display (e.g. 'text/html', 'application/x-shockwave-flash') | ||
| Line 54: | Line 54: | ||
Note particularly the object param with the '''type''' and '''src''' elements and the presence of the '''callbackurl''' in the parameters passed to Equella. This is covered in more detail in the section below. | Note particularly the object param with the '''type''' and '''src''' elements and the presence of the '''callbackurl''' in the parameters passed to Equella. This is covered in more detail in the section below. | ||
=updating the filepicker= | ==updating the filepicker== | ||
''TODO: complete this'' | ''TODO: complete this'' | ||
=See also= | ==See also== | ||
*[[Repository plugins]] | *[[Repository plugins]] | ||
Revision as of 12:00, 5 December 2012
By making use of the 'object' tag within the return of the 'get_listing' function, Repository plugins are able to embed an external file chooser within the repository panel. This allows for more customisation of the interface, than is allowed by simply returning a list of the available files. The Equella plugin is an example of doing this.
get_listing
The returned array should return an 'object' element, containing the following:
- type - a string with the mime type of the item to display (e.g. 'text/html', 'application/x-shockwave-flash')
- url - a string with the website address to embed in the object
This will replace the usual filepicker list of files with an OBJECT html tag:
<object type="[type]" src="[url]" />
An example of generating this can be found in the Equella plugin:
public function get_listing($path = null, $page = null) {
global $COURSE;
$callbackurl = new moodle_url('/repository/equella/callback.php', array('repo_id'=>$this->id));
$mimetypesstr = ;
$restrict = ;
if (!empty($this->mimetypes)) {
$mimetypesstr = '&mimeTypes=' . implode(',', $this->mimetypes);
// We're restricting to a mime type, so we always restrict to selecting resources only.
$restrict = '&attachmentonly=true';
} else if ($this->get_option('equella_select_restriction') != 'none') {
// The option value matches the EQUELLA paramter name.
$restrict = '&' . $this->get_option('equella_select_restriction') . '=true';
}
$url = $this->get_option('equella_url')
. '?method=lms'
. '&returnurl='.urlencode($callbackurl)
. '&returnprefix=tle'
. '&template=standard'
. '&token='.urlencode($this->getssotoken('write'))
. '&courseId='.urlencode($COURSE->idnumber)
. '&courseCode='.urlencode($COURSE->shortname)
. '&action=searchThin'
. '&forcePost=true'
. '&cancelDisabled=true'
. '&attachmentUuidUrls=true'
. '&options='.urlencode($this->get_option('equella_options') . $mimetypesstr)
. $restrict;
$list = array();
$list['object'] = array();
$list['object']['type'] = 'text/html';
$list['object']['src'] = $url;
$list['nologin'] = true;
$list['nosearch'] = true;
$list['norefresh'] = true;
return $list;
}
Note particularly the object param with the type and src elements and the presence of the callbackurl in the parameters passed to Equella. This is covered in more detail in the section below.
updating the filepicker
TODO: complete this
