Rev 4 | Ir a la última revisión | Autoría | Comparar con el anterior | Ultima modificación | Ver Log |
<?php// This file is part of 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/>./*** Point of View block definition** @package block_point_view* @copyright 2020 Quentin Fombaron, 2021 Astor Bizard* @author Quentin Fombaron <q.fombaron@outlook.fr>* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later*//*** block_point_view Class** @package block_point_view* @copyright 2020 Quentin Fombaron, 2021 Astor Bizard* @author Quentin Fombaron <q.fombaron@outlook.fr>* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later*/class block_point_view extends block_base {/*** Block initialization*/public function init() {$this->title = get_string('pluginname', 'block_point_view');}/*** We have global config/settings data.* @return boolean*/public function has_config() {return true;}/*** Enable to add the block only in a course.** @return array*/public function applicable_formats() {return ['course-view' => true,];}/*** Build block content.* @return Object*/public function get_content() {global $CFG, $COURSE;if ($this->content !== null) {// Content has already been built, do not rebuild.return $this->content;}$this->content = new stdClass();$this->content->footer = '';if (get_config('block_point_view', 'enable_point_views_admin')) {// Block text content.if (isset($this->config->text)) {$this->config->text = file_rewrite_pluginfile_urls($this->config->text,'pluginfile.php',$this->context->id,'block_point_view','content',null);$format = FORMAT_HTML;if (isset($this->config->format)) {$format = $this->config->format;}$filteropt = new stdClass;if ($this->content_is_trusted()) {$filteropt->noclean = true;}$this->content->text = format_text($this->config->text, $format, $filteropt);unset($filteropt);} else {$this->content->text = '<span>'.get_string('defaulttextcontent', 'block_point_view').'</span>';}// Link to overview.if (has_capability('block/point_view:access_overview', $this->context)) {$parameters = ['instanceid' => $this->instance->id,'contextid' => $this->context->id,'courseid' => $COURSE->id];$url = new moodle_url('/blocks/point_view/overview.php', $parameters);$title = get_string('reactionsdetails', 'block_point_view');$pix = $CFG->wwwroot . '/blocks/point_view/pix/overview.png';$this->content->text .= html_writer::link($url,html_writer::empty_tag('img', ['src' => $pix,'alt' => $title,'class' => 'overview-link d-block mx-auto text-center',]),[ 'title' => $title ]);}} else if (has_capability('block/point_view:addinstance', $this->context)) {$this->content->text = get_string('blockdisabled', 'block_point_view');}return $this->content;}/*** Is content trusted** @return bool*/public function content_is_trusted() {global $SCRIPT;if (!$context = context::instance_by_id($this->instance->parentcontextid, IGNORE_MISSING)) {return false;}if ($context->contextlevel == CONTEXT_USER) {if ($SCRIPT === '/my/index.php') {return true;} else {return false;}}return true;}/*** {@inheritDoc}* @see block_base::get_required_javascript()*/public function get_required_javascript() {parent::get_required_javascript();global $USER, $COURSE;if (get_config('block_point_view', 'enable_point_views_admin')&& (!empty($this->config->enable_point_views) || !empty($this->config->enable_difficultytracks))&& !$this->page->user_is_editing()) {require_once(__DIR__ . '/locallib.php');// Build data for javascript.$blockdata = new stdClass();$blockdata->trackcolors = block_point_view_get_track_colors();$blockdata->moduleswithreactions = block_point_view_get_modules_with_reactions($this, $USER->id, $COURSE->id);$blockdata->difficultylevels = block_point_view_get_difficulty_levels($this, $COURSE->id);$blockdata->pix = block_point_view_get_current_pix($this);global $OUTPUT;$templatecontext = new stdClass();$templatecontext->reactions = [];foreach ([ 'easy', 'better', 'hard' ] as $reactionname) {$reaction = new stdClass();$reaction->name = $reactionname;$reaction->pix = $blockdata->pix[$reactionname];$reaction->text = block_point_view_get_reaction_text($this, $reactionname);$templatecontext->reactions[] = $reaction;}$blockdata->reactionstemplate = $OUTPUT->render_from_template('block_point_view/reactions', $templatecontext);// Create and place a node containing data for the javascript.$datanode = html_writer::span('', 'block_point_view', ['data-blockdata' => json_encode($blockdata),'style' => 'display:none;',]);if (($this->config->highlight_activity_rows ?? true)) {// Add shade on hover of a course module.$cssnode = '<style type="text/css">.activity:hover{background:linear-gradient(to right,rgba(0,0,0,0.04),rgba(0,0,0,0.04),transparent);border-radius:5px;}</style>';} else {$cssnode = '';}$this->page->requires->js_init_code('document.getElementsByClassName("course-content")[0].insertAdjacentHTML("beforeend", "' . addslashes_js($datanode . $cssnode) . '");');$strings = [ 'totalreactions', 'greentrack', 'bluetrack', 'redtrack', 'blacktrack' ];$this->page->requires->strings_for_js($strings, 'block_point_view');$this->page->requires->js_call_amd('block_point_view/script_point_view', 'init', [ $COURSE->id ]);}}/*** Serialize and store config data** Save data from file manager when user is saving configuration.* Delete file storage if user disable custom emojis.** @param mixed $data* @param mixed $nolongerused*/public function instance_config_save($data, $nolongerused = false) {$config = clone($data);$config->text = file_save_draft_area_files($data->text['itemid'],$this->context->id,'block_point_view','content',0,[ 'subdirs' => true ],$data->text['text']);$config->format = $data->text['format'];if ($config->pixselect == 'custom') {$config->point_views_pix = file_save_draft_area_files($data->point_views_pix,$this->context->id,'block_point_view','point_views_pix',0);}parent::instance_config_save($config, $nolongerused);}/*** {@inheritDoc}* @see block_base::instance_config_commit()* @param mixed $nolongerused*/public function instance_config_commit($nolongerused = false) {// Do not touch any files if this is a commit from somewhere else.parent::instance_config_save($this->config);}/*** Delete file storage.** @return bool*/public function instance_delete() {$fs = get_file_storage();$fs->delete_area_files($this->context->id, 'block_point_view');return true;}/*** Copy any block-specific data when copying to a new block instance.** @param int $fromid the id number of the block instance to copy from* @return boolean*/public function instance_copy($fromid) {$fromcontext = context_block::instance($fromid);$fs = get_file_storage();if (!$fs->is_area_empty($fromcontext->id, 'block_point_view', 'content', 0, false)) {$draftitemid = 0;file_prepare_draft_area($draftitemid,$fromcontext->id,'block_point_view','content',0,[ 'subdirs' => true ]);file_save_draft_area_files($draftitemid,$this->context->id,'block_point_view','content',0,[ 'subdirs' => true ]);}if (!$fs->is_area_empty($fromcontext->id, 'block_point_view', 'point_views_pix', 0, false)) {$draftitemid = 0;file_prepare_draft_area($draftitemid,$fromcontext->id,'block_point_view','point_views_pix',0,[ 'subdirs' => true ]);file_save_draft_area_files($draftitemid,$this->context->id,'block_point_view','point_views_pix',0,[ 'subdirs' => true ]);}return true;}}