Gitlab CSE Unil

admin_editor.php 11.4 KB
Newer Older
M. Chardon's avatar
M. Chardon committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?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_editpdfplus plugin
 *
 * @package   assignfeedback_editpdfplus
M. Chardon's avatar
M. Chardon committed
22
 * @copyright  2017 Université de Lausanne
M. Chardon's avatar
M. Chardon committed
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace assignfeedback_editpdfplus;

use assignfeedback_editpdfplus\axis;

/**
 * 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_editpdfplus
 * @copyright 2017 Université de Lausanne
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class admin_editor {

    /**
M. Chardon's avatar
M. Chardon committed
42
     * Add an axis
M. Chardon's avatar
M. Chardon committed
43
     * @global type $DB
M. Chardon's avatar
M. Chardon committed
44
45
46
     * @param String $axisLabel axis' name
     * @param Integer $context context's id
     * @return Integer id of the created axis
M. Chardon's avatar
M. Chardon committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
     */
    public static function add_axis($axisLabel, $context) {
        global $DB;

        $record = $DB->get_record_sql('SELECT max(order_axis) as order_max FROM {assignfeedback_editpp_axis} WHERE contextid = :contextid', array('contextid' => $context));

        $axis = new axis();
        $axis->contextid = $context;
        $axis->label = $axisLabel;
        if ($record->order_max == null) {
            $axis->order_axis = 1;
        } else {
            $axis->order_axis = $record->order_max + 1;
        }

        return $DB->insert_record('assignfeedback_editpp_axis', $axis);
    }

M. Chardon's avatar
M. Chardon committed
65
    /**
M. Chardon's avatar
M. Chardon committed
66
     * Add a tool
M. Chardon's avatar
M. Chardon committed
67
     * @global type $DB
M. Chardon's avatar
M. Chardon committed
68
69
70
     * @param object $data object with contains tool' info
     * @param Integer $contextid context's id
     * @return \assignfeedback_editpdfplus\tool created tool
M. Chardon's avatar
M. Chardon committed
71
72
73
74
     */
    public static function add_tool($data, $contextid) {
        global $DB;

M. Chardon's avatar
M. Chardon committed
75
        $maxindice = admin_editor::reorder_tool($data->axisid);
M. Chardon's avatar
M. Chardon committed
76
77
78
79

        $tool = new tool();
        $tool->axis = $data->axisid;
        $tool->cartridge = $data->libelle;
M. Chardon's avatar
M. Chardon committed
80
        $tool->cartridge_color = $data->catridgecolor;
M. Chardon's avatar
M. Chardon committed
81
82
        $tool->contextid = $contextid;
        $tool->label = $data->button;
M. Chardon's avatar
M. Chardon committed
83
        $tool->reply = 0;
M. Chardon's avatar
M. Chardon committed
84
85
86
87
88
        if ($data->reply == "on") {
            $tool->reply = 1;
        }
        $tool->texts = $data->texts;
        $tool->type = $data->typetool;
M. Chardon's avatar
M. Chardon committed
89
        $tool->colors = $data->color;
M. Chardon's avatar
M. Chardon committed
90
        $reorder = false;
M. Chardon's avatar
M. Chardon committed
91
92
93
94
        if ($maxindice == null) {
            $tool->order_tool = 1;
        } elseif ($data->order && intval($data->order) < 1000) {
            $tool->order_tool = $data->order;
M. Chardon's avatar
M. Chardon committed
95
            $reorder = true;
M. Chardon's avatar
M. Chardon committed
96
        } else {
M. Chardon's avatar
M. Chardon committed
97
            $tool->order_tool = $maxindice + 1;
M. Chardon's avatar
M. Chardon committed
98
99
100
        }

        $toolid = $DB->insert_record('assignfeedback_editpp_tool', $tool);
M. Chardon's avatar
M. Chardon committed
101

M. Chardon's avatar
M. Chardon committed
102
        if ($toolid > 0) {
M. Chardon's avatar
M. Chardon committed
103
104
105
            if ($reorder) {
                admin_editor::reorder_tool($data->axisid, $toolid);
            }
M. Chardon's avatar
M. Chardon committed
106
107
108
109
110
            return $tool;
        }
        return null;
    }

M. Chardon's avatar
M. Chardon committed
111
    /**
M. Chardon's avatar
M. Chardon committed
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
     * Order tools of a toolbar
     * @global type $DB
     * @param Integer $axisid axis to reorder
     * @param Integer $toolid optional, can indicate a tool to place into a toolbar
     * @return last order rank
     */
    protected static function reorder_tool($axisid, $toolid = null) {
        global $DB;

        $tools = array();
        $records = $DB->get_records_sql('SELECT * FROM {assignfeedback_editpp_tool} WHERE axis = :axisid ORDER BY order_tool ASC', array('axisid' => $axisid));
        foreach ($records as $record) {
            array_push($tools, new tool($record));
        }
        $compteurPrecedent = null;
        $decalage = 1;
        $lastTool = null;
        foreach ($tools as $tool) {
            if ($compteurPrecedent == null) {
                $compteurPrecedent = $tool->order_tool;
                $lastTool = $tool;
            } else {
                $compteurCourant = $tool->order_tool;
                if ($compteurCourant != $compteurPrecedent + $decalage) {
                    if ($toolid && $tool->id == $toolid) {
                        $tool->order_tool = $lastTool->order_tool;
                        $lastTool->order_tool = $compteurPrecedent + 1;
                        $DB->update_record('assignfeedback_editpp_tool', $tool);
                        $DB->update_record('assignfeedback_editpp_tool', $lastTool);
                    } else {
                        $tool->order_tool = $compteurPrecedent + $decalage;
                        $DB->update_record('assignfeedback_editpp_tool', $tool);
                        $lastTool = $tool;
                    }
                    //$decalage++;
                } else {
                    $lastTool = $tool;
                }
                $compteurPrecedent++;
            }
        }
        return $compteurPrecedent;
    }

    /**
     * Edit an axis
M. Chardon's avatar
M. Chardon committed
158
     * @global type $DB
M. Chardon's avatar
M. Chardon committed
159
160
161
     * @param Integer $axeid axis' id
     * @param String $axisLabel new axis' label
     * @return Boolean true if the update is ok
M. Chardon's avatar
M. Chardon committed
162
163
164
165
166
167
168
169
170
     */
    public static function edit_axis($axeid, $axisLabel) {
        global $DB;

        $axis = $DB->get_record('assignfeedback_editpp_axis', array('id' => $axeid), '*', MUST_EXIST);
        $axis->label = $axisLabel;
        return $DB->update_record('assignfeedback_editpp_axis', $axis);
    }

171
    /**
M. Chardon's avatar
M. Chardon committed
172
     * Delete an axis
173
     * @global type $DB
M. Chardon's avatar
M. Chardon committed
174
175
     * @param Integer $axeid axis' id
     * @return Boolean true if the update is ok
176
177
178
179
180
     */
    public static function del_axis($axeid) {
        global $DB;
        return $DB->delete_records('assignfeedback_editpp_axis', array('id' => $axeid));
    }
M. Chardon's avatar
M. Chardon committed
181

M. Chardon's avatar
M. Chardon committed
182
183
184
185
186
187
    /**
     * Delete a tool
     * @global type $DB
     * @param \assignfeedback_editpdfplus\tool $tool
     * @return Boolean true if the remove is ok
     */
M. Chardon's avatar
M. Chardon committed
188
189
190
191
192
    public static function del_tool($tool) {
        global $DB;
        return $DB->delete_records('assignfeedback_editpp_tool', array('id' => $tool->toolid));
    }

M. Chardon's avatar
M. Chardon committed
193
194
195
196
197
198
    /**
     * Get all tools by an axis' id
     * @global type $DB
     * @param Integer $axisid axis' id
     * @return array<\assignfeedback_editpdfplus\tool> the toolbar, order by order_tool
     */
M. Chardon's avatar
M. Chardon committed
199
    public static function get_tools_by_axis($axisid) {
M. Chardon's avatar
M. Chardon committed
200
201
        global $DB;
        $tools = array();
M. Chardon's avatar
M. Chardon committed
202
        $records = $DB->get_records('assignfeedback_editpp_tool', array('axis' => $axisid));
M. Chardon's avatar
M. Chardon committed
203
        foreach ($records as $record) {
204
            array_push($tools, new tool($record));
M. Chardon's avatar
M. Chardon committed
205
206
207
208
209
210
211
212
213
214
215
216
217
        }
        usort($tools, function($a, $b) {
            $al = $a->order_tool;
            $bl = $b->order_tool;
            if ($al == $bl) {
                return 0;
            }
            return ($al > $bl) ? +1 : -1;
        });
        return $tools;
    }

    /**
M. Chardon's avatar
M. Chardon committed
218
     * Update a tool
M. Chardon's avatar
M. Chardon committed
219
     * @global type $DB
M. Chardon's avatar
M. Chardon committed
220
221
     * @param object $toolJson object contains tool's values to update
     * @return \assignfeedback_editpdfplus\tool
M. Chardon's avatar
M. Chardon committed
222
223
224
225
     */
    public static function edit_tool($toolJson) {
        global $DB;

M. Chardon's avatar
M. Chardon committed
226
        $record = $DB->get_record('assignfeedback_editpp_tool', array('id' => $toolJson->toolid), '*', MUST_EXIST);
M. Chardon's avatar
M. Chardon committed
227
228
229
230
231
232
233
        $tool = new tool($record);
        $tool->type = $toolJson->typetool;
        $tool->colors = $toolJson->color;
        $tool->cartridge = $toolJson->libelle;
        $tool->cartridge_color = $toolJson->catridgecolor;
        $tool->texts = $toolJson->texts;
        $tool->label = $toolJson->button;
M. Chardon's avatar
M. Chardon committed
234
235
236
        $tool->enabled = $toolJson->enabled;
        if ($toolJson->reply == "on") {
            $tool->reply = 1;
M. Chardon's avatar
M. Chardon committed
237
238
239
        } else {
            $tool->reply = 0;
        }
M. Chardon's avatar
M. Chardon committed
240
241
242
243
244
        $reorder = false;
        if ($tool->order_tool != $toolJson->order) {
            $tool->order_tool = $toolJson->order;
            $reorder = true;
        }
M. Chardon's avatar
M. Chardon committed
245
        if ($DB->update_record('assignfeedback_editpp_tool', $tool)) {
M. Chardon's avatar
M. Chardon committed
246
247
248
            if ($reorder) {
                admin_editor::reorder_tool($tool->axis, $tool->id);
            }
M. Chardon's avatar
M. Chardon committed
249
250
251
252
253
            return $tool;
        }
        return null;
    }

254
    /**
M. Chardon's avatar
M. Chardon committed
255
256
     * Get all the type tools which are configurabled.
     * @return array<\assignfeedback_editpdfplus\type_tool> array of type tools
257
258
259
260
261
262
263
264
265
266
267
     */
    public static function get_typetools() {
        global $DB;
        $typetools = array();
        $records = $DB->get_records('assignfeedback_editpp_typet', array('configurable' => 1));
        foreach ($records as $record) {
            array_push($typetools, new type_tool($record));
        }
        return $typetools;
    }

M. Chardon's avatar
M. Chardon committed
268
269
270
271
272
273
    /**
     * Get axis by its id
     * @global type $DB
     * @param Integer $axeid axis' id
     * @return \assignfeedback_editpdfplus\axis the axis
     */
M. Chardon's avatar
M. Chardon committed
274
275
276
277
278
279
    public static function getAxisById($axeid) {
        global $DB;
        $axis = $DB->get_record('assignfeedback_editpp_axis', array('id' => $axeid), '*', MUST_EXIST);
        return $axis;
    }

M. Chardon's avatar
M. Chardon committed
280
281
282
283
284
285
286
    /**
     * Clone an axis to the context given in parameter
     * @global type $DB
     * @param \assignfeedback_editpdfplus\axis $axisOrigin
     * @param Integer $context context's id
     * @return Integer id of the imported axis
     */
M. Chardon's avatar
M. Chardon committed
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
    public static function import_axis($axisOrigin, $context) {
        global $DB;
        $record = $DB->get_record_sql('SELECT max(order_axis) as order_max FROM {assignfeedback_editpp_axis} WHERE contextid = :contextid', array('contextid' => $context));

        $axis = new axis();
        $axis->contextid = $context;
        $axis->label = $axisOrigin->label;
        if ($record->order_max == null) {
            $axis->order_axis = 1;
        } else {
            $axis->order_axis = $record->order_max + 1;
        }

        return $DB->insert_record('assignfeedback_editpp_axis', $axis);
    }

M. Chardon's avatar
M. Chardon committed
303
304
305
306
307
308
309
310
    /**
     * Clone a tool to a new axis
     * @global type $DB
     * @param \assignfeedback_editpdfplus\tool $toolToImport tool to duplicate
     * @param \assignfeedback_editpdfplus\axis $axeNew axis to attached new tool
     * @param Integer $context context's id
     * @return Integer id of tool's created
     */
M. Chardon's avatar
M. Chardon committed
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
    public static function import_tool($toolToImport, $axeNew, $context) {
        global $DB;
        $record = $DB->get_record_sql('SELECT max(order_tool) as order_max FROM {assignfeedback_editpp_tool} WHERE contextid = :contextid', array('axis' => $axeNew->id, 'contextid' => $context));

        $tool = new tool();
        $tool->axis = $axeNew;
        $tool->cartridge = $toolToImport->cartridge;
        $tool->cartridge_color = $toolToImport->cartridge_color;
        $tool->colors = $toolToImport->colors;
        $tool->contextid = $context;
        $tool->enabled = $toolToImport->enabled;
        $tool->label = $toolToImport->label;
        $tool->reply = $toolToImport->reply;
        $tool->texts = $toolToImport->texts;
        $tool->type = $toolToImport->type;
        if ($record->order_max == null) {
            $tool->order_tool = 1;
        } else {
            $tool->order_tool = $record->order_max + 1;
        }
        return $DB->insert_record('assignfeedback_editpp_tool', $tool);
    }

M. Chardon's avatar
M. Chardon committed
334
}