Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
assignfeedback_editpdf

Namespaces

namespace  assignfeedback_editpdf
  
 
namespace  assignfeedback_editpdf\event
  
 
namespace  assignfeedback_editpdf\privacy
  
 
namespace  assignfeedback_editpdf\task
  
 

Classes

class  assign_feedback_editpdf
 library class for editpdf feedback plugin extending feedback plugin base class More...
 
class  assignfeedback_editpdf\annotation
 This class adds and removes annotations from a page of a response. More...
 
class  assignfeedback_editpdf\combined_document
 The combined_document class for the assignfeedback_editpdf plugin. More...
 
class  assignfeedback_editpdf\comment
 This class represents a comment box on a page of feedback. More...
 
class  assignfeedback_editpdf\comments_quick_list
 This class performs crud operations on a users quicklist comments. More...
 
class  assignfeedback_editpdf\document_services
 Functions for generating the annotated pdf. More...
 
class  assignfeedback_editpdf\event\observer
 An event observer. More...
 
class  assignfeedback_editpdf\page_editor
 This class performs crud operations on comments and annotations from a page of a response. More...
 
class  assignfeedback_editpdf\pdf
 Library code for manipulating PDFs. More...
 
class  assignfeedback_editpdf\privacy\provider
 Privacy class for requesting user data. More...
 
class  assignfeedback_editpdf\task\bump_submission_for_stale_conversions
 Adhoc task to bump the submission timemodified associated with a stale conversion. More...
 
class  assignfeedback_editpdf\task\convert_submission
 
class  assignfeedback_editpdf\task\remove_orphaned_editpdf_files
 Cleans up orphaned feedback pdf files and table entries. More...
 
class  assignfeedback_editpdf_renderer
 A custom renderer class that extends the plugin_renderer_base and is used by the editpdf feedback plugin. More...
 
class  assignfeedback_editpdf_widget
 A custom renderer class that extends the plugin_renderer_base and is used by the editpdf feedback plugin. More...
 
class  backup_assignfeedback_editpdf_subplugin
 Provides the information to backup feedback pdf annotations. More...
 
class  behat_assignfeedback_editpdf
 Steps definitions related with the editpdf. More...
 
class  restore_assignfeedback_editpdf_subplugin
 Restore subplugin class. More...
 

Functions

 assignfeedback_editpdf_after_file_updated (stdClass $file, stdClass $filepreupdate)
 Files API hook to remove stale conversion records.
 
 assignfeedback_editpdf_pluginfile ( $course, $cm, context $context, $filearea, $args, $forcedownload, array $options=array())
 Serves assignment feedback and other files.
 
 xmldb_assignfeedback_editpdf_install ()
 EditPDF install code.
 
 xmldb_assignfeedback_editpdf_upgrade ($oldversion)
 EditPDF upgrade code.
 

Variables

global $CFG
 
global assignfeedback_editpdf::$CFG
 
 $description = get_string('stampsdesc', 'assignfeedback_editpdf')
 
 $link = html_writer::link($url, get_string('testgs', 'assignfeedback_editpdf'))
 
 $name = 'assignfeedback_editpdf/stamps'
 
 $observers
 
 $plugin = 2023100400
 
 $setting
 
 $systempathlink = html_writer::link($systempathslink, get_string('systempaths', 'admin'))
 
 $systempathslink = new moodle_url('/admin/settings.php', array('section' => 'systempaths'))
 
 $title = get_string('stamps','assignfeedback_editpdf')
 
 $url = new moodle_url('/mod/assign/feedback/editpdf/testgs.php')
 
$plugin component = 'assignfeedback_editpdf'
 
$plugin version = 2023100900
 

Detailed Description

Function Documentation

◆ assignfeedback_editpdf_after_file_updated()

assignfeedback_editpdf_after_file_updated ( stdClass $file,
stdClass $filepreupdate )

Files API hook to remove stale conversion records.

When a file is update, its contenthash will change, but its ID remains the same. The document converter API records source file IDs and destination file IDs. When a file is updated, the document converter API has no way of knowing that the content of the file has changed, so it just serves the previously stored destination file.

In this hook we check if the contenthash has changed, and if it has we delete the existing conversion so that a new one will be created.

Parameters
stdClass$fileThe updated file record.
stdClass$filepreupdateThe file record pre-update.

◆ assignfeedback_editpdf_pluginfile()

assignfeedback_editpdf_pluginfile ( $course,
$cm,
context $context,
$filearea,
$args,
$forcedownload,
array $options = array() )

Serves assignment feedback and other files.

Parameters
mixed$coursecourse or id of the course
mixed$cmcourse module or id of the course module
context$context
string$filearea
array$args
bool$forcedownload
array$options- List of options affecting file serving.
Return values
boolfalse if file not found, does not return if found - just send the file

◆ xmldb_assignfeedback_editpdf_upgrade()

xmldb_assignfeedback_editpdf_upgrade ( $oldversion)

EditPDF upgrade code.

Parameters
int$oldversion
Return values
bool

Variable Documentation

◆ $observers

$observers
Initial value:
= array(
array(
'eventname' => '\mod_assign\event\submission_created',
'callback' => '\assignfeedback_editpdf\event\observer::submission_created',
),
array(
'eventname' => '\mod_assign\event\submission_updated',
'callback' => '\assignfeedback_editpdf\event\observer::submission_updated',
),
)
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

◆ $setting

$setting
Initial value:
= new admin_setting_configstoredfile($name, $title, $description, 'stamps', 0,
array('maxfiles' => 8, 'accepted_types' => array('image')))
Class used for uploading of one file into file storage, the file name is stored in config table.
Definition adminlib.php:10527