Andrew Nicols
d56303aa54
Now that PHP has support for named parameters, and we can use them in
Moodle, we should ditch `$options` arrays and use first-class,
documented, parameters.
Whilst this may seem scary, dumb, overwhelming, please note that you do
not need to supply all args, for example, to change the last parameter
of `format_text` you no longer need to do this:
return \core\container::get(\core\formatting::class)->format_text(
$text,
FORMAT_MOODLE,
$context,
false,
null,
true,
true,
true,
false,
false,
true,
);
Instead you can do:
return \core\container::get(\core\formatting::class)->format_text(
$text,
FORMAT_MOODLE,
$context,
allowid: true,
);
Or better still:
return \core\container::get(\core\formatting::class)->format_text(
text: $text,
format: FORMAT_MOODLE,
context: $context,
allowid: true,
);
This means that we can get defaults in the function signature, improves
our typing, and allows for deprecation and changes to options. It also
sets us up for success in the future.
94 lines
3.3 KiB
PHP
94 lines
3.3 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/>.
|
|
|
|
/**
|
|
* Atto text editor integration version file.
|
|
*
|
|
* @package atto_equation
|
|
* @copyright 2013 Damyon Wiese <damyon@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Get the list of strings for this plugin.
|
|
* @param string $elementid
|
|
*/
|
|
function atto_equation_strings_for_js() {
|
|
global $PAGE;
|
|
|
|
$PAGE->requires->strings_for_js(array('saveequation',
|
|
'editequation',
|
|
'preview',
|
|
'cursorinfo',
|
|
'update',
|
|
'librarygroup1',
|
|
'librarygroup2',
|
|
'librarygroup3',
|
|
'librarygroup4'),
|
|
'atto_equation');
|
|
}
|
|
|
|
/**
|
|
* Set params for this plugin.
|
|
*
|
|
* @param string $elementid
|
|
* @param stdClass $options - the options for the editor, including the context.
|
|
* @param stdClass $fpoptions - unused.
|
|
*/
|
|
function atto_equation_params_for_js($elementid, $options, $fpoptions) {
|
|
$texexample = '$$\pi$$';
|
|
|
|
// Format a string with the active filter set.
|
|
// If it is modified - we assume that some sort of text filter is working in this context.
|
|
$formatoptions = [
|
|
'context' => $options['context'],
|
|
'noclean' => $options['noclean'] ?? false,
|
|
'trusted' => $options['trusted'] ?? false,
|
|
];
|
|
|
|
$result = format_text($texexample, true, $formatoptions);
|
|
|
|
$texfilteractive = ($texexample !== $result);
|
|
$context = $options['context'];
|
|
|
|
// Tex example librarys.
|
|
$library = array(
|
|
'group1' => array(
|
|
'groupname' => 'librarygroup1',
|
|
'elements' => get_config('atto_equation', 'librarygroup1'),
|
|
'active' => true,
|
|
),
|
|
'group2' => array(
|
|
'groupname' => 'librarygroup2',
|
|
'elements' => get_config('atto_equation', 'librarygroup2'),
|
|
),
|
|
'group3' => array(
|
|
'groupname' => 'librarygroup3',
|
|
'elements' => get_config('atto_equation', 'librarygroup3'),
|
|
),
|
|
'group4' => array(
|
|
'groupname' => 'librarygroup4',
|
|
'elements' => get_config('atto_equation', 'librarygroup4'),
|
|
));
|
|
|
|
return array('texfilteractive' => $texfilteractive,
|
|
'contextid' => $context->id,
|
|
'library' => $library,
|
|
'texdocsurl' => get_docs_url('Using_TeX_Notation'));
|
|
}
|