diff --git a/element/userpicture/classes/element.php b/element/userpicture/classes/element.php new file mode 100644 index 0000000..6be7473 --- /dev/null +++ b/element/userpicture/classes/element.php @@ -0,0 +1,199 @@ +. + +namespace customcertelement_userpicture; + +defined('MOODLE_INTERNAL') || die(); + +/** + * The customcert element userpicture's core interaction API. + * + * @package customcertelement_userpicture + * @copyright 2017 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class element extends \mod_customcert\element { + + /** + * 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) { + $mform->addElement('text', 'width', get_string('width', 'customcertelement_userpicture'), array('size' => 10)); + $mform->setType('width', PARAM_INT); + $mform->setDefault('width', 0); + $mform->addHelpButton('width', 'width', 'customcertelement_userpicture'); + + $mform->addElement('text', 'height', get_string('height', 'customcertelement_userpicture'), array('size' => 10)); + $mform->setType('height', PARAM_INT); + $mform->setDefault('height', 0); + $mform->addHelpButton('height', 'height', 'customcertelement_userpicture'); + + if (get_config('customcert', 'showposxy')) { + \mod_customcert\element_helper::render_form_element_position($mform); + } + } + + /** + * 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_userpicture'); + } + + // Check if height is not set, or not numeric or less than 0. + if ((!isset($data['height'])) || (!is_numeric($data['height'])) || ($data['height'] < 0)) { + $errors['height'] = get_string('invalidheight', 'customcertelement_userpicture'); + } + + // Validate the position. + if (get_config('customcert', 'showposxy')) { + $errors += \mod_customcert\element_helper::validate_form_element_position($data); + } + + return $errors; + } + + /** + * 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) { + // Array of data we will be storing in the database. + $arrtostore = array( + 'width' => (int) $data->width, + 'height' => (int) $data->height + ); + + return json_encode($arrtostore); + } + + /** + * Handles rendering the element on the pdf. + * + * @param \pdf $pdf the pdf object + * @param bool $preview true if it is a preview, false otherwise + * @param \stdClass $user the user we are rendering this for + */ + public function render($pdf, $preview, $user) { + global $CFG; + + // If there is no element data, we have nothing to display. + if (empty($this->element->data)) { + return; + } + + $imageinfo = json_decode($this->element->data); + + $context = \context_user::instance($user->id); + + // Prepare file record object. + $fileinfo = array( + 'component' => 'user', + 'filearea' => 'icon', + 'itemid' => 0, + 'contextid' => $context->id, + 'filepath' => '/', + 'filename' => 'f1.png'); + + // Get file. + $fs = get_file_storage(); + $file = $fs->get_file($fileinfo['contextid'], $fileinfo['component'], $fileinfo['filearea'], + $fileinfo['itemid'], $fileinfo['filepath'], $fileinfo['filename']); + + // Show image. + if ($file) { + $contenthash = $file->get_contenthash(); + $l1 = $contenthash[0] . $contenthash[1]; + $l2 = $contenthash[2] . $contenthash[3]; + $location = $CFG->dataroot . '/filedir/' . $l1 . '/' . $l2 . '/' . $contenthash; + $pdf->Image($location, $this->element->posx, $this->element->posy, $imageinfo->width, $imageinfo->height); + } else if ($preview) { // Can't find an image, but we are in preview mode then display default pic. + $location = $CFG->dirroot . '/pix/u/f1.png'; + $pdf->Image($location, $this->element->posx, $this->element->posy, $imageinfo->width, $imageinfo->height); + } + } + + /** + * 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() { + global $PAGE, $USER; + + // If there is no element data, we have nothing to display. + if (empty($this->element->data)) { + return ''; + } + + $imageinfo = json_decode($this->element->data); + + // Get the image. + $userpicture = new \user_picture($USER); + $userpicture->size = 1; + $url = $userpicture->get_url($PAGE)->out(false); + + // The size of the images to use in the CSS style. + $style = ''; + if ($imageinfo->width === 0 && $imageinfo->height === 0) { + // Do nothing. + } else if ($imageinfo->width === 0) { // Then the height must be set. + $style .= 'width: ' . $imageinfo->height . 'mm; '; + $style .= 'height: ' . $imageinfo->height . 'mm'; + } else if ($imageinfo->height === 0) { // Then the width must be set. + $style .= 'width: ' . $imageinfo->width . 'mm; '; + $style .= 'height: ' . $imageinfo->width . 'mm'; + } else { // Must both be set. + $style .= 'width: ' . $imageinfo->width . 'mm; '; + $style .= 'height: ' . $imageinfo->height . 'mm'; + } + + return \html_writer::tag('img', '', array('src' => $url, 'style' => $style)); + } + + /** + * 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) { + // Set the image, width and height for this element. + if (!empty($this->element->data)) { + $imageinfo = json_decode($this->element->data); + $this->element->width = $imageinfo->width; + $this->element->height = $imageinfo->height; + } + + parent::definition_after_data($mform); + } +} diff --git a/element/userpicture/lang/en/customcertelement_userpicture.php b/element/userpicture/lang/en/customcertelement_userpicture.php new file mode 100644 index 0000000..b18c323 --- /dev/null +++ b/element/userpicture/lang/en/customcertelement_userpicture.php @@ -0,0 +1,31 @@ +. + +/** + * Strings for component 'customcertelement_userpicture', language 'en'. + * + * @package customcertelement_userpicture + * @copyright 2017 Mark Nelson + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +$string['height'] = 'Height'; +$string['height_help'] = 'Height of the image in mm. If equal to zero, it is automatically calculated.'; +$string['invalidheight'] = 'The height has to be a valid number greater than or equal to 0.'; +$string['invalidwidth'] = 'The width has to be a valid number greater than or equal to 0.'; +$string['pluginname'] = 'User picture'; +$string['width'] = 'Width'; +$string['width_help'] = 'Width of the image in mm. If equal to zero, it is automatically calculated.'; diff --git a/element/userpicture/version.php b/element/userpicture/version.php new file mode 100644 index 0000000..41dc151 --- /dev/null +++ b/element/userpicture/version.php @@ -0,0 +1,29 @@ +. + +/** + * This file contains the version information for the userpicture plugin. + * + * @package customcertelement_userpicture + * @copyright 2017 Mark Nelson + * @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 = 2016052300; // The current module version (Date: YYYYMMDDXX). +$plugin->requires = 2016052300; // Requires this Moodle version (3.1). +$plugin->component = 'customcertelement_userpicture';