Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 39 and 310] [Versions 39 and 311] [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]

This file contains the definition for the library class for PDF feedback plugin

Copyright: 2012 Davo Smith
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 389 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

assign_feedback_editpdf:: (14 methods):
  get_name()
  get_widget()
  get_form_elements_for_user()
  is_feedback_modified()
  save()
  view_summary()
  view()
  is_empty()
  delete_instance()
  is_available()
  is_configurable()
  get_file_areas()
  supports_review_panel()
  get_config_for_external()


Class: assign_feedback_editpdf  - X-Ref

library class for editpdf feedback plugin extending feedback plugin base class

get_name()   X-Ref
Get the name of the file feedback plugin

return: string

get_widget($userid, $grade, $readonly)   X-Ref
Create a widget for rendering the editor.

param: int $userid
param: stdClass $grade
param: bool $readonly
return: assignfeedback_editpdf_widget

get_form_elements_for_user($grade, MoodleQuickForm $mform, stdClass $data, $userid)   X-Ref
Get form elements for grading form

param: stdClass $grade
param: MoodleQuickForm $mform
param: stdClass $data
param: int $userid
return: bool true if elements were added to the form

is_feedback_modified(stdClass $grade, stdClass $data)   X-Ref
Check to see if the grade feedback for the pdf has been modified.

param: stdClass $grade Grade object.
param: stdClass $data Data from the form submission (not used).
return: boolean True if the pdf has been modified, else false.

save(stdClass $grade, stdClass $data)   X-Ref
Generate the pdf.

param: stdClass $grade
param: stdClass $data
return: bool

view_summary(stdClass $grade, & $showviewlink)   X-Ref
Display the list of files in the feedback status table.

param: stdClass $grade
param: bool $showviewlink (Always set to false).
return: string

view(stdClass $grade)   X-Ref
Display the list of files in the feedback status table.

param: stdClass $grade
return: string

is_empty(stdClass $grade)   X-Ref
Return true if there are no released comments/annotations.

param: stdClass $grade

delete_instance()   X-Ref
The assignment has been deleted - remove the plugin specific data

return: bool

is_available()   X-Ref
Determine if ghostscript is available and working.

return: bool

is_configurable()   X-Ref
Prevent enabling this plugin if ghostscript is not available.

return: bool false

get_file_areas()   X-Ref
Get file areas returns a list of areas this plugin stores files.

return: array - An array of fileareas (keys) and descriptions (values)

supports_review_panel()   X-Ref
This plugin will inject content into the review panel with javascript.

return: bool true

get_config_for_external()   X-Ref
Return the plugin configs for external functions.

return: array the list of settings