Class to inherit from for 'pull' type plugins. More...

Inheritance diagram for portfolio_plugin_pull_base:

Public Member Functions
	cleanup ()
	Perform any required cleanup functions.

	delete ()
	Deletes everything from the database about this plugin instance.

	expected_time ($callertime)
	How long does this reasonably expect to take.

	export_config_form (&$mform)
	mform to display to the user exporting data using this plugin.

	export_config_validation (array $data)
	Just like the moodle form validation function.

	get ($field)
	Generic getter for properties belonging to this instance outside the subclasses like name, visible etc.

	get_allowed_export_config ()
	A list of fields that can be configured by the user.

	get_allowed_user_config ()
	A list of fields that can be configured by the user.

	get_base_file_url ()
	The base part of the download file url to pull files from your plugin might need to add &foo=bar on the end.

	get_config ($key)
	Gets the value of a particular config item.

	get_export_config ($key)
	Gets an export time config value.

	get_export_summary ()
	After the user submits their config, they're given a confirm screen summarising what they've chosen.

	get_extra_finish_options ()
	Once everything is done and the user has the finish page displayed to them.

	get_interactive_continue_url ()
	The url for the user to continue to their portfolio during the lifecycle of the request.

	get_static_continue_url ()
	The url to save in the log as the continue url.

	get_user_config ($key, $userid=0)
	Get the value of a config item for a particular user.

	has_export_config ()
	Does this plugin need configuration during export time? If you override this to return true, you must implement export_config_form.

	has_user_config ()
	Can this plugin be configured by the user in their profile? If you override this to return true, you must implement user_config_form.

	heading_summary ()
	Return a string to put at the header summarising this export by default, just the plugin instance name.

	instance_sanity_check ()
	Check sanity of instances.

	is_push ()
	return the enablelity to push

	post_control ($stage, $params)
	After a plugin has elected to steal control, and control returns to portfolio/add.php\|postcontrol=1, this function is called, and passed the stage that was stolen control from and the request (get and post but not cookie) parameters.

	prepare_package ()
	Called after the caller has finished having control of its prepare_package function.

	resolve_static_continue_url ($url)
	Override this function if you need to add something on to the url for post-export continues (eg from the log page).

	save ()
	Saves stuff that's been stored in the object to the database.

	send_file ()
	Called from portfolio/file.php.

	send_package ()
	This is the function that is responsible for sending the package to the remote system, or whatever request is necessary to initiate the transfer.

	set ($field, $value)
	Generic setter for properties belonging to this instance outside the subclass like name, visible, etc.

	set_config ($config)
	Saves (or updates) the config stored in portfolio_instance_config.

	set_export_config ($config)
	Sets the export time config from the moodle form.

	set_user_config ($config, $userid=0)
	Sets config options for a given user.

	steal_control ($stage)
	If at any point the caller wants to steal control, it can, by returning something that isn't false in this function The controller will redirect to whatever url this function returns.

	supported_formats ()
	Array of formats this portfolio supports the intersection of what this function returns and what the caller supports will be used.

	user_config_form (&$mform)
	mform to display to the user in their profile if your plugin can't be configured by the user,

	user_config_validation (array $data)
	Just like the moodle form validation function.

	verify_file_request_params ($params)
	Before sending the file when the pull is requested, verify the request parameters.

Static Public Member Functions
static	admin_config_form (&$mform)
	mform to display to the admin configuring the plugin.

static	admin_config_validation ($data)
	Just like the moodle form validation function, this is passed in the data array from the form and if a non empty array is returned, form processing will stop.

static	allows_multiple_exports ()
	Whether this plugin supports multiple exports in the same session most plugins should handle this, but some that require a redirect for authentication and then don't support dynamically constructed urls to return to (eg box.net) need to override this to return false.

static	allows_multiple_instances ()
	Override this if your plugin doesn't allow multiple instances.

static	create_instance ($plugin, $name, $config)
	This function creates a new instance of a plugin saves it in the database, saves the config and returns it.

static	file_mime_check ($mimetype)
	Override this if you are supporting the 'file' type (or a subformat) but have restrictions on mimetypes.

static	get_allowed_config ()
	A list of fields that can be configured per instance.

static	get_name ()
	Returns the user-friendly name for this plugin.

static	has_admin_config ()
	Does this plugin need any configuration by the administrator? If you override this to return true, you must implement admin_config_form.

static	plugin_sanity_check ()
	Check sanity of plugin.

Protected Member Functions
	get_file ()
	Gets the stored_file object from the file id in the $file instance var.

	init ()
	Called after __construct - allows plugins to perform initialisation tasks without having to override the constructor.

	set_file (\stored_file $file)
	Sets the $file instance var to the id of the supplied stored_file.

Protected Attributes
stdClass	$config
	admin configured config use {

bool	$dirty
	whether this object needs writing out to the database

array	$exportconfig
	export config during export use get_export_config and setexport_config to access.

stdClass	$exporter
	a reference to the exporter object

int	$file
	$file the id of a single file

integer	$id
	id of instance

string	$name
	name of instance

string	$plugin
	plugin this instance belongs to

stdClass	$user
	user currently exporting data

array	$userconfig
	user config cache.

bool	$visible
	whether this instance is visible or not

Detailed Description

Class to inherit from for 'pull' type plugins.

Eg: those that write a file and wait for the remote system to request it from portfolio/file.php. If you're using this you must do $this->set('file', $file) so that it can be served.

Copyright: 2008 Penny Leach penny.nosp@m.@cat.nosp@m.alyst.nosp@m..net.nosp@m..nz

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ admin_config_form()

static portfolio_plugin_base::admin_config_form ( & $mform )

staticinherited

mform to display to the admin configuring the plugin.

If your plugin can't be configured by the admin,

See also: has_admin_config Don't bother overriding this function. This function can be called statically or non statically, depending on whether it's creating a new instance (statically), or editing an existing one (non statically)

Parameters

moodleform $mform passed by reference, add elements to it.

Reimplemented in portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ admin_config_validation()

static portfolio_plugin_base::admin_config_validation ( $data )

staticinherited

Just like the moodle form validation function, this is passed in the data array from the form and if a non empty array is returned, form processing will stop.

Parameters

array $data data from form.

◆ allows_multiple_exports()

static portfolio_plugin_base::allows_multiple_exports ( )

staticinherited

Whether this plugin supports multiple exports in the same session most plugins should handle this, but some that require a redirect for authentication and then don't support dynamically constructed urls to return to (eg box.net) need to override this to return false.

This means that moodle will prevent multiple exports of this type of plugin occurring in the same session.

Return values

bool

Reimplemented in portfolio_plugin_flickr.

◆ allows_multiple_instances()

static portfolio_plugin_base::allows_multiple_instances ( )

staticinherited

Override this if your plugin doesn't allow multiple instances.

Return values

bool

Reimplemented in portfolio_plugin_download, portfolio_plugin_flickr, and portfolio_plugin_googledocs.

◆ cleanup()

portfolio_plugin_base::cleanup ( )

inherited

Perform any required cleanup functions.

Return values

bool

Reimplemented in portfolio_plugin_mahara.

◆ create_instance()

static portfolio_plugin_base::create_instance	(	$plugin,
		$name,
		$config )

staticinherited

This function creates a new instance of a plugin saves it in the database, saves the config and returns it.

You shouldn't need to override it unless you're doing something really funky

Parameters

string	$plugin	portfolio plugin to create
string	$name	name of new instance
array	$config	what the admin config form returned

Return values

object subclass of portfolio_plugin_base

◆ delete()

portfolio_plugin_base::delete ( )

inherited

Deletes everything from the database about this plugin instance.

You shouldn't need to override this unless you're storing stuff in your own tables. and if so, call parent\delete when you're done.

Return values

bool

◆ expected_time()

portfolio_plugin_base::expected_time ( $callertime )

abstractinherited

How long does this reasonably expect to take.

Should we offer the user the option to wait.. This is deliberately nonstatic so it can take filesize into account

Parameters

string $callertime - what the caller thinks the portfolio plugin instance is given the final say because it might be (for example) download.

Reimplemented in portfolio_plugin_download, portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ export_config_form()

portfolio_plugin_base::export_config_form ( & $mform )

inherited

mform to display to the user exporting data using this plugin.

If your plugin doesn't need user input at this time,

See also: has_export_config. Don't bother overrideing this function

Parameters

moodleform $mform passed by reference, add elements to it.

Reimplemented in portfolio_plugin_flickr.

◆ export_config_validation()

portfolio_plugin_base::export_config_validation ( array $data )

inherited

Just like the moodle form validation function.

This is passed in the data array from the form and if a non empty array is returned, form processing will stop.

Parameters

array $data data from form.

◆ file_mime_check()

static portfolio_plugin_base::file_mime_check ( $mimetype )

staticinherited

Override this if you are supporting the 'file' type (or a subformat) but have restrictions on mimetypes.

Parameters

string $mimetype file type or subformat

Return values

bool

◆ get()

portfolio_plugin_base::get ( $field )

finalinherited

Generic getter for properties belonging to this instance outside the subclasses like name, visible etc.

Parameters

string $field property name

Return values

mixed value of the field

◆ get_allowed_config()

static portfolio_plugin_base::get_allowed_config ( )

staticinherited

A list of fields that can be configured per instance.

This is used for the save handlers of the config form and as checks in set_config and get_config.

Return values

array array of strings (config item names)

Reimplemented in portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ get_allowed_export_config()

portfolio_plugin_base::get_allowed_export_config ( )

inherited

A list of fields that can be configured by the user.

This is used for the save handlers in the config form and as checks in set_export_config and get_export_config.

Return values

array array of strings (config field names)

Reimplemented in portfolio_plugin_flickr.

◆ get_allowed_user_config()

portfolio_plugin_base::get_allowed_user_config ( )

inherited

A list of fields that can be configured by the user.

This is used for the save handlers in the config form and as checks in set_user_config and get_user_config.

Return values

array array of strings (config field names)

Reimplemented in portfolio_plugin_flickr.

◆ get_base_file_url()

portfolio_plugin_pull_base::get_base_file_url ( )

The base part of the download file url to pull files from your plugin might need to add &foo=bar on the end.

See also: verify_file_request_params

Return values

string the url

◆ get_config()

portfolio_plugin_base::get_config ( $key )

finalinherited

Gets the value of a particular config item.

Parameters

string $key key to fetch

Return values

null|mixed the corresponding value

◆ get_export_config()

portfolio_plugin_base::get_export_config ( $key )

finalinherited

Gets an export time config value.

Subclasses should not override this.

Parameters

string $key field to fetch

Return values

null|string config value

◆ get_export_summary()

portfolio_plugin_base::get_export_summary ( )

inherited

After the user submits their config, they're given a confirm screen summarising what they've chosen.

This function should return a table of nice strings => values of what they've chosen to be displayed in a table.

Return values

bool

Reimplemented in portfolio_plugin_flickr.

◆ get_extra_finish_options()

portfolio_plugin_base::get_extra_finish_options ( )

inherited

Once everything is done and the user has the finish page displayed to them.

The base class takes care of printing them "return to where you are" or "continue to portfolio" links. This function allows for exta finish options from the plugin

Return values

bool

◆ get_file()

portfolio_plugin_pull_base::get_file ( )

protected

Gets the stored_file object from the file id in the $file instance var.

Return values

stored_file|null the stored_file object if it exists, null otherwise.

◆ get_interactive_continue_url()

portfolio_plugin_base::get_interactive_continue_url ( )

abstractinherited

The url for the user to continue to their portfolio during the lifecycle of the request.

Reimplemented in portfolio_plugin_download, portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ get_name()

static portfolio_plugin_base::get_name ( )

staticinherited

Returns the user-friendly name for this plugin.

Usually just get_string('pluginname', 'portfolio_something')

Reimplemented in portfolio_plugin_download, portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ get_static_continue_url()

portfolio_plugin_base::get_static_continue_url ( )

inherited

The url to save in the log as the continue url.

This is passed through resolve_static_continue_url() at display time to the user.

Return values

string

Reimplemented in portfolio_plugin_mahara.

◆ get_user_config()

portfolio_plugin_base::get_user_config	(		$key,
			$userid = 0 )

finalinherited

Get the value of a config item for a particular user.

Parameters

string	$key	key to fetch
int	$userid	id of user (defaults to current)

Return values

string the corresponding value

◆ has_admin_config()

static portfolio_plugin_base::has_admin_config ( )

staticinherited

Does this plugin need any configuration by the administrator? If you override this to return true, you must implement admin_config_form.

See also: admin_config_form

Return values

bool

Reimplemented in portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ has_export_config()

portfolio_plugin_base::has_export_config ( )

inherited

Does this plugin need configuration during export time? If you override this to return true, you must implement export_config_form.

See also: export_config_form

Return values

bool

Reimplemented in portfolio_plugin_flickr.

◆ has_user_config()

portfolio_plugin_base::has_user_config ( )

inherited

Can this plugin be configured by the user in their profile? If you override this to return true, you must implement user_config_form.

See also: user_config_form

Return values

bool

◆ heading_summary()

portfolio_plugin_base::heading_summary ( )

inherited

Return a string to put at the header summarising this export by default, just the plugin instance name.

Return values

string

◆ init()

portfolio_plugin_base::init ( )

protectedinherited

Called after __construct - allows plugins to perform initialisation tasks without having to override the constructor.

Reimplemented in portfolio_plugin_mahara.

◆ instance_sanity_check()

portfolio_plugin_base::instance_sanity_check ( )

inherited

Check sanity of instances.

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 values

int|string|bool - string = error string KEY (must be inside portfolio_$yourplugin) or 0/false if you're ok

Reimplemented in portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ is_push()

portfolio_plugin_pull_base::is_push ( )

return the enablelity to push

Return values

bool

Reimplemented from portfolio_plugin_base.

◆ plugin_sanity_check()

static portfolio_plugin_base::plugin_sanity_check ( )

staticinherited

Check sanity of plugin.

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 values

string|int|bool - string = error string KEY (must be inside portfolio_$yourplugin) or 0/false if you're ok

Reimplemented in portfolio_plugin_mahara.

◆ post_control()

portfolio_plugin_base::post_control	(		$stage,
			$params )

inherited

After a plugin has elected to steal control, and control returns to portfolio/add.php|postcontrol=1, this function is called, and passed the stage that was stolen control from and the request (get and post but not cookie) parameters.

This is useful for external systems that need to redirect the user back with some extra data in the url (like auth tokens etc) for an example implementation, see googledocs portfolio plugin.

Parameters

int	$stage	the stage before control was stolen
array	$params	a merge of $_GET and $_POST

Reimplemented in portfolio_plugin_flickr, and portfolio_plugin_googledocs.

◆ prepare_package()

portfolio_plugin_base::prepare_package ( )

abstractinherited

Called after the caller has finished having control of its prepare_package function.

This function should read all the files from the portfolio working file area and zip them and send them or whatever it wants. get_tempfiles to get the list of files.

See also: get_tempfiles

Reimplemented in portfolio_plugin_download, portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ resolve_static_continue_url()

portfolio_plugin_base::resolve_static_continue_url ( $url )

inherited

Override this function if you need to add something on to the url for post-export continues (eg from the log page).

Mahara does this, for example, to start a jump session.

Parameters

string $url static continue url

Return values

string

Reimplemented in portfolio_plugin_mahara.

◆ save()

portfolio_plugin_base::save ( )

inherited

Saves stuff that's been stored in the object to the database.

You shouldn't need to override this unless you're doing something really funky. and if so, call parent\save when you're done.

Return values

bool

◆ send_file()

portfolio_plugin_pull_base::send_file ( )

Called from portfolio/file.php.

This function sends the stored file out to the browser. The default is to just use send_stored_file, but other implementations might do something different, for example, send back the file base64 encoded and encrypted mahara does this but in the response to an xmlrpc request rather than through file.php

◆ send_package()

portfolio_plugin_base::send_package ( )

abstractinherited

This is the function that is responsible for sending the package to the remote system, or whatever request is necessary to initiate the transfer.

Return values

bool success

Reimplemented in portfolio_plugin_download, portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ set()

portfolio_plugin_base::set	(		$field,
			$value )

finalinherited

Generic setter for properties belonging to this instance outside the subclass like name, visible, etc.

Parameters

string	$field	property's name
string	$value	property's value

Return values

bool

◆ set_config()

portfolio_plugin_base::set_config ( $config )

finalinherited

Saves (or updates) the config stored in portfolio_instance_config.

You shouldn't need to override this unless you're doing something funky.

Parameters

array $config array of config items.

◆ set_export_config()

portfolio_plugin_base::set_export_config ( $config )

inherited

Sets the export time config from the moodle form.

You can also use this to set export config that isn't actually controlled by the user. Eg: things that your subclasses want to keep in state across the export. Keys must be in get_allowed_export_config This is deliberately not final (see googledocs plugin)

See also: get_allowed_export_config

Parameters

array $config named array of config items to set.

◆ set_file()

portfolio_plugin_pull_base::set_file ( \stored_file $file )

protected

Sets the $file instance var to the id of the supplied stored_file.

This helper allows the $this->get('file') call to return a stored_file, but means that we only ever record an id reference in the $file instance var.

Parameters

stored_file $file The stored_file instance.

Return values

void

◆ set_user_config()

portfolio_plugin_base::set_user_config	(		$config,
			$userid = 0 )

finalinherited

Sets config options for a given user.

Parameters

array	$config	array containing key/value pairs to set
int	$userid	userid to set config for (defaults to current)

◆ steal_control()

portfolio_plugin_base::steal_control ( $stage )

inherited

If at any point the caller wants to steal control, it can, by returning something that isn't false in this function The controller will redirect to whatever url this function returns.

Afterwards, you can redirect back to portfolio/add.php?postcontrol=1 and post_control is called before the rest of the processing for the stage is done,

See also: post_control

Parameters

int $stage to steal control before (see constants PARAM_STAGE_*}

Return values

bool

Reimplemented in portfolio_plugin_download, portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ supported_formats()

portfolio_plugin_base::supported_formats ( )

inherited

Array of formats this portfolio supports the intersection of what this function returns and what the caller supports will be used.

Use the constants PORTFOLIO_FORMAT_*

Return values

array list of formats

Reimplemented in portfolio_plugin_flickr, portfolio_plugin_googledocs, and portfolio_plugin_mahara.

◆ user_config_form()

portfolio_plugin_base::user_config_form ( & $mform )

inherited

mform to display to the user in their profile if your plugin can't be configured by the user,

See also: has_user_config. Don't bother overriding this function

Parameters

moodleform $mform passed by reference, add elements to it

◆ user_config_validation()

portfolio_plugin_base::user_config_validation ( array $data )

inherited

Just like the moodle form validation function.

This is passed in the data array from the form and if a non empty array is returned, form processing will stop.

Parameters

array $data data from form.

◆ verify_file_request_params()

portfolio_plugin_pull_base::verify_file_request_params ( $params )

abstract

Before sending the file when the pull is requested, verify the request parameters.

These might include a token of some sort of whatever

Parameters

array $params request parameters (POST wins over GET)

Reimplemented in portfolio_plugin_download, and portfolio_plugin_mahara.

Member Data Documentation

◆ $config

stdClass portfolio_plugin_base::$config

protectedinherited

admin configured config use {

See also: set_config} and {; get_config} to access

◆ $userconfig

array portfolio_plugin_base::$userconfig

protectedinherited

user config cache.

keyed on userid and then on config field => value use get_user_config and set_user_config to access.

The documentation for this class was generated from the following file:

lib/portfolio/plugin.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ admin_config_form()

◆ admin_config_validation()

◆ allows_multiple_exports()

◆ allows_multiple_instances()

◆ cleanup()

◆ create_instance()

◆ delete()

◆ expected_time()

◆ export_config_form()

◆ export_config_validation()

◆ file_mime_check()

◆ get()

◆ get_allowed_config()

◆ get_allowed_export_config()

◆ get_allowed_user_config()

◆ get_base_file_url()

◆ get_config()

◆ get_export_config()

◆ get_export_summary()

◆ get_extra_finish_options()

◆ get_file()

◆ get_interactive_continue_url()

◆ get_name()

◆ get_static_continue_url()

◆ get_user_config()

◆ has_admin_config()

◆ has_export_config()

◆ has_user_config()

◆ heading_summary()

◆ init()

◆ instance_sanity_check()

◆ is_push()

◆ plugin_sanity_check()

◆ post_control()

◆ prepare_package()

◆ resolve_static_continue_url()

◆ save()

◆ send_file()

◆ send_package()

◆ set()

◆ set_config()

◆ set_export_config()

◆ set_file()

◆ set_user_config()

◆ steal_control()

◆ supported_formats()

◆ user_config_form()

◆ user_config_validation()

◆ verify_file_request_params()

Member Data Documentation

◆ $config

◆ $userconfig