$string['activeexport'] = 'Resolve active export';
$string['alreadyexporting'] = 'You already have an active portfolio export in this session. Before continuing, you must either complete this export, or cancel it. Would you like to continue it? (No will cancel it)';
$string['availableformats'] = 'Available export formats';
+$string['callbackclassinvalid'] = 'Callback class specified was invalid or not part of the portfolio_caller hierarchy';
$string['callercouldnotpackage'] = 'Failed to package up your data for export: original error was $a';
$string['cannotsetvisible'] = 'Cannot set this to visible - the plugin has been completely disabled because of a misconfiguration';
$string['configexport'] = 'Configure exported data';
public abstract function load_data();
+ /**
+ * set up the required files for this export.
+ * this supports either passing files directly
+ * or passing area arguments directly through
+ * to the files api using file_storage::get_area_files
+ *
+ * @param mixed $ids one of:
+ * - single file id
+ * - single stored_file ojbect
+ * - array of file ids or stored_file objects
+ * - null
+ * @param int $contextid (optional), passed to {@link see file_storage::get_area_files}
+ * @param string $filearea (optional), passed to {@link see file_storage::get_area_files}
+ * @param int $itemid (optional), passed to {@link see file_storage::get_area_files}
+ * @param string $sort (optional), passed to {@link see file_storage::get_area_files}
+ * @param bool $includedirs (optional), passed to {@link see file_storage::get_area_files}
+ */
public function set_file_and_format_data($ids=null /* ..pass arguments to area files here. */) {
$args = func_get_args();
array_shift($args); // shift off $ids
}
}
+ /**
+ * array of arguments the caller expects to be passed through to it
+ * this must be keyed on the argument name, and the array value is a boolean,
+ * whether it is requrired, or just optional
+ * eg array(
+ * id => true,
+ * somethingelse => false,
+ * )
+ *
+ * @return array
+ */
public static abstract function expected_callbackargs();
}
*
* @param string $content content to write
* @param string $name filename to use
+ * @param bool $maifest whether this is the main file or an secondary file (eg attachment)
* @return new stored_file object
*/
public function write_new_file($content, $name, $manifest=true) {
* the most basic type - pretty much everything is a subtype
*/
class portfolio_format_file {
+
+ /**
+ * array of mimetypes this format supports
+ */
public static function mimetypes() {
return array(null);
}
+ /**
+ * for multipart formats, eg html with attachments,
+ * we need to have a directory to place associated files in
+ * inside the zip file. this is the name of that directory
+ */
public static function get_file_directory() {
return null;
}
+ /**
+ * given a file, return a snippet of markup in whatever format
+ * to link to that file.
+ * usually involves the path given by {@link get_file_directory}
+ */
public static function file_output($file) {
return '';
}
* image format, subtype of file.
*/
class portfolio_format_image extends portfolio_format_file {
+ /**
+ * return all mimetypes that use image.gif (eg all images)
+ */
public static function mimetypes() {
return mimeinfo_from_icon('type', 'image.gif', true);
}
/**
* video format, subtype of file.
*
-* I guess there could be a youtube/google video plugin
-* and anyway, the flickr plugin can support it already
+* for portfolio plugins that support videos specifically
*/
class portfolio_format_video extends portfolio_format_file {
public static function mimetypes() {
return array_merge(
- mimeinfo_from_icon('type', 'video.gif', true),
- mimeinfo_from_icon('type', 'avi.gif', true)
- );
+ mimeinfo_from_icon('type', 'video.gif', true),
+ mimeinfo_from_icon('type', 'avi.gif', true)
+ );
}
}
}
}
+/**
+ * base class for rich formats.
+ * these are multipart - eg things with attachments
+ */
class portfolio_format_rich {
public static function mimetypes() {
return array(null);
}
}
+/**
+ * most commonly used rich format - richhtml - html with attachments
+ * eg inline images
+ */
class portfolio_format_richhtml extends portfolio_format_rich {
public static function get_file_directory() {
return 'site_files';
*/
public abstract function is_push();
+ /**
+ * returns the user-friendly name for this plugin
+ * usually just get_string('pluginname', 'portfolio_something')
+ *
+ * @return string
+ */
public static abstract function get_name();
/**
* if this function returns something non empty, ALL instances of your plugin
* will be set to invisble and not be able to be set back until it's fixed
*
- * @return mixed - string = error string KEY (must be inside plugin_$yourplugin) or 0/false if you're ok
+ * @return mixed - string = error string KEY (must be inside portfolio_$yourplugin) or 0/false if you're ok
*/
public static function plugin_sanity_check() {
return 0;
* if this function returns something non empty, the instance will be
* set to invislbe and not be able to be set back until it's fixed.
*
- * @return mixed - string = error string KEY (must be inside plugin_$yourplugin) or 0/false if you're ok
+ * @return mixed - string = error string KEY (must be inside portfolio_$yourplugin) or 0/false if you're ok
*/
public function instance_sanity_check() {
return 0;
return true;
}
+ /**
+ * return array of mnet methods, keyed by service (pf)
+ * in the same format used everywhere else in moodle.
+ * see the mahara portfolio plugin for an example
+ */
public static function mnet_publishes() {
return array();
}
projects / moodle.git / commitdiff