moodle-mod_htmlcert/element/border/classes/element.php

115 lines
4 KiB
PHP
Raw Normal View History

2013-07-23 09:45:58 +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/>.
namespace customcertelement_border;
2013-07-23 09:45:58 +00:00
defined('MOODLE_INTERNAL') || die();
2013-07-23 09:45:58 +00:00
/**
* 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 element extends \mod_customcert\element {
2013-07-23 09:45:58 +00:00
/**
* This function renders the form elements when adding a customcert element.
*
* @param \mod_customcert_edit_element_form $mform the edit_form instance
2013-07-23 09:45:58 +00:00
*/
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
2013-07-23 09:45:58 +00:00
* @param bool $preview true if it is a preview, false otherwise
*/
public function render($pdf, $preview) {
$colour = \TCPDF_COLORS::convertHTMLColorToDec($this->element->colour, $colour);
2013-07-23 09:45:58 +00:00
$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());
}
/**
* 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.
*/
public function render_html() {
return '';
}
2013-07-23 09:45:58 +00:00
/**
* 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
2013-07-23 09:45:58 +00:00
*/
public function definition_after_data($mform) {
if (!empty($this->element->data)) {
$this->element->width = $this->element->data;
}
2013-07-23 09:45:58 +00:00
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
2013-07-23 09:45:58 +00:00
* @return string the json encoded array
*/
public function save_unique_data($data) {
return $data->width;
}
}