Introduced the border element
This commit is contained in:
Mark Nelson
parent
ae2081cf4c
commit
801f367616
3 changed files with 159 additions and 0 deletions
28
element/border/lang/en/customcertelement_border.php
Normal file
28
element/border/lang/en/customcertelement_border.php
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
<?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/>.
|
||||
|
||||
/**
|
||||
* Strings for component 'customcertelement_border', language 'en'.
|
||||
*
|
||||
* @package customcertelement_border
|
||||
* @copyright 2013 Mark Nelson <markn@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
$string['pluginname'] = 'Border';
|
||||
$string['invalidwidth'] = 'The width has to be a valid number greater than 0.';
|
||||
$string['width'] = 'Width';
|
||||
$string['width_help'] = 'Width of the border.';
|
||||
102
element/border/lib.php
Normal file
102
element/border/lib.php
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
<?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/>.
|
||||
|
||||
defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
|
||||
|
||||
require_once($CFG->dirroot . '/mod/customcert/element/element.class.php');
|
||||
|
||||
/**
|
||||
* The customcert element border's core interaction API.
|
||||
*
|
||||
* @package customcertelement_border
|
||||
* @copyright 2013 Mark Nelson <markn@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class customcert_element_border extends customcert_element_base {
|
||||
|
||||
/**
|
||||
* This function renders the form elements when adding a customcert element.
|
||||
*
|
||||
* @param mod_customcert_edit_element_form $mform the edit_form instance
|
||||
*/
|
||||
public function render_form_elements($mform) {
|
||||
// We want to define the width of the border.
|
||||
$mform->addElement('text', 'width', get_string('width', 'customcertelement_border'), array('size' => 10));
|
||||
$mform->setType('width', PARAM_INT);
|
||||
$mform->addHelpButton('width', 'width', 'customcertelement_border');
|
||||
|
||||
// The only other thing to define is the colour we want the border to be.
|
||||
parent::render_form_element_colour($mform);
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles rendering the element on the pdf.
|
||||
*
|
||||
* @param pdf $pdf the pdf object
|
||||
* @param bool $preview true if it is a preview, false otherwise
|
||||
*/
|
||||
public function render($pdf, $preview) {
|
||||
$colour = TCPDF_COLORS::convertHTMLColorToDec($this->element->colour, $colour);
|
||||
$pdf->SetLineStyle(array('width' => $this->element->data, 'color' => $colour));
|
||||
$pdf->Line(0, 0, $pdf->getPageWidth(), 0);
|
||||
$pdf->Line($pdf->getPageWidth(), 0, $pdf->getPageWidth(), $pdf->getPageHeight());
|
||||
$pdf->Line(0, $pdf->getPageHeight(), $pdf->getPageWidth(), $pdf->getPageHeight());
|
||||
$pdf->Line(0, 0, 0, $pdf->getPageHeight());
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs validation on the element values.
|
||||
*
|
||||
* @param array $data the submitted data
|
||||
* @param array $files the submitted files
|
||||
* @return array the validation errors
|
||||
*/
|
||||
public function validate_form_elements($data, $files) {
|
||||
// Array to return the errors.
|
||||
$errors = array();
|
||||
|
||||
// Check if width is not set, or not numeric or less than 0.
|
||||
if ((!isset($data['width'])) || (!is_numeric($data['width'])) || ($data['width'] <= 0)) {
|
||||
$errors['width'] = get_string('invalidwidth', 'customcertelement_border');
|
||||
}
|
||||
|
||||
// Validate the colour.
|
||||
$errors += $this->validate_form_element_colour($data);
|
||||
|
||||
return $errors;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the data on the form when editing an element.
|
||||
*
|
||||
* @param mod_customcert_edit_element_form $mform the edit_form instance
|
||||
*/
|
||||
public function definition_after_data($mform) {
|
||||
$this->element->width = $this->element->data;
|
||||
parent::definition_after_data($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
|
||||
* @return string the json encoded array
|
||||
*/
|
||||
public function save_unique_data($data) {
|
||||
return $data->width;
|
||||
}
|
||||
}
|
||||
29
element/border/version.php
Normal file
29
element/border/version.php
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
<?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/>.
|
||||
|
||||
/**
|
||||
* This file contains the version information for the border plugin.
|
||||
*
|
||||
* @package customcertelement_border
|
||||
* @copyright 2013 Mark Nelson <markn@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
|
||||
|
||||
$plugin->version = 2013072301;
|
||||
$plugin->requires = 2013040500; // Requires this Moodle version.
|
||||
$plugin->component = 'customcertelement_border';
|
||||
Loading…
Reference in a new issue