Moodle  2.2.1
http://www.collinsharper.com
workshop_allocator Interface Reference
Inheritance diagram for workshop_allocator:

Public Member Functions

 init ()
 ui ()

Static Public Member Functions

static delete_instance ($workshopid)

Detailed Description

Allocators are responsible for assigning submissions to reviewers for assessments

The task of the allocator is to assign the correct number of submissions to reviewers for assessment. Several allocation methods are expected and they can be combined. For example, teacher can allocate several submissions manually (by 'manual' allocator) and then let the other submissions being allocated randomly (by 'random' allocator). Allocation is actually done by creating an initial assessment record in the workshop_assessments table.

Definition at line 39 of file lib.php.


Member Function Documentation

static delete_instance ( workshopid) [static]

Delete all data related to a given workshop module instance

This is called from workshop_delete_instance().

Parameters:
int$workshopidid of the workshop module instance being deleted
Returns:
void

Implemented in workshop_manual_allocator, and workshop_random_allocator.

init ( )

Initialize the allocator and eventually process submitted data

This method is called soon after the allocator is constructed and before any output is generated. Therefore it may process any data submitted and do other tasks. It must not produce any output. The returned value is processed by {

See also:
workshop_allocation_init_result} class and rendered.
Exceptions:
moodle_exception
Returns:
void|string

Implemented in workshop_random_allocator, and workshop_manual_allocator.

ui ( )

Print HTML to be displayed as the user interface

If a form is part of the UI, the caller should have called $PAGE->set_url(...)

Parameters:
stdClass$wsoutputworkshop module renderer can be used
Returns:
string HTML code to be echoed

Implemented in workshop_random_allocator, and workshop_manual_allocator.


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