Skip to content

MBS-11593: Move backlink to header actions #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PhMemmel wants to merge 1 commit into
base: master
Choose a base branch
from
Open

MBS-11593: Move backlink to header actions #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions classes/helper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,6 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class helper {
/**
* Get the current default activity header description without rendering the full header.
*
* Calling activity_header::export_for_template() here would add completion actions as a side effect.
*
* @return string
*/
public static function get_activity_header_description(): string {
global $PAGE;

$layoutoptions = $PAGE->layout_options['activityheader'] ?? [];
if (
empty($layoutoptions['nodescription'])
&& !empty($PAGE->activityrecord->intro)
&& trim($PAGE->activityrecord->intro)
) {
return format_module_intro($PAGE->activityname, $PAGE->activityrecord, $PAGE->cm->id);
}

return '';
}

/**
* Render the activity header for learningmap modals.
*
Expand Down
4 changes: 1 addition & 3 deletions classes/local/hook_callbacks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
use core\hook\output\before_http_headers;
use Exception;
use mod_learningmap\cachemanager;
use mod_learningmap\helper;

/**
* Hook callbacks for mod_learningmap.
Expand Down Expand Up @@ -100,8 +99,7 @@ public static function inject_backlinks_into_activity_header(before_http_headers
}

if ($backlinktext) {
$description = helper::get_activity_header_description();
$PAGE->activityheader->set_description($description . $backlinktext);
$PAGE->add_header_action($backlinktext);
}
} catch (Exception $e) {
debugging($e->getMessage());
Expand Down
3 changes: 1 addition & 2 deletions lib.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,8 +440,7 @@ function learningmap_before_http_headers() {
}

if ($backlinktext) {
$description = helper::get_activity_header_description();
$PAGE->activityheader->set_description($description . $backlinktext);
$PAGE->add_header_action($backlinktext);
}
} catch (Exception $e) {
debugging($e->getMessage());
Expand Down
4 changes: 0 additions & 4 deletions styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,6 @@
padding-right: 0.5rem;
}

.learningmap-backlink {
padding-top: 1rem;
}

.learningmap-container {
width: 100%;
}
Expand Down
2 changes: 1 addition & 1 deletion templates/backtomap.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
{{!
@template mod_learningmap/backtomap

Template for displaying the "back to learning map" button in activity descriptions.
Template for displaying the "back to learning map" button in the page header actions of activities.

Classes required for JS:
* none
Expand Down
30 changes: 14 additions & 16 deletions tests/mod_learningmap_backlink_cache_test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,47 +182,45 @@ public function test_backlink_generation(): void {
// Test an activity that is part of the first learning map (with backlink enabled).
$PAGE->set_cm($modinfo->get_cm($this->activities[0][0]->cmid));
$PAGE->set_activity_record($this->activities[0][0]);
// Simulate an activity setting its own header description (e.g. mod_assign with intro attachments).
$PAGE->activityheader->set_description('Custom activity description');

$descriptionbefore = $PAGE->activityheader->export_for_template($OUTPUT)['description'];
$this->assertEmpty($PAGE->get_header_actions());
learningmap_before_http_headers();

$descriptionafter = $PAGE->activityheader->export_for_template($OUTPUT)['description'];
$this->assertNotEquals($descriptionbefore, $descriptionafter);
$this->assertTrue(str_contains($descriptionafter, $this->learningmaps[0]->cmid));
$headeractions = $PAGE->get_header_actions();
$this->assertCount(1, $headeractions);
$this->assertTrue(str_contains($headeractions[0], $this->learningmaps[0]->cmid));
// The description set by the activity must not be touched.
$this->assertEquals(
'Custom activity description',
$PAGE->activityheader->export_for_template($OUTPUT)['description']
);

// Test an activity that is part of the second learning map (with backlink disabled).
$PAGE = new \moodle_page();
$PAGE->set_cm($modinfo->get_cm($this->activities[1][1]->cmid));
$PAGE->set_activity_record($this->activities[1][1]);

$descriptionbefore = $PAGE->activityheader->export_for_template($OUTPUT)['description'];
learningmap_before_http_headers();

$descriptionafter = $PAGE->activityheader->export_for_template($OUTPUT)['description'];
$this->assertEquals($descriptionbefore, $descriptionafter);
$this->assertEmpty($PAGE->get_header_actions());

// Test an activity that is part of the second course (without any learning maps).
$PAGE = new \moodle_page();
$modinfo = get_fast_modinfo($this->courses[1]);
$PAGE->set_cm($modinfo->get_cm($this->activities[3][0]->cmid));
$PAGE->set_activity_record($this->activities[3][0]);

$descriptionbefore = $PAGE->activityheader->export_for_template($OUTPUT)['description'];
learningmap_before_http_headers();

$descriptionafter = $PAGE->activityheader->export_for_template($OUTPUT)['description'];
$this->assertEquals($descriptionbefore, $descriptionafter);
$this->assertEmpty($PAGE->get_header_actions());

// Learningmap is invisible for the user. Backlink should not be generated.
$PAGE = new \moodle_page();
$modinfo = get_fast_modinfo($this->courses[0]);
$PAGE->set_cm($modinfo->get_cm($this->activities[2][1]->cmid));
$PAGE->set_activity_record($this->activities[2][1]);

$descriptionbefore = $PAGE->activityheader->export_for_template($OUTPUT)['description'];
learningmap_before_http_headers();

$descriptionafter = $PAGE->activityheader->export_for_template($OUTPUT)['description'];
$this->assertEquals($descriptionbefore, $descriptionafter);
$this->assertEmpty($PAGE->get_header_actions());
}
}
Loading