. namespace customcertelement_image; defined('MOODLE_INTERNAL') || die(); /** * The customcert element image's core interaction API. * * @package customcertelement_image * @copyright 2013 Mark Nelson * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class element extends \mod_customcert\element { protected $filemanageroptions = array(); /** * Constructor. * * @param \stdClass $element the element data */ public function __construct($element) { global $COURSE; $this->filemanageroptions = array( 'maxbytes' => $COURSE->maxbytes, 'subdirs' => 1, 'accepted_types' => 'image' ); parent::__construct($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('select', 'image', get_string('image', 'customcertelement_image'), self::get_images()); $mform->addElement('text', 'width', get_string('width', 'customcertelement_image'), array('size' => 10)); $mform->setType('width', PARAM_INT); $mform->setDefault('width', 0); $mform->addHelpButton('width', 'width', 'customcertelement_image'); $mform->addElement('text', 'height', get_string('height', 'customcertelement_image'), array('size' => 10)); $mform->setType('height', PARAM_INT); $mform->setDefault('height', 0); $mform->addHelpButton('height', 'height', 'customcertelement_image'); $mform->addElement('filemanager', 'customcertimage', get_string('uploadimage', 'customcert'), '', $this->filemanageroptions); } /** * 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_image'); } // 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_image'); } // Validate the position. $errors += \mod_customcert\element_helper::validate_form_element_position($data); return $errors; } /** * Handles saving the form elements created by this element. * Can be overridden if more functionality is needed. * * @param \stdClass $data the form data */ public function save_form_elements($data) { global $COURSE; // Handle file uploads. \mod_customcert\certificate::upload_imagefiles($data->customcertimage, \context_course::instance($COURSE->id)->id); parent::save_form_elements($data); } /** * 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( 'pathnamehash' => $data->image, '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); // Get the image. $fs = get_file_storage(); if ($file = $fs->get_file_by_hash($imageinfo->pathnamehash)) { $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); } } /** * 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() { // 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. $fs = get_file_storage(); if ($file = $fs->get_file_by_hash($imageinfo->pathnamehash)) { $url = \moodle_url::make_pluginfile_url($file->get_contextid(), 'mod_customcert', 'image', $file->get_itemid(), $file->get_filepath(), $file->get_filename()); $fileimageinfo = $file->get_imageinfo(); $whratio = $fileimageinfo['width'] / $fileimageinfo['height']; // The size of the images to use in the CSS style. $style = ''; if ($imageinfo->width === 0 && $imageinfo->height === 0) { $style .= 'width: ' . $fileimageinfo['width'] . 'px; '; $style .= 'height: ' . $fileimageinfo['height'] . 'px'; } else if ($imageinfo->width === 0) { // Then the height must be set. // We must get the width based on the height to keep the ratio. $style .= 'width: ' . ($imageinfo->height * $whratio) . 'mm; '; $style .= 'height: ' . $imageinfo->height . 'mm'; } else if ($imageinfo->height === 0) { // Then the width must be set. $style .= 'width: ' . $imageinfo->width . 'mm; '; // We must get the height based on the width to keep the ratio. $style .= 'height: ' . ($imageinfo->width / $whratio) . '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) { global $COURSE; // Set the image, width and height for this element. if (!empty($this->element->data)) { $imageinfo = json_decode($this->element->data); $this->element->image = $imageinfo->pathnamehash; $this->element->width = $imageinfo->width; $this->element->height = $imageinfo->height; } // Editing existing instance - copy existing files into draft area. $draftitemid = file_get_submitted_draft_itemid('customcertimage'); file_prepare_draft_area($draftitemid, \context_course::instance($COURSE->id)->id, 'mod_customcert', 'image', 0, $this->filemanageroptions); $element = $mform->getElement('customcertimage'); $element->setValue($draftitemid); parent::definition_after_data($mform); } /** * Return the list of possible images to use. * * @return array the list of images that can be used */ public static function get_images() { global $COURSE; // Create file storage object. $fs = get_file_storage(); // The array used to store the images. $arrfiles = array(); // Loop through the files uploaded in the system context. if ($files = $fs->get_area_files(\context_system::instance()->id, 'mod_customcert', 'image', false, 'filename', false)) { foreach ($files as $hash => $file) { $arrfiles[$hash] = $file->get_filename(); } } // Loop through the files uploaded in the course context. if ($files = $fs->get_area_files(\context_course::instance($COURSE->id)->id, 'mod_customcert', 'image', false, 'filename', false)) { foreach ($files as $hash => $file) { $arrfiles[$hash] = $file->get_filename(); } } \core_collator::asort($arrfiles); $arrfiles = array_merge(array('0' => get_string('noimage', 'customcert')), $arrfiles); return $arrfiles; } }