Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 172
Expand file tree
/
Copy pathoptions.class.php
More file actions
431 lines (401 loc) · 15.5 KB
/
Copy pathoptions.class.php
File metadata and controls
431 lines (401 loc) · 15.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
<?php
// This file is part of Stack - http://stack.maths.ed.ac.uk/
//
// Stack 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.
//
// Stack 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 Stack. If not, see <http://www.gnu.org/licenses/>.
/**
* Options enable a context to be set for each question, and information
* made generally available to other classes.
*
* @package qtype_stack
* @copyright 2012 The University of Birmingham
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class stack_options {
// phpcs:ignore moodle.Commenting.VariableComment.Missing
private $options;
// phpcs:ignore moodle.Commenting.MissingDocblock.Function
public function __construct($settings = []) {
// OptionType can be: boolean, string, html, list.
$this->options = [ // Array of public class settings for this class.
'display' => [
'type' => 'list',
'value' => 'LaTeX',
'strict' => true,
'values' => ['LaTeX', 'String'],
'caskey' => 'OPT_OUTPUT',
'castype' => 'string',
],
'decimals' => [
'type' => 'list',
'value' => '.',
'strict' => true,
'values' => ['.', ','],
'caskey' => 'texput_decimal',
'castype' => 'fun',
],
'scientificnotation' => [
'type' => 'list',
'value' => '*10',
'strict' => true,
'values' => ['*10', 'E'],
'caskey' => 'texput_scientificnotation',
'castype' => 'fun',
],
'multiplicationsign' => [
'type' => 'list',
'value' => 'dot',
'strict' => true,
'values' => ['dot', 'cross', 'onum', 'none', 'space'],
'caskey' => 'make_multsgn',
'castype' => 'fun',
],
'complexno' => [
'type' => 'list',
'value' => 'i',
'strict' => true,
'values' => ['i', 'j', 'symi', 'symj'],
'caskey' => 'make_complexJ',
'castype' => 'fun',
],
'inversetrig' => [
'type' => 'list',
'value' => 'cos-1',
'strict' => true,
'values' => ['cos-1', 'acos', 'arccos', 'arsinh'],
'caskey' => 'make_arccos',
'castype' => 'fun',
],
'logicsymbol' => [
'type' => 'list',
'value' => 'lang',
'strict' => true,
'values' => ['lang', 'symbol'],
'caskey' => 'make_logic',
'castype' => 'fun',
],
'sqrtsign' => [
'type' => 'boolean',
'value' => true,
'strict' => true,
'values' => [],
'caskey' => 'sqrtdispflag',
'castype' => 'ex',
],
'simplify' => [
'type' => 'boolean',
'value' => true,
'strict' => true,
'values' => [],
'caskey' => 'simp',
'castype' => 'ex',
],
'assumepos' => [
'type' => 'boolean',
'value' => false,
'strict' => true,
'values' => [],
'caskey' => 'assume_pos',
'castype' => 'ex',
],
'assumereal' => [
'type' => 'boolean',
'value' => false,
'strict' => true,
'values' => [],
'caskey' => 'assume_real',
'castype' => 'ex',
],
'matrixparens' => [
'type' => 'list',
'value' => '[',
'strict' => true,
'values' => ['[', '(', '', '{', '|'],
'caskey' => 'lmxchar',
'castype' => 'exs',
],
];
if (!is_array($settings)) {
throw new stack_exception('stack_options: $settings must be an array.');
}
// Overright them from any input.
foreach ($settings as $key => $val) {
if (!array_key_exists($key, $this->options)) {
throw new stack_exception('stack_options construct: $key ' . $key . ' is not a valid option name.');
} else {
$this->options[$key]['value'] = $val;
}
}
}
// phpcs:ignore moodle.Commenting.MissingDocblock.Function
public function set_site_defaults() {
$stackconfig = stack_utils::get_config();
// Display option does not match up to $stackconfig->mathsdisplay).
$this->set_option('decimals', $stackconfig->decimals);
$this->set_option('scientificnotation', $stackconfig->scientificnotation);
$this->set_option('multiplicationsign', $stackconfig->multiplicationsign);
$this->set_option('complexno', $stackconfig->complexno);
$this->set_option('inversetrig', $stackconfig->inversetrig);
$this->set_option('logicsymbol', $stackconfig->logicsymbol);
$this->set_option('matrixparens', $stackconfig->matrixparens);
$this->set_option('sqrtsign', (bool) $stackconfig->sqrtsign);
$this->set_option('simplify', (bool) $stackconfig->questionsimplify);
$this->set_option('assumepos', (bool) $stackconfig->assumepositive);
$this->set_option('assumereal', (bool) $stackconfig->assumereal);
return true;
}
/**
* This function validates the information.
*/
private function validate_key($key, $val) {
if (!array_key_exists($key, $this->options)) {
throw new stack_exception('stack_options set_option: $key ' . $key . ' is not a valid option name.');
}
$optiontype = $this->options[$key]['type'];
switch ($optiontype) {
case 'boolean':
if (!is_bool($val)) {
throw new stack_exception('stack_options: set: boolean option ' . $key . ' Recieved non-boolean value ' . $val);
}
break;
case 'list':
if (!in_array($val, $this->options[$key]['values'])) {
throw new stack_exception('stack_options set option ' . $val . ' for ' . $key . ' is invalid');
}
break;
}
return true;
}
// phpcs:ignore moodle.Commenting.MissingDocblock.Function
public function get_option($key) {
if (!array_key_exists($key, $this->options)) {
throw new stack_exception('stack_options get_option: $key ' . $key . ' is not a valid option name.');
} else {
return $this->options[$key]['value'];
}
}
// phpcs:ignore moodle.Commenting.MissingDocblock.Function
public function set_option($key, $val) {
$this->validate_key($key, $val); // Throws an exception on error.
$this->options[$key]['value'] = $val;
}
// phpcs:ignore moodle.Commenting.MissingDocblock.Function
public function get_cas_commands() {
$names = '';
$commands = '';
foreach ($this->options as $key => $opt) {
if (null != $opt['castype']) {
if ('boolean' === $opt['type']) {
if ($opt['value']) {
$value = 'true';
} else {
$value = 'false';
}
} else {
$value = $opt['value'];
}
if ('ex' == $opt['castype']) {
$names .= ', ' . $opt['caskey'];
$commands .= stack_cas_session2::SEP . $opt['caskey'] . ':' . $value;
} else if ('exs' == $opt['castype']) {
$names .= ', ' . $opt['caskey'];
$commands .= stack_cas_session2::SEP . $opt['caskey'] . ':"' . $value . '"';
} else if ('fun' == $opt['castype']) {
// Make sure these options are *strings*, otherwise they clash
// with Maxim names, particularly alias.
$commands .= stack_cas_session2::SEP . $opt['caskey'] . '("' . $value . '")';
}
}
}
$ret = ['names' => $names, 'commands' => $commands];
return $ret;
}
/**
* Add description here.
* @return array of choices for a no/yes select menu.
*/
public static function get_yes_no_options() {
return [
'0' => get_string('no'),
'1' => get_string('yes'),
];
}
/**
* Add description here.
* @return array of choices for the insert stars select menu.
*/
public static function get_insert_star_options() {
return [
'0' => get_string('insertstarsno', 'qtype_stack'),
'1' => get_string('insertstarsyes', 'qtype_stack'),
'2' => get_string('insertstarsassumesinglechar', 'qtype_stack'),
'3' => get_string('insertspaces', 'qtype_stack'),
'4' => get_string('insertstarsspaces', 'qtype_stack'),
'5' => get_string('insertstarsspacessinglechar', 'qtype_stack'),
'6' => get_string('insertspacesfunctions', 'qtype_stack'),
'7' => get_string('insertspacesfunctionssingle', 'qtype_stack'),
];
}
/**
* Add description here.
* @return array of choices for the input syntax hint display attribute.
*/
public static function get_syntax_attribute_options() {
return [
'0' => get_string('syntaxattributevalue', 'qtype_stack'),
'1' => get_string('syntaxattributeplaceholder', 'qtype_stack'),
];
}
/**
* Add description here.
* @return array of choices for the decimal sign select menu.
*/
public static function get_decimals_sign_options() {
return [
'.' => '.',
',' => ',',
];
}
/**
* Add description here.
* @return array of choices for the scientific notation select menu.
*/
public static function get_scientificnotation_options() {
return [
'*10' => get_string('scientificnotation_10', 'qtype_stack'),
'E' => get_string('scientificnotation_E', 'qtype_stack'),
];
}
/**
* Add description here.
* @return array of choices for the multiplication sign select menu.
*/
public static function get_multiplication_sign_options() {
return [
'dot' => get_string('multdot', 'qtype_stack'),
'cross' => get_string('multcross', 'qtype_stack'),
'onum' => get_string('multonlynumbers', 'qtype_stack'),
'space' => get_string('multspace', 'qtype_stack'),
'none' => get_string('none'),
];
}
/**
* Add description here.
* @return array of choices for the complex number select menu.
*/
public static function get_complex_no_options() {
return [
'i' => 'i',
'j' => 'j',
'symi' => 'symi',
'symj' => 'symj',
];
}
/**
* Add description here.
* @return array of choices for the inverse trig select menu.
*/
public static function get_inverse_trig_options() {
return [
'cos-1' => "cos\xe2\x81\xbb\xc2\xb9(x)",
'acos' => 'acos(x)',
'arccos' => 'arccos(x)',
'arsinh' => 'arsinh(x)',
];
}
/**
* Add description here.
* @return array of choices for the inverse trig select menu.
*/
public static function get_logic_options() {
return [
'lang' => get_string('logicsymbollang', 'qtype_stack'),
'symbol' => get_string('logicsymbolsymbol', 'qtype_stack'),
];
}
/**
* Add description here.
* @return array of choices for the matrix prenthesis select menu.
*/
public static function get_matrix_parens_options() {
return [
'[' => '[',
'(' => '(',
'' => '',
'{' => '{',
'|' => '|',
];
}
/**
* Add description here.
* @return array of choices for the show validation select menu.
*/
public static function get_showvalidation_options() {
return [
'0' => get_string('showvalidationno', 'qtype_stack'),
'1' => get_string('showvalidationyes', 'qtype_stack'),
'2' => get_string('showvalidationyesnovars', 'qtype_stack'),
'3' => get_string('showvalidationcompact', 'qtype_stack'),
];
}
/**
* Add description here.
* @return array of choices for the monospace input select menu.
*/
public static function get_monospace_options() {
return [
// Options will appear in order listed, not key order.
// Keys need to match is_monospace() below.
'0' => get_string('inputtypealgebraic', 'qtype_stack'),
'1' => get_string('inputtypenumerical', 'qtype_stack'),
'2' => get_string('inputtypeunits', 'qtype_stack'),
'3' => get_string('inputtypevarmatrix', 'qtype_stack'),
'4' => get_string('inputtypetextarea', 'qtype_stack'),
'5' => get_string('inputtypeequiv', 'qtype_stack'),
'6' => get_string('inputtypefreetext', 'qtype_stack'),
];
}
/**
* Get the monospace default for supplied input class.
* @return bool
*
* We have a class name in format 'stack_XXXX_input' where 'XXXX' is the input type.
* The monospace default config setting is a string in format '0,2,4' where the integers are
* the array keys from the option selection in get_monospace_options().
* We have to convert the input type to an integer and then check if it's in the config string.
*/
public static function is_monospace($class) {
$options = [
// These need to match get_monospace_options() above.
'0' => 'algebraic',
'1' => 'numerical',
'2' => 'units',
'3' => 'varmatrix',
'4' => 'textarea',
'5' => 'equiv',
'6' => 'freetext',
];
$optionkey = array_search(explode('_', $class)[1], $options);
if ($optionkey === false) {
// This type of input not allowed to be monospace.
return false;
}
$monoinputkeys = explode(',', get_config('qtype_stack', 'inputmonospace'));
$key = array_search(strval($optionkey), $monoinputkeys, true);
if ($key === false) {
return false;
} else {
return true;
}
}
}
You can’t perform that action at this time.