first commit

mod/lesson/classes/output/edit_action_area.php

@@ -0,0 +1,87 @@
+<?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/>.
+
+/**
+ * Output the actionbar for this activity.
+ *
+ * @package   mod_lesson
+ * @copyright 2021 Adrian Greeve <adrian@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_lesson\output;
+
+use moodle_url;
+use templatable;
+use renderable;
+
+/**
+ * Output the actionbar for this activity.
+ *
+ * @package   mod_lesson
+ * @copyright 2021 Adrian Greeve <adrian@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class edit_action_area implements templatable, renderable {
+
+    /** @var int The course module ID. */
+    protected $cmid;
+    /** @var moodle_url The current url for the page. */
+    protected $currenturl;
+
+    /**
+     * Constructor for this object.
+     *
+     * @param int        $cmid       The course module ID.
+     * @param moodle_url $currenturl The current url for the page.
+     */
+    public function __construct(int $cmid, moodle_url $currenturl) {
+        $this->cmid = $cmid;
+        $this->currenturl = $currenturl;
+    }
+
+    /**
+     * Data for use with a template.
+     *
+     * @param \renderer_base $output render base output.
+     * @return array Said data.
+     */
+    public function export_for_template(\renderer_base $output): array {
+        global $PAGE;
+
+        $viewurl = new moodle_url('/mod/lesson/edit.php', ['id' => $this->cmid, 'mode' => 'collapsed']);
+        $fullviewurl = new moodle_url('/mod/lesson/edit.php', ['id' => $this->cmid, 'mode' => 'full']);
+        $menu = [
+            $viewurl->out(false) => get_string('collapsed', 'mod_lesson'),
+            $fullviewurl->out(false) => get_string('full', 'mod_lesson')
+        ];
+
+        $selectmenu = new \url_select($menu, $this->currenturl->out(false), null, 'mod_lesson_navigation_select');
+        $selectmenu->label = get_string('displaymode', 'mod_lesson');
+        $selectmenu->labelattributes = ['class' => 'sr-only'];
+
+        $headinglevel = $PAGE->activityheader->get_heading_level();
+        return [
+            'back' => [
+                'text' => get_string('back', 'core'),
+                'link' => (new moodle_url('/mod/lesson/view.php', ['id' => $this->cmid]))->out(false)
+            ],
+            'viewselect' => $selectmenu->export_for_template($output),
+            'heading' => get_string('editinglesson', 'mod_lesson'),
+            'headinglevel' => $headinglevel,
+        ];
+    }
+}

mod/lesson/classes/output/edit_action_buttons.php

@@ -0,0 +1,113 @@
+<?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/>.
+
+/**
+ * Output the action buttons for this activity.
+ *
+ * @package   mod_lesson
+ * @copyright 2021 Adrian Greeve <adrian@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_lesson\output;
+
+use core\output\notification;
+use moodle_url;
+use templatable;
+use renderable;
+use single_button;
+
+/**
+ * Output the action buttons for this activity.
+ *
+ * @package   mod_lesson
+ * @copyright 2021 Adrian Greeve <adrian@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class edit_action_buttons implements templatable, renderable {
+
+    /** @var \lesson The lesson object. */
+    protected $lesson;
+    /** @var int The currently viewed lesson page id. */
+    protected $currentpage;
+
+    /**
+     * Constructor for this object.
+     *
+     * @param \lesson $lesson The lesson object.
+     * @param int|null $currentpage The current lesson page that is being viewed
+     */
+    public function __construct(\lesson $lesson, ?int $currentpage = null) {
+        $this->lesson = $lesson;
+        $this->currentpage = $currentpage;
+    }
+
+    /**
+     * Sets the current page being viewed.
+     *
+     * @param int|null $page
+     */
+    public function set_currentpage(?int $page) {
+        $this->currentpage = $page;
+    }
+
+    /**
+     * Data for use with a template.
+     *
+     * @param \renderer_base $output Renderer information.
+     * @return array Said data.
+     */
+    public function export_for_template(\renderer_base $output) {
+        global $PAGE;
+
+        $data = [];
+
+        // A shortcut to edit the lesson's question page.
+        if (has_capability('mod/lesson:edit', $this->lesson->context) &&
+                !empty($this->currentpage) && $this->currentpage != LESSON_EOL) {
+            $url = new moodle_url('/mod/lesson/editpage.php', [
+                'id'       => $this->lesson->get_cm()->id,
+                'pageid'   => $this->currentpage,
+                'edit'     => 1,
+                'returnto' => $PAGE->url->out_as_local_url(false)
+            ]);
+            $editcontent = new single_button($url, get_string('editpagecontent', 'lesson'));
+            $data['editcontents']['button'] = $editcontent->export_for_template($output);
+        }
+
+        if ($this->lesson->can_manage()) {
+            $url = new moodle_url('/mod/lesson/edit.php', ['id' => $this->lesson->get_cm()->id]);
+            $editbutton = new single_button($url, get_string('editlesson', 'mod_lesson'), 'get', single_button::BUTTON_PRIMARY);
+            $url = new moodle_url('/mod/lesson/essay.php', ['id' => $this->lesson->get_cm()->id]);
+            $essaybutton = new single_button($url, get_string('manualgrading', 'mod_lesson'), 'get');
+            $data += [
+                'edit' => [
+                    'button' => $editbutton->export_for_template($output),
+                ],
+                'gradeessays' => [
+                    'button' => $essaybutton->export_for_template($output),
+                ]
+            ];
+        }
+
+        // Standard notification to indicate the lesson is being previewed.
+        if ($data) {
+            $message = new notification(get_string('lessonbeingpreviewed', 'mod_lesson'), notification::NOTIFY_INFO);
+            $data['notification'] = $message->export_for_template($output);
+        }
+        return $data;
+    }
+}

mod/lesson/classes/output/override_action_menu.php

@@ -0,0 +1,111 @@
+<?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/>.
+
+/**
+ * Output the override action menu for this activity.
+ *
+ * @package   mod_lesson
+ * @copyright 2021 Adrian Greeve <adrian@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_lesson\output;
+
+use moodle_url;
+use templatable;
+use renderable;
+
+/**
+ * Output the override action menu for this activity.
+ *
+ * @package   mod_lesson
+ * @copyright 2021 Adrian Greeve <adrian@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class override_action_menu implements templatable, renderable {
+
+    /** @var int The course module ID. */
+    protected $cmid;
+    /** @var moodle_url The current url for the page. */
+    protected $currenturl;
+    /** @var bool Whether can add user or group override (depending on the override type). */
+    protected $canoverride;
+
+    /**
+     * Constructor for this object.
+     *
+     * @param int        $cmid       The course module ID.
+     * @param moodle_url $currenturl The current url for the page.
+     * @param bool $canoverride Whether can add user or group override (depending on the override type).
+     */
+    public function __construct(int $cmid, moodle_url $currenturl, bool $canoverride = false) {
+        $this->cmid = $cmid;
+        $this->currenturl = $currenturl;
+        $this->canoverride = $canoverride;
+    }
+
+    /**
+     * Creates a select menu for the override options.
+     *
+     * @return \url_select The override select.
+     */
+    protected function create_override_select_menu(): \url_select {
+        $userlink = new moodle_url('/mod/lesson/overrides.php', ['cmid' => $this->cmid, 'mode' => 'user']);
+        $grouplink = new moodle_url('/mod/lesson/overrides.php', ['cmid' => $this->cmid, 'mode' => 'group']);
+        $menu = [
+            $userlink->out(false) => get_string('useroverrides', 'mod_lesson'),
+            $grouplink->out(false) => get_string('groupoverrides', 'mod_lesson'),
+        ];
+        $selectmenu = new \url_select($menu, $this->currenturl->out(false), null, 'mod_lesson_override_select');
+        $selectmenu->label = get_string('manageoverrides', 'mod_lesson');
+        $selectmenu->labelattributes = ['class' => 'sr-only'];
+        return $selectmenu;
+    }
+
+    /**
+     * Data for use with a template.
+     *
+     * @param \renderer_base $output renderer base output.
+     * @return array Said data.
+     */
+    public function export_for_template(\renderer_base $output): array {
+        global $PAGE;
+
+        $type = $this->currenturl->get_param('mode');
+        if ($type == 'user') {
+            $text = get_string('addnewuseroverride', 'mod_lesson');
+        } else {
+            $text = get_string('addnewgroupoverride', 'mod_lesson');
+        }
+        $action = ($type == 'user') ? 'adduser' : 'addgroup';
+        $urlselect = $this->create_override_select_menu();
+        $data = [
+            'urlselect' => $urlselect->export_for_template($output)
+        ];
+        if ($this->canoverride) {
+            $data['addoverride'] = [
+                'text' => $text,
+                'link' => (new moodle_url('/mod/lesson/overrideedit.php', [
+                    'cmid' => $this->currenturl->get_param('cmid'),
+                    'action' => $action
+                ]))->out(false)
+            ];
+        }
+        $data['heading'] = get_string($type == 'user' ? 'useroverrides' : 'groupoverrides', 'mod_lesson');
+        $data['headinglevel'] = $PAGE->activityheader->get_heading_level();
+        return $data;
+    }
+}

mod/lesson/classes/output/report_action_menu.php

@@ -0,0 +1,82 @@
+<?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/>.
+
+/**
+ * Output the report action menu for this activity.
+ *
+ * @package   mod_lesson
+ * @copyright 2021 Adrian Greeve <adrian@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_lesson\output;
+
+use moodle_url;
+use templatable;
+use renderable;
+
+/**
+ * Output the report action menu for this activity.
+ *
+ * @package   mod_lesson
+ * @copyright 2021 Adrian Greeve <adrian@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class report_action_menu implements templatable, renderable {
+
+    /** int The lesson id. */
+    protected $lessonid;
+    /** moodle_url The url for this page. */
+    protected $url;
+
+    /**
+     * Constructor for this object.
+     *
+     * @param int $lessonid The lessonid.
+     * @param moodle_url $url The url for this page.
+     */
+    public function __construct(int $lessonid, moodle_url $url) {
+        $this->lessonid = $lessonid;
+        $this->url = $url;
+    }
+
+    /**
+     * Export this url select menu for navigating between reports.
+     *
+     * @param \renderer_base  $output Renderer output.
+     * @return array The data for the template.
+     */
+    public function export_for_template(\renderer_base $output): array {
+        global $PAGE;
+
+        $overviewlink = new moodle_url('/mod/lesson/report.php', ['id' => $this->lessonid, 'action' => 'reportoverview']);
+        $fulllink = new moodle_url('/mod/lesson/report.php', ['id' => $this->lessonid, 'action' => 'reportdetail']);
+        $menu = [
+            $overviewlink->out(false) => get_string('overview', 'mod_lesson'),
+            $fulllink->out(false) => get_string('detailedstats', 'mod_lesson')
+        ];
+        $reportselect = new \url_select($menu, $this->url->out(false), null, 'lesson-report-select');
+        $reportselect->label = get_string('selectreport', 'mod_lesson');
+        $reportselect->labelattributes = ['class' => 'sr-only'];
+
+        $data = [
+            'reportselect' => $reportselect->export_for_template($output),
+            'heading' => $menu[$reportselect->selected] ?? '',
+            'headinglevel' => $PAGE->activityheader->get_heading_level(),
+        ];
+        return $data;
+    }
+}