Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?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/>.

/**
 * Checkbox element used for bulk inserting values in the gradebook.
 *
 * @package   gradereport_singleview
 * @copyright 2014 Moodle Pty Ltd (http://moodle.com)
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace gradereport_singleview\local\ui;

< use html_writer; <
defined('MOODLE_INTERNAL') || die; /** * Checkbox element used for bulk inserting values in the gradebook. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class bulk_insert extends element {
> /** @var string $applyname To store the "apply" suffix. */ /** > protected $applyname; * Constructor > * > /** @var string $selectname To store the "type" suffix. */ * @param mixed $item The grade item or user. > protected $selectname; */ > public function __construct($item) { > /** @var string $insertname To store the "value" suffix. */ $this->name = 'bulk_' . $item->id; > protected $insertname; $this->applyname = $this->name_for('apply'); >
$this->selectname = $this->name_for('type'); $this->insertname = $this->name_for('value'); } /** * Is this checkbox checked? *
< * @param array $data The form data
> * @param array|object $data The form data
* @return bool */
< public function is_applied($data) {
> public function is_applied($data): bool {
return isset($data->{$this->applyname}); } /** * Get the type of this input (user or grade) *
< * @param array $data The form data
> * @param array|object $data The form data
* @return string */
< public function get_type($data) {
> public function get_type($data): string {
return $data->{$this->selectname}; } /** * Get the value from either the user or grade. *
< * @param array $data The form data
> * @param array|object $data The form data
* @return string */
< public function get_insert_value($data) {
> public function get_insert_value($data): string {
return $data->{$this->insertname}; } /** * Generate the html for this form element. * * @return string HTML */
< public function html() {
> public function html(): string {
global $OUTPUT; $text = new text_attribute($this->insertname, "0", 'bulk'); $context = (object) [ 'label' => get_string('bulklegend', 'gradereport_singleview'), 'applylabel' => get_string('bulkperform', 'gradereport_singleview'), 'applyname' => $this->applyname, 'menuname' => $this->selectname, 'menulabel' => get_string('bulkappliesto', 'gradereport_singleview'), 'menuoptions' => [ ['value' => 'all', 'name' => get_string('all_grades', 'gradereport_singleview')], ['value' => 'blanks', 'name' => get_string('blanks', 'gradereport_singleview'), 'selected' => true], ], 'valuename' => $this->insertname,
< 'valuelabel' => get_string('bulkinsertvalue', 'gradereport_singleview'),
'valuefield' => $text->html() ]; return $OUTPUT->render_from_template('gradereport_singleview/bulk_insert', $context); } /** * This form element has 3 elements with different suffixes. * Generate the name with the suffix. * * @param string $extend The suffix. * @return string */ private function name_for($extend) { return "{$this->name}_$extend"; } }