moodle-mod-customcert/element/gradeitemname/classes/element.php

130 lines
4.3 KiB
PHP
Raw Normal View History

2013-07-24 11:34:43 +00:00
<?php
// This file is part of the customcert module for 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/>.
2017-02-16 12:12:19 +00:00
/**
* This file contains the customcert element gradeitemname's core interaction API.
*
* @package customcertelement_gradeitemname
* @copyright 2013 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace customcertelement_gradeitemname;
2013-07-24 11:34:43 +00:00
defined('MOODLE_INTERNAL') || die();
2013-07-24 11:34:43 +00:00
/**
* The customcert element gradeitemname's core interaction API.
*
* @package customcertelement_gradeitemname
* @copyright 2013 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class element extends \mod_customcert\element {
2013-07-24 11:34:43 +00:00
/**
* This function renders the form elements when adding a customcert element.
*
* @param \MoodleQuickForm $mform the edit_form instance
2013-07-24 11:34:43 +00:00
*/
public function render_form_elements($mform) {
global $COURSE;
2013-07-24 11:34:43 +00:00
$mform->addElement('select', 'gradeitem', get_string('gradeitem', 'customcertelement_gradeitemname'),
\mod_customcert\element_helper::get_grade_items($COURSE));
2013-07-24 11:34:43 +00:00
$mform->addHelpButton('gradeitem', 'gradeitem', 'customcertelement_gradeitemname');
parent::render_form_elements($mform);
}
/**
* This will handle how form data will be saved into the data column in the
* customcert_elements table.
*
* @param \stdClass $data the form data
2013-07-24 11:34:43 +00:00
* @return string the text
*/
public function save_unique_data($data) {
if (!empty($data->gradeitem)) {
return $data->gradeitem;
}
return '';
2013-07-24 11:34:43 +00:00
}
/**
* Handles rendering the element on the pdf.
*
* @param \pdf $pdf the pdf object
2013-07-24 11:34:43 +00:00
* @param bool $preview true if it is a preview, false otherwise
* @param \stdClass $user the user we are rendering this for
2013-07-24 11:34:43 +00:00
*/
public function render($pdf, $preview, $user) {
// Check that the grade item is not empty.
if (!empty($this->get_data())) {
\mod_customcert\element_helper::render_content($pdf, $this, $this->get_grade_item_name());
}
2013-07-24 11:34:43 +00:00
}
/**
* Render the element in html.
*
* This function is used to render the element when we are using the
* drag and drop interface to position it.
*
* @return string the html
*/
public function render_html() {
// Check that the grade item is not empty.
if (!empty($this->get_data())) {
return \mod_customcert\element_helper::render_html_content($this, $this->get_grade_item_name());
}
return '';
}
2013-07-24 11:34:43 +00:00
/**
* Sets the data on the form when editing an element.
*
* @param \MoodleQuickForm $mform the edit_form instance
2013-07-24 11:34:43 +00:00
*/
public function definition_after_data($mform) {
if (!empty($this->get_data())) {
$element = $mform->getElement('gradeitem');
$element->setValue($this->get_data());
}
2013-07-24 11:34:43 +00:00
parent::definition_after_data($mform);
}
/**
* Helper function that returns the category name.
*
* @return string
*/
protected function get_grade_item_name() : string {
global $DB;
// Get the course module information.
$cm = $DB->get_record('course_modules', array('id' => $this->get_data()), '*', MUST_EXIST);
$module = $DB->get_record('modules', array('id' => $cm->module), '*', MUST_EXIST);
// Get the name of the item.
$itemname = $DB->get_field($module->name, 'name', array('id' => $cm->instance), MUST_EXIST);
return format_string($itemname, true, ['context' => \mod_customcert\element_helper::get_context($this->get_id())]);
}
2013-07-24 11:34:43 +00:00
}