mirror of
https://github.com/moodle/moodle.git
synced 2025-08-04 16:36:37 +02:00
134 lines
4.4 KiB
PHP
134 lines
4.4 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* Contains the default activity list from a section.
|
|
*
|
|
* @package core_course
|
|
* @copyright 2020 Ferran Recio <ferran@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core_course\output;
|
|
|
|
use core_course\course_format;
|
|
use section_info;
|
|
use completion_info;
|
|
use renderable;
|
|
use templatable;
|
|
use cm_info;
|
|
use stdClass;
|
|
|
|
/**
|
|
* Base class to render a course module inside a course format.
|
|
*
|
|
* @package core_course
|
|
* @copyright 2020 Ferran Recio <ferran@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class cm_format implements renderable, templatable {
|
|
|
|
/** @var course_format the course format */
|
|
protected $format;
|
|
|
|
/** @var section_info the section object */
|
|
private $section;
|
|
|
|
/** @var cm_info the course module instance */
|
|
protected $mod;
|
|
|
|
/** @var array optional display options */
|
|
protected $displayoptions;
|
|
|
|
/** @var completion_info the course completion */
|
|
protected $completioninfo;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param course_format $format the course format
|
|
* @param section_info $section the section info
|
|
* @param completion_info $completioninfo the course completion info
|
|
* @param cm_info $mod the course module ionfo
|
|
* @param array $displayoptions optional extra display options
|
|
*/
|
|
public function __construct(course_format $format, section_info $section, completion_info $completioninfo,
|
|
cm_info $mod, array $displayoptions = []) {
|
|
|
|
$this->format = $format;
|
|
$this->section = $section;
|
|
$this->completioninfo = $completioninfo;
|
|
$this->mod = $mod;
|
|
$this->displayoptions = $displayoptions;
|
|
}
|
|
|
|
/**
|
|
* Export this data so it can be used as the context for a mustache template.
|
|
*
|
|
* @param renderer_base $output typically, the renderer that's calling this function
|
|
* @return stdClass data context for a mustache template
|
|
*/
|
|
public function export_for_template(\renderer_base $output): stdClass {
|
|
$format = $this->format;
|
|
$course = $format->get_course();
|
|
$mod = $this->mod;
|
|
$displayoptions = $this->displayoptions;
|
|
|
|
$data = (object)[
|
|
'cmname' => $output->course_section_cm_name($mod, $displayoptions),
|
|
'afterlink' => $mod->afterlink,
|
|
'altcontent' => $output->course_section_cm_text($mod, $displayoptions),
|
|
'availability' => $output->course_section_cm_availability($mod, $displayoptions),
|
|
'url' => $mod->url,
|
|
'completion' => $output->course_section_cm_completion(
|
|
$course, $this->completioninfo, $mod, $displayoptions
|
|
),
|
|
];
|
|
|
|
if (!empty($mod->indent)) {
|
|
$data->indent = $mod->indent;
|
|
if ($mod->indent > 15) {
|
|
$data->hugeindent = true;
|
|
}
|
|
}
|
|
|
|
if (!empty($data->cmname)) {
|
|
$data->hasname = true;
|
|
}
|
|
if (!empty($data->url)) {
|
|
$data->hasurl = true;
|
|
}
|
|
|
|
$returnsection = $format->get_section_number();
|
|
$data->extras = [];
|
|
if ($format->show_editor()) {
|
|
// Edit actions.
|
|
$editactions = course_get_cm_edit_actions($mod, $mod->indent, $returnsection);
|
|
$data->extras[] = $output->course_section_cm_edit_actions($editactions, $mod, $displayoptions);
|
|
if (!empty($mod->afterediticons)) {
|
|
$data->extras[] = $mod->afterediticons;
|
|
}
|
|
// Move and select options.
|
|
$data->moveicon = course_get_cm_move($mod, $returnsection);
|
|
}
|
|
|
|
if (!empty($data->completion) || !empty($data->extras)) {
|
|
$data->hasextras = true;
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
}
|