Moodle  2.2.1
http://www.collinsharper.com
portfolio_plugin_download Class Reference
Inheritance diagram for portfolio_plugin_download:
Collaboration diagram for portfolio_plugin_download:

Public Member Functions

 expected_time ($callertime)
 prepare_package ()
 steal_control ($stage)
 send_package ()
 verify_file_request_params ($params)
 get_interactive_continue_url ()

Static Public Member Functions

static get_name ()
static allows_multiple_instances ()

Protected Attributes

 $exportconfig

Detailed Description

Definition at line 5 of file lib.php.


Member Function Documentation

static allows_multiple_instances ( ) [static]

override this if your plugin doesn't allow multiple instances

Returns:
boolean

Reimplemented from portfolio_plugin_base.

Definition at line 13 of file lib.php.

expected_time ( callertime)

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.
Returns:
string (see PORTFOLIO_TIME_* constants)

Reimplemented from portfolio_plugin_base.

Definition at line 17 of file lib.php.

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

Returns:
string url or false.

Reimplemented from portfolio_plugin_base.

Definition at line 51 of file lib.php.

static get_name ( ) [static]

returns the user-friendly name for this plugin usually just get_string('pluginname', 'portfolio_something')

Returns:
string

Reimplemented from portfolio_plugin_base.

Definition at line 9 of file lib.php.

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. {

See also:
get_tempfiles} to get the list of files.

Reimplemented from portfolio_plugin_base.

Definition at line 21 of file lib.php.

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

Returns:
boolean success

Reimplemented from portfolio_plugin_base.

Definition at line 39 of file lib.php.

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. 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

Parameters:
intstage to steal control *before* (see constants PARAM_STAGE_*}
Returns:
boolean or string url

Reimplemented from portfolio_plugin_base.

Definition at line 32 of file lib.php.

before sending the file when the pull is requested, verify the request parameters these might include a token of some sort of whatever

Parameters:
arrayrequest parameters (POST wins over GET)

Reimplemented from portfolio_plugin_pull_base.

Definition at line 41 of file lib.php.


Field Documentation

$exportconfig [protected]

named array export config during export use get_export_config and export_config to access.

Reimplemented from portfolio_plugin_base.

Definition at line 7 of file lib.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations