KumiSystems/moodle-local_mycerts
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
moodle-local_mycerts/elements/element.class.php

301 lines
11 KiB
PHP
Raw Normal View History

Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +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/>.
/**
* The base class for the customcert elements.
*
* @package mod
* @subpackage customcert
* @copyright Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
class customcert_element_base {
/**
* The data for the element we are adding.
*/
public $element;
/**
* Constructor.
*
* @param stdClass $element the element data
*/
function __construct($element) {
$this->element = new stdClass();
$this->element = $element;
}
/**
* This function is responsible for adding the element for the first time
* to the database when no data has yet been specified, default values set.
* Can be overriden if more functionality is needed.
*
* @param string $element the name of the element
* @param int $pageid the page id we are saving it to
*/
public static function add_element($element, $pageid) {
global $DB;
$data = new stdClass();
$data->pageid = $pageid;
$data->element = $element;
$data->font = 'Times-Roman';
$data->size = '12';
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
$data->colour = '#FFFFFF';
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
$data->posx = '250';
$data->posy = '250';
$data->timecreated = time();
$DB->insert_record('customcert_elements', $data);
}
/**
* This function renders the form elements when adding a customcert element.
Changed how the elements are rendered when editing the customcert Rather than using grouped elements which can span across multiple lines on a small screen, the elements are now generated within a header element, keeping them separated and making the form more manageable. The base class was also changed to accomodate this by making it easier for elements to utilise common features.
2013-02-22 09:25:14 +00:00
* Must be overriden.
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
*
* @param stdClass $mform the edit_form instance.
* @return array the form elements
*/
public function render_form_elements($mform) {
Changed how the elements are rendered when editing the customcert Rather than using grouped elements which can span across multiple lines on a small screen, the elements are now generated within a header element, keeping them separated and making the form more manageable. The base class was also changed to accomodate this by making it easier for elements to utilise common features.
2013-02-22 09:25:14 +00:00
// Must be overriden.
return false;
}
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
Changed how the elements are rendered when editing the customcert Rather than using grouped elements which can span across multiple lines on a small screen, the elements are now generated within a header element, keeping them separated and making the form more manageable. The base class was also changed to accomodate this by making it easier for elements to utilise common features.
2013-02-22 09:25:14 +00:00
/**
* This function renders the common form elements when adding a customcert element.
*
* @param stdClass $mform the edit_form instance.
* @return array the form elements
*/
public function render_common_form_elements($mform) {
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
// The identifier.
$id = $this->element->id;
Changed how the elements are rendered when editing the customcert Rather than using grouped elements which can span across multiple lines on a small screen, the elements are now generated within a header element, keeping them separated and making the form more manageable. The base class was also changed to accomodate this by making it easier for elements to utilise common features.
2013-02-22 09:25:14 +00:00
// Commonly used string.
$strrequired = get_string('required');
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
// The common elements.
Changed how the elements are rendered when editing the customcert Rather than using grouped elements which can span across multiple lines on a small screen, the elements are now generated within a header element, keeping them separated and making the form more manageable. The base class was also changed to accomodate this by making it easier for elements to utilise common features.
2013-02-22 09:25:14 +00:00
$mform->addElement('select', 'font_' . $id, get_string('font', 'customcert'), customcert_get_fonts());
$mform->addElement('select', 'size_' . $id, get_string('fontsize', 'customcert'), customcert_get_font_sizes());
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
$mform->addElement('customcert_colourpicker', 'colour_' . $id, get_string('fontcolour', 'customcert'));
Changed how the elements are rendered when editing the customcert Rather than using grouped elements which can span across multiple lines on a small screen, the elements are now generated within a header element, keeping them separated and making the form more manageable. The base class was also changed to accomodate this by making it easier for elements to utilise common features.
2013-02-22 09:25:14 +00:00
$mform->addElement('text', 'posx_' . $id, get_string('posx', 'customcert'), array('size' => 10));
$mform->addElement('text', 'posy_' . $id, get_string('posy', 'customcert'), array('size' => 10));
// Set the types of these elements.
$mform->setType('font_' . $id, PARAM_TEXT);
$mform->setType('size_' . $id, PARAM_INT);
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
$mform->setType('colour_' . $id, PARAM_RAW); // Need to validate that this is a valid colour.
Changed how the elements are rendered when editing the customcert Rather than using grouped elements which can span across multiple lines on a small screen, the elements are now generated within a header element, keeping them separated and making the form more manageable. The base class was also changed to accomodate this by making it easier for elements to utilise common features.
2013-02-22 09:25:14 +00:00
$mform->setType('posx_' . $id, PARAM_INT);
$mform->setType('posy_' . $id, PARAM_INT);
// Add some rules.
$mform->addRule('colour_' . $id, $strrequired, 'required', null, 'client');
$mform->addRule('posx_' . $id, $strrequired, 'required', null, 'client');
$mform->addRule('posy_' . $id, $strrequired, 'required', null, 'client');
// Set the values of these elements.
$mform->setDefault('font_' . $id, $this->element->font);
$mform->setDefault('size_' . $id, $this->element->size);
$mform->setDefault('colour_' . $id, $this->element->colour);
$mform->setDefault('posx_' . $id, $this->element->posx);
$mform->setDefault('posy_' . $id, $this->element->posy);
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
Changed how the elements are rendered when editing the customcert Rather than using grouped elements which can span across multiple lines on a small screen, the elements are now generated within a header element, keeping them separated and making the form more manageable. The base class was also changed to accomodate this by making it easier for elements to utilise common features.
2013-02-22 09:25:14 +00:00
// Add help buttons.
$mform->addHelpButton('font_' . $id, 'font', 'customcert');
$mform->addHelpButton('size_' . $id, 'fontsize', 'customcert');
$mform->addHelpButton('colour_' . $id, 'fontcolour', 'customcert');
$mform->addHelpButton('posx_' . $id, 'posx', 'customcert');
$mform->addHelpButton('posy_' . $id, 'posy', 'customcert');
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
}
/**
* Performs validation on the element values.
* Can be overridden if more functionality is needed.
*
* @param array $data the submitted data
* @return array the validation errors
*/
public function validate_form_elements($data, $files) {
$errors = array();
// The identifier.
$id = $this->element->id;
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
// Validate the colour.
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
$colour = 'colour_' . $id;
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
$colourdata = $data[$colour];
if (!$this->validate_colour($colourdata)) {
$errors[$colour] = get_string('invalidcolour', 'customcert');
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
}
// Get position X.
$posx = 'posx_' . $id;
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
$posxdata = $data[$posx];
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
// Check if posx is not numeric or less than 0.
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
if ((!is_numeric($posxdata)) || ($posxdata < 0)) {
$errors[$posx] = get_string('invalidposition', 'customcert', 'X');
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
}
// Get position Y.
$posy = 'posy_' . $id;
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
$posydata = $data[$posy];
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
// Check if posy is not numeric or less than 0.
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
if ((!is_numeric($posydata)) || ($posydata < 0)) {
$errors[$posy] = get_string('invalidposition', 'customcert', 'Y');
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
}
return $errors;
}
/**
* Handles saving the form elements created by this element.
* Can be overriden if more functionality is needed.
*
* @param stdClass $data the form data.
*/
public function save_form_elements($data) {
global $DB;
// The identifier.
$id = $this->element->id;
// Get the name of the fields we want from the form.
Introduced the grade element
2013-02-22 08:15:32 +00:00
$datainfo = $this->save_unique_data($data);
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
$font = 'font_' . $id;
$size = 'size_' . $id;
$colour = 'colour_' . $id;
$posx = 'posx_' . $id;
$posy = 'posy_' . $id;
// Get the data from the form.
$element = new stdClass();
$element->id = $id;
Introduced the grade element
2013-02-22 08:15:32 +00:00
$element->data = $datainfo;
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
$element->font = (!empty($data->$font)) ? $data->$font : null;
$element->size = (!empty($data->$size)) ? $data->$size : null;
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
$element->colour = (!empty($data->$colour)) ? $data->$colour : null;
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
$element->posx = (!empty($data->$posx)) ? $data->$posx : null;
$element->posy = (!empty($data->$posy)) ? $data->$posy : null;
// Ok, now update record in the database.
$DB->update_record('customcert_elements', $element);
}
Introduced the grade element
2013-02-22 08:15:32 +00:00
/**
* This will handle how form data will be saved into the data column in the
* customcert column.
* Can be overriden if more functionality is needed.
*
* @param stdClass $data the form data.
*/
public function save_unique_data($data) {
return null;
}
Introduced customisable elements to the customcert Elements are sub-plugins that have the same abilities as a core plugin, such as creating tables, capabilities and performing upgrades. Currently elements can define - * What additional form elements are rendered when adding the element to the customcert customisation page. * How the data from the additional form elements is validated and saved. * How the element is rendered on the PDF. * How the element handles removing data when it is deleted.
2013-02-20 12:21:57 +00:00
/**
* Handles displaying the element on the pdf.
* Must be overriden.
*
* @param stdClass the pdf object, see lib/pdflib.php
*/
public function display($pdf) {
// Must be overriden.
return false;
}
/**
* Handles deleting any data this element may have introduced.
* Can be overriden if more functionality is needed.
*
* @return bool success return true if deletion success, false otherwise
*/
public function delete_element() {
global $DB;
return $DB->delete_records('customcert_elements', array('id' => $this->element->id));
}
Introduced a new form element for selecting a colour on the customcert customisation page
2013-02-24 15:41:33 +00:00
/**
* Validates the colour selected.
*
* @param string $data
* @return string|false
*/
protected function validate_colour($colour) {
/**
* List of valid HTML colour names
*
* @var array
*/
$colournames = array(
'aliceblue', 'antiquewhite', 'aqua', 'aquamarine', 'azure',
'beige', 'bisque', 'black', 'blanchedalmond', 'blue',
'blueviolet', 'brown', 'burlywood', 'cadetblue', 'chartreuse',
'chocolate', 'coral', 'cornflowerblue', 'cornsilk', 'crimson',
'cyan', 'darkblue', 'darkcyan', 'darkgoldenrod', 'darkgray',
'darkgrey', 'darkgreen', 'darkkhaki', 'darkmagenta',
'darkolivegreen', 'darkorange', 'darkorchid', 'darkred',
'darksalmon', 'darkseagreen', 'darkslateblue', 'darkslategray',
'darkslategrey', 'darkturquoise', 'darkviolet', 'deeppink',
'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue', 'firebrick',
'floralwhite', 'forestgreen', 'fuchsia', 'gainsboro',
'ghostwhite', 'gold', 'goldenrod', 'gray', 'grey', 'green',
'greenyellow', 'honeydew', 'hotpink', 'indianred', 'indigo',
'ivory', 'khaki', 'lavender', 'lavenderblush', 'lawngreen',
'lemonchiffon', 'lightblue', 'lightcoral', 'lightcyan',
'lightgoldenrodyellow', 'lightgray', 'lightgrey', 'lightgreen',
'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue',
'lightslategray', 'lightslategrey', 'lightsteelblue', 'lightyellow',
'lime', 'limegreen', 'linen', 'magenta', 'maroon',
'mediumaquamarine', 'mediumblue', 'mediumorchid', 'mediumpurple',
'mediumseagreen', 'mediumslateblue', 'mediumspringgreen',
'mediumturquoise', 'mediumvioletred', 'midnightblue', 'mintcream',
'mistyrose', 'moccasin', 'navajowhite', 'navy', 'oldlace', 'olive',
'olivedrab', 'orange', 'orangered', 'orchid', 'palegoldenrod',
'palegreen', 'paleturquoise', 'palevioletred', 'papayawhip',
'peachpuff', 'peru', 'pink', 'plum', 'powderblue', 'purple', 'red',
'rosybrown', 'royalblue', 'saddlebrown', 'salmon', 'sandybrown',
'seagreen', 'seashell', 'sienna', 'silver', 'skyblue', 'slateblue',
'slategray', 'slategrey', 'snow', 'springgreen', 'steelblue', 'tan',
'teal', 'thistle', 'tomato', 'turquoise', 'violet', 'wheat', 'white',
'whitesmoke', 'yellow', 'yellowgreen'
);
if (preg_match('/^#?([[:xdigit:]]{3}){1,2}$/', $colour)) {
return true;
} else if (in_array(strtolower($colour), $colournames)) {
return true;
} else if (preg_match('/rgb\(\d{0,3}%?\, ?\d{0,3}%?, ?\d{0,3}%?\)/i', $colour)) {
return true;
} else if (preg_match('/rgba\(\d{0,3}%?\, ?\d{0,3}%?, ?\d{0,3}%?\, ?\d(\.\d)?\)/i', $colour)) {
return true;
} else if (preg_match('/hsl\(\d{0,3}\, ?\d{0,3}%, ?\d{0,3}%\)/i', $colour)) {
return true;
} else if (preg_match('/hsla\(\d{0,3}\, ?\d{0,3}%,\d{0,3}%\, ?\d(\.\d)?\)/i', $colour)) {
return true;
} else if (($colour == 'transparent') || ($colour == 'currentColor') || ($colour == 'inherit')) {
return true;
} else {
return false;
}
}
}
Reference in a new issue Copy permalink