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

Public Member Functions

 load_data ()
 prepare_package ()
 get_sha1 ()
 expected_time ()
 check_permissions ()
 __wakeup ()

Static Public Member Functions

static expected_callbackargs ()
static display_name ()
static base_supported_formats ()

Protected Attributes

 $submissionid
 $fileid

Detailed Description

Definition at line 29 of file locallib.php.


Member Function Documentation

__wakeup ( )

Definition at line 163 of file locallib.php.

static base_supported_formats ( ) [static]

Reimplemented from portfolio_caller_base.

Definition at line 176 of file locallib.php.

callback to do whatever capability checks required in the caller (called during the export process

Reimplemented from portfolio_caller_base.

Definition at line 158 of file locallib.php.

Here is the call graph for this function:

static display_name ( ) [static]

nice name to display to the user about this caller location

Reimplemented from portfolio_caller_base.

Definition at line 172 of file locallib.php.

static expected_callbackargs ( ) [static]

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 required, or just optional eg array( id => true, somethingelse => false, )

Returns:
array

Reimplemented from portfolio_caller_base.

Definition at line 49 of file locallib.php.

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 the portfolio plugin can override this. (so for example even if a huge file is being sent, the download portfolio plugin doesn't care )

Returns:
string (see PORTFOLIO_TIME_* constants)

Reimplemented from portfolio_caller_base.

Definition at line 151 of file locallib.php.

Here is the call graph for this function:

get_sha1 ( )

Reimplemented from portfolio_caller_base.

Definition at line 143 of file locallib.php.

Here is the call graph for this function:

load_data ( )

Load data needed for the portfolio export

If the assignment type implements portfolio_load_data(), the processing is delegated to it. Otherwise, the caller must provide either fileid (to export single file) or submissionid (to export all data attached to the given submission) via callback arguments.

Reimplemented from portfolio_caller_base.

Definition at line 64 of file locallib.php.

Here is the call graph for this function:

called before the portfolio plugin gets control this function should copy all the files it wants to the temporary directory, using {

See also:
copy_existing_file} or {
write_new_file}

Reimplemented from portfolio_caller_base.

Definition at line 108 of file locallib.php.

Here is the call graph for this function:


Field Documentation

$fileid [protected]

callback arg for a single file export

Definition at line 47 of file locallib.php.

$submissionid [protected]

Definition at line 42 of file locallib.php.


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