Damyon Wiese
312 lines
9.7 KiB
PHP
312 lines
9.7 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* This file contains the editor class for the assignfeedback_editpdf plugin
|
|
*
|
|
* @package assignfeedback_editpdf
|
|
* @copyright 2012 Davo Smith
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace assignfeedback_editpdf;
|
|
|
|
/**
|
|
* This class performs crud operations on comments and annotations from a page of a response.
|
|
*
|
|
* No capability checks are done - they should be done by the calling class.
|
|
*
|
|
* @package assignfeedback_editpdf
|
|
* @copyright 2012 Davo Smith
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class page_editor {
|
|
|
|
/**
|
|
* Get all comments for a page.
|
|
* @param int $gradeid
|
|
* @param int $pageno
|
|
* @param bool $draft
|
|
* @return comment[]
|
|
*/
|
|
public static function get_comments($gradeid, $pageno, $draft) {
|
|
global $DB;
|
|
|
|
$comments = array();
|
|
$params = array('gradeid'=>$gradeid, 'pageno'=>$pageno, 'draft'=>1);
|
|
if (!$draft) {
|
|
$params['draft'] = 0;
|
|
}
|
|
$records = $DB->get_records('assignfeedback_editpdf_cmnt', $params);
|
|
foreach ($records as $record) {
|
|
array_push($comments, new comment($record));
|
|
}
|
|
|
|
return $comments;
|
|
}
|
|
|
|
/**
|
|
* Set all comments for a page.
|
|
* @param int $gradeid
|
|
* @param int $pageno
|
|
* @param comment[] $comments
|
|
* @return int - the number of comments.
|
|
*/
|
|
public static function set_comments($gradeid, $pageno, $comments) {
|
|
global $DB;
|
|
|
|
$DB->delete_records('assignfeedback_editpdf_cmnt', array('gradeid'=>$gradeid, 'pageno'=>$pageno, 'draft'=>1));
|
|
|
|
$added = 0;
|
|
foreach ($comments as $record) {
|
|
// Force these.
|
|
if (!($record instanceof comment)) {
|
|
$comment = new comment($record);
|
|
} else {
|
|
$comment = $record;
|
|
}
|
|
if (trim($comment->rawtext) === '') {
|
|
continue;
|
|
}
|
|
$comment->gradeid = $gradeid;
|
|
$comment->pageno = $pageno;
|
|
$comment->draft = 1;
|
|
if (self::add_comment($comment)) {
|
|
$added++;
|
|
}
|
|
}
|
|
|
|
return $added;
|
|
}
|
|
|
|
/**
|
|
* Get a single comment by id.
|
|
* @param int $commentid
|
|
* @return comment or false
|
|
*/
|
|
public static function get_comment($commentid) {
|
|
$record = $DB->get_record('assignfeedback_editpdf_cmnt', array('id'=>$commentid), '*', IGNORE_MISSING);
|
|
if ($record) {
|
|
return new comment($record);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Add a comment to a page.
|
|
* @param comment $comment
|
|
* @return bool
|
|
*/
|
|
public static function add_comment(comment $comment) {
|
|
global $DB;
|
|
$comment->id = null;
|
|
return $DB->insert_record('assignfeedback_editpdf_cmnt', $comment);
|
|
}
|
|
|
|
/**
|
|
* Remove a comment from a page.
|
|
* @param int $commentid
|
|
* @return bool
|
|
*/
|
|
public static function remove_comment($commentid) {
|
|
global $DB;
|
|
return $DB->delete_records('assignfeedback_editpdf_cmnt', array('id'=>$commentid));
|
|
}
|
|
|
|
/**
|
|
* Get all annotations for a page.
|
|
* @param int $gradeid
|
|
* @param int $pageno
|
|
* @param bool $draft
|
|
* @return annotation[]
|
|
*/
|
|
public static function get_annotations($gradeid, $pageno, $draft) {
|
|
global $DB;
|
|
|
|
$params = array('gradeid'=>$gradeid, 'pageno'=>$pageno, 'draft'=>1);
|
|
if (!$draft) {
|
|
$params['draft'] = 0;
|
|
}
|
|
$annotations = array();
|
|
$records = $DB->get_records('assignfeedback_editpdf_annot', $params);
|
|
foreach ($records as $record) {
|
|
array_push($annotations, new annotation($record));
|
|
}
|
|
|
|
return $annotations;
|
|
}
|
|
|
|
/**
|
|
* Set all annotations for a page.
|
|
* @param int $gradeid
|
|
* @param int $pageno
|
|
* @param annotation[] $annotations
|
|
* @return int - the number of annotations.
|
|
*/
|
|
public static function set_annotations($gradeid, $pageno, $annotations) {
|
|
global $DB;
|
|
|
|
$DB->delete_records('assignfeedback_editpdf_annot', array('gradeid'=>$gradeid, 'pageno'=>$pageno));
|
|
$added = 0;
|
|
foreach ($annotations as $record) {
|
|
// Force these.
|
|
if (!($record instanceof annotation)) {
|
|
$annotation = new annotation($record);
|
|
} else {
|
|
$annotation = $record;
|
|
}
|
|
$annotation->gradeid = $gradeid;
|
|
$annotation->pageno = $pageno;
|
|
$annotation->draft = 1;
|
|
if (self::add_annotation($annotation)) {
|
|
$added++;
|
|
}
|
|
}
|
|
|
|
return $added;
|
|
}
|
|
|
|
/**
|
|
* Get a single annotation by id.
|
|
* @param int $annotationid
|
|
* @return annotation or false
|
|
*/
|
|
public static function get_annotation($annotationid) {
|
|
global $DB;
|
|
|
|
$record = $DB->get_record('assignfeedback_editpdf_annot', array('id'=>$annotationid), '*', IGNORE_MISSING);
|
|
if ($record) {
|
|
return new annotation($record);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Unrelease drafts
|
|
* @param int $gradeid
|
|
* @return bool
|
|
*/
|
|
public static function unrelease_drafts($gradeid) {
|
|
global $DB;
|
|
|
|
// Delete the non-draft annotations and comments.
|
|
$result = $DB->delete_records('assignfeedback_editpdf_cmnt', array('gradeid'=>$gradeid, 'draft'=>0));
|
|
$result = $DB->delete_records('assignfeedback_editpdf_annot', array('gradeid'=>$gradeid, 'draft'=>0)) && $result;
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Release the draft comments and annotations to students.
|
|
* @param int $gradeid
|
|
* @return bool
|
|
*/
|
|
public static function release_drafts($gradeid) {
|
|
global $DB;
|
|
|
|
// Delete the previous non-draft annotations and comments.
|
|
$DB->delete_records('assignfeedback_editpdf_cmnt', array('gradeid'=>$gradeid, 'draft'=>0));
|
|
$DB->delete_records('assignfeedback_editpdf_annot', array('gradeid'=>$gradeid, 'draft'=>0));
|
|
|
|
// Copy all the draft annotations and comments to non-drafts.
|
|
$records = $DB->get_records('assignfeedback_editpdf_annot', array('gradeid'=>$gradeid, 'draft'=>1));
|
|
foreach ($records as $record) {
|
|
unset($record->id);
|
|
$record->draft = 0;
|
|
$DB->insert_record('assignfeedback_editpdf_annot', $record);
|
|
}
|
|
$records = $DB->get_records('assignfeedback_editpdf_cmnt', array('gradeid'=>$gradeid, 'draft'=>1));
|
|
foreach ($records as $record) {
|
|
unset($record->id);
|
|
$record->draft = 0;
|
|
$DB->insert_record('assignfeedback_editpdf_cmnt', $record);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Has annotations or comments.
|
|
* @param int $gradeid
|
|
* @return bool
|
|
*/
|
|
public static function has_annotations_or_comments($gradeid, $includedraft) {
|
|
global $DB;
|
|
$params = array('gradeid'=>$gradeid);
|
|
if (!$includedraft) {
|
|
$params['draft'] = 0;
|
|
}
|
|
if ($DB->count_records('assignfeedback_editpdf_cmnt', $params)) {
|
|
return true;
|
|
}
|
|
if ($DB->count_records('assignfeedback_editpdf_annot', $params)) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Aborts all draft annotations and reverts to the last version released to students.
|
|
* @param int $gradeid
|
|
* @return bool
|
|
*/
|
|
public static function revert_drafts($gradeid) {
|
|
global $DB;
|
|
|
|
// Delete the previous non-draft annotations and comments.
|
|
$DB->delete_records('assignfeedback_editpdf_cmnt', array('gradeid'=>$gradeid, 'draft'=>1));
|
|
$DB->delete_records('assignfeedback_editpdf_annot', array('gradeid'=>$gradeid, 'draft'=>1));
|
|
|
|
// Copy all the draft annotations and comments to non-drafts.
|
|
$records = $DB->get_records('assignfeedback_editpdf_annot', array('gradeid'=>$gradeid, 'draft'=>0));
|
|
foreach ($records as $record) {
|
|
unset($record->id);
|
|
$record->draft = 0;
|
|
$DB->insert_record('assignfeedback_editpdf_annot', $record);
|
|
}
|
|
$records = $DB->get_records('assignfeedback_editpdf_cmnt', array('gradeid'=>$gradeid, 'draft'=>0));
|
|
foreach ($records as $record) {
|
|
unset($record->id);
|
|
$record->draft = 0;
|
|
$DB->insert_record('assignfeedback_editpdf_annot', $record);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Add a annotation to a page.
|
|
* @param annotation $annotation
|
|
* @return bool
|
|
*/
|
|
public static function add_annotation(annotation $annotation) {
|
|
global $DB;
|
|
|
|
$annotation->id = null;
|
|
return $DB->insert_record('assignfeedback_editpdf_annot', $annotation);
|
|
}
|
|
|
|
/**
|
|
* Remove a annotation from a page.
|
|
* @param int $annotationid
|
|
* @return bool
|
|
*/
|
|
public static function remove_annotation($annotationid) {
|
|
global $DB;
|
|
|
|
return $DB->delete_records('assignfeedback_editpdf_annot', array('id'=>$annotationid));
|
|
}
|
|
}
|