Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/mod/workshop/form/comments/ -> lib.php (source)
Differences Between: [Versions 400 and 403]
This file defines a class with comments grading strategy logic
| Copyright: | 2009 David Mudrak <david.mudrak@gmail.com> |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 475 lines (19 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 3 files mod/workshop/form/lib.php mod/workshop/form/comments/assessment_form.php mod/workshop/form/comments/edit_form.php |
Defines 1 class
workshop_comments_strategy:: (15 methods):
__construct()
get_edit_strategy_form()
save_edit_strategy_form()
get_assessment_form()
save_assessment()
form_ready()
get_assessments_recordset()
get_dimensions_info()
scale_used()
delete_instance()
load_fields()
prepare_form_fields()
delete_dimensions()
prepare_database_fields()
get_current_assessment_data()
Defines 15 functions
Class: workshop_comments_strategy - X-Ref
Accumulative grading strategy logic.| __construct(workshop $workshop) X-Ref |
| Constructor return: void param: workshop $workshop The workshop instance record |
| get_edit_strategy_form($actionurl=null) X-Ref |
| Factory method returning an instance of an assessment form editor class param: $actionurl URL of form handler, defaults to auto detect the current url |
| save_edit_strategy_form(stdclass $data) X-Ref |
| Save the assessment dimensions into database Saves data into the main strategy form table. If the record->id is null or zero, new record is created. If the record->id is not empty, the existing record is updated. Records with empty 'description' field are removed from database. The passed data object are the raw data returned by the get_data(). return: void param: stdClass $data Raw data returned by the dimension editor form |
| get_assessment_form(moodle_url $actionurl=null, $mode='preview', stdclass $assessment=null, $editable=true, $options=array() X-Ref |
| Factory method returning an instance of an assessment form param: moodle_url $actionurl URL of form handler, defaults to auto detect the current url param: string $mode Mode to open the form in: preview/assessment param: stdClass $assessment The current assessment param: bool $editable param: array $options |
| save_assessment(stdclass $assessment, stdclass $data) X-Ref |
| Saves the filled assessment This method processes data submitted using the form returned by {@link get_assessment_form()} return: float|null Constant raw grade 100.00000 for submission as suggested by the peer param: stdClass $assessment Assessment being filled param: stdClass $data Raw data as returned by the assessment form |
| form_ready() X-Ref |
| Has the assessment form been defined and is ready to be used by the reviewers? return: boolean |
| get_assessments_recordset($restrict=null) X-Ref |
| get_dimensions_info() X-Ref |
| scale_used($scaleid, $workshopid=null) X-Ref |
| Is a given scale used by the instance of workshop? This grading strategy does not use scales. return: bool param: int $scaleid id of the scale to check param: int|null $workshopid id of workshop instance to check, checks all in case of null |
| delete_instance($workshopid) X-Ref |
| Delete all data related to a given workshop module instance return: void param: int $workshopid id of the workshop module instance being deleted |
| load_fields() X-Ref |
| Loads the fields of the assessment form currently used in this workshop return: array definition of assessment dimensions |
| prepare_form_fields(array $raw) X-Ref |
| Maps the dimension data from DB to the form fields return: array Array of fields data to be used by the mform set_data param: array $raw Array of raw dimension records as returned by {@link load_fields()} |
| delete_dimensions(array $ids) X-Ref |
| Deletes dimensions and removes embedded media from its descriptions todo we may check that there are no assessments done using these dimensions and probably remove them return: void param: array $masterids |
| prepare_database_fields(stdclass $raw) X-Ref |
| Prepares data returned by {@link workshop_edit_comments_strategy_form} so they can be saved into database It automatically adds some columns into every record. The sorting is done by the order of the returned array and starts with 1. Called internally from {@link save_edit_strategy_form()} only. Could be private but keeping protected for unit testing purposes. return: array Array of objects to be inserted/updated in DB param: stdClass $raw Raw data returned by mform |
| get_current_assessment_data(stdclass $assessment) X-Ref |
| Returns the list of current grades filled by the reviewer indexed by dimensionid return: array [int dimensionid] => stdclass workshop_grades record param: stdClass $assessment Assessment record |
Functions that are not part of a class:
| workshopform_comments_pluginfile($course, $cm, $context, $filearea, array $args, $forcedownload, array $options=array() X-Ref |
| Server workshop files return: bool param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context context object param: string $filearea file area param: array $args extra arguments param: bool $forcedownload whether or not force download param: array $options additional options affecting the file serving |
