Gitlab CSE Unil

annotation.php 4.94 KB
Newer Older
M. Chardon's avatar
init  
M. Chardon committed
1
<?php
2

M. Chardon's avatar
init  
M. Chardon committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 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 annotation class for the assignfeedback_editpdfplus plugin
 *
21
22
 * This class adds and removes annotations from a page of a response.
 *
M. Chardon's avatar
init  
M. Chardon committed
23
 * @package   assignfeedback_editpdfplus
M. Chardon's avatar
GPL3  
M. Chardon committed
24
 * @copyright  2016 Université de Lausanne
25
 * The code is based on mod/assign/feedback/editpdf/classes/annotation.php by Davo Smith.
M. Chardon's avatar
init  
M. Chardon committed
26
27
28
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

M. Chardon's avatar
M. Chardon committed
29
namespace assignfeedback_editpdfplus\bdd;
M. Chardon's avatar
init  
M. Chardon committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

class annotation {

    /** @var int unique id for this annotation */
    public $id = 0;

    /** @var int gradeid for this annotation */
    public $gradeid = 0;

    /** @var int page number for this annotation */
    public $pageno = 0;

    /** @var int starting location in pixels. Image resolution is 100 pixels per inch */
    public $x = 0;

    /** @var int ending location in pixels. Image resolution is 100 pixels per inch */
    public $endx = 0;

    /** @var int starting location in pixels. Image resolution is 100 pixels per inch */
    public $y = 0;

    /** @var int ending location in pixels. Image resolution is 100 pixels per inch */
    public $endy = 0;
53
54

    /** @var int starting location of cartridge in pixels. Image resolution is 100 pixels per inch */
55
    public $cartridgex = 0;
56

57
    /** @var int ending location of cartridge in pixels. Image resolution is 100 pixels per inch */
58
    public $cartridgey = 0;
M. Chardon's avatar
init  
M. Chardon committed
59
60
61
62
63

    /** @var string path information for drawing the annotation. */
    public $path = '';

    /** @var int toolid for this annotation. */
64
    public $toolid = 0;
65

M. Chardon's avatar
init  
M. Chardon committed
66
67
68
69
70
71
    /** @var string textannot, contains the text of this annotation */
    public $textannot = '';

    /** @var string colour - One of red, yellow, green, blue, white */
    public $colour = 'yellow';

M. Chardon's avatar
M. Chardon committed
72
    /** @var bool displaylock for displaying this annotation */
73
    public $displaylock = 1;
M. Chardon's avatar
M. Chardon committed
74
75
76

    /** @var bool displayrotation for displaying the sign of the annotation */
    public $displayrotation = 0;
77

78
79
    /** @var string borderstyle */
    public $borderstyle = '';
80

81
    /** @var int parent_annot */
82
    public $parent_annot = 0;
83

84
    /** @var int answerrequested */
85
    public $answerrequested = 0;
86

87
88
    /** @var int studentstatus */
    public $studentstatus = 0;
89

90
91
    /** @var string studentanswer */
    public $studentanswer = "";
92

93
94
95
    /** @var string pdfdisplay */
    public $pdfdisplay = "footnote";

96
97
98
99
100
101
    /** @var int draft */
    public $draft = 1;

    /** @var int draft_id */
    public $draft_id = null;

M. Chardon's avatar
init  
M. Chardon committed
102
103
104
105
106
107
    /**
     * Convert a compatible stdClass into an instance of this class.
     * @param stdClass $record
     */
    public function __construct(\stdClass $record = null) {
        if ($record) {
108
            $intcols = array('endx', 'endy', 'x', 'y', 'draft_id');
M. Chardon's avatar
init  
M. Chardon committed
109
110
111
112
113
114
115
116
117
118
119
            foreach ($this as $key => $value) {
                if (isset($record->$key)) {
                    if (in_array($key, $intcols)) {
                        $this->$key = intval($record->$key);
                    } else {
                        $this->$key = $record->$key;
                    }
                }
            }
        }
    }
120

121
122
123
124
125
    /**
     * Check if the annotation has a real text which can be printed of displayed
     * If the annotation has a parent, it will be always no : the parent will give the text for all of its children
     * @return boolean
     */
M. Chardon's avatar
M. Chardon committed
126
    public function has_readable_comment() {
127
128
129
        return $this->textannot && !$this->parent_annot;
    }

130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
    public function clone_teacher_annotation($annotationRef) {
        $this->x = $annotationRef->x;
        $this->endx = $annotationRef->endx;
        $this->y = $annotationRef->y;
        $this->endy = $annotationRef->endy;
        $this->cartridgex = $annotationRef->cartridgex;
        $this->cartridgey = $annotationRef->cartridgey;
        $this->path = $annotationRef->path;
        $this->toolid = $annotationRef->toolid;
        $this->textannot = $annotationRef->textannot;
        $this->colour = $annotationRef->colour;
        $this->displaylock = $annotationRef->displaylock;
        $this->displayrotation = $annotationRef->displayrotation;
        $this->borderstyle = $annotationRef->borderstyle;
        $this->parent_annot = $annotationRef->parent_annot;
        $this->answerrequested = $annotationRef->answerrequested;
        $this->pdfdisplay = $annotationRef->pdfdisplay;
    }

M. Chardon's avatar
init  
M. Chardon committed
149
}