Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
workshop_allocator Interface Reference

Allocators are responsible for assigning submissions to reviewers for assessments. More...

Inheritance diagram for workshop_allocator:
workshop_manual_allocator workshop_random_allocator workshop_scheduled_allocator

Public Member Functions

 init ()
 Initialize the allocator and eventually process submitted data.
 
 ui ()
 Print HTML to be displayed as the user interface.
 

Static Public Member Functions

static delete_instance ($workshopid)
 Delete all data related to a given workshop module instance.
 

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.

Member Function Documentation

◆ delete_instance()

static workshop_allocator::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
Return values
void

Implemented in workshop_manual_allocator, workshop_random_allocator, and workshop_scheduled_allocator.

◆ init()

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

Exceptions
moodle_exception
Return values
workshop_allocation_result

Implemented in workshop_manual_allocator, workshop_random_allocator, and workshop_scheduled_allocator.

◆ ui()

workshop_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
Return values
stringHTML code to be echoed

Implemented in workshop_manual_allocator, workshop_random_allocator, and workshop_scheduled_allocator.


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