8bc930b1e616fe3302be205cb73b0ae9beca7bec
[moodle.git] / course / classes / local / service / content_item_service.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Contains the content_item_service class.
19  *
20  * @package    core
21  * @subpackage course
22  * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
25 namespace core_course\local\service;
27 defined('MOODLE_INTERNAL') || die();
29 use core_course\local\exporters\course_content_items_exporter;
30 use core_course\local\repository\content_item_readonly_repository_interface;
32 /**
33  * The content_item_service class, providing the api for interacting with content items.
34  *
35  * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class content_item_service {
40     /** @var content_item_readonly_repository_interface $repository a repository for content items. */
41     private $repository;
43     /**
44      * The content_item_service constructor.
45      *
46      * @param content_item_readonly_repository_interface $repository a content item repository.
47      */
48     public function __construct(content_item_readonly_repository_interface $repository) {
49         $this->repository = $repository;
50     }
52     /**
53      * Return a representation of the available content items, for a user in a course.
54      *
55      * @param \stdClass $user the user to check access for.
56      * @param \stdClass $course the course to scope the content items to.
57      * @param array $linkparams the desired section to return to.
58      * @return \stdClass[] the content items, scoped to a course.
59      */
60     public function get_content_items_for_user_in_course(\stdClass $user, \stdClass $course, array $linkparams = []): array {
61         global $PAGE;
63         if (!has_capability('moodle/course:manageactivities', \context_course::instance($course->id), $user)) {
64             return [];
65         }
67         // Get all the visible content items.
68         $allcontentitems = $this->repository->find_all_for_course($course, $user);
70         // Content items can only originate from modules or submodules.
71         $pluginmanager = \core_plugin_manager::instance();
72         $components = \core_component::get_component_list();
73         $parents = [];
74         foreach ($allcontentitems as $contentitem) {
75             if (!in_array($contentitem->get_component_name(), array_keys($components['mod']))) {
76                 // It could be a subplugin.
77                 $info = $pluginmanager->get_plugin_info($contentitem->get_component_name());
78                 if (!is_null($info)) {
79                     $parent = $info->get_parent_plugin();
80                     if ($parent != false) {
81                         if (in_array($parent, array_keys($components['mod']))) {
82                             $parents[$contentitem->get_component_name()] = $parent;
83                             continue;
84                         }
85                     }
86                 }
87                 throw new \moodle_exception('Only modules and submodules can generate content items. \''
88                     . $contentitem->get_component_name() . '\' is neither.');
89             }
90             $parents[$contentitem->get_component_name()] = $contentitem->get_component_name();
91         }
93         // Now, check access to these items for the user.
94         $availablecontentitems = array_filter($allcontentitems, function($contentitem) use ($course, $user, $parents) {
95             // Check the parent module access for the user.
96             return course_allowed_module($course, explode('_', $parents[$contentitem->get_component_name()])[1], $user);
97         });
99         // Add the link params to the link, if any have been provided.
100         if (!empty($linkparams)) {
101             $availablecontentitems = array_map(function ($item) use ($linkparams) {
102                 $item->get_link()->params($linkparams);
103                 return $item;
104             }, $availablecontentitems);
105         }
107         // Export the objects to get the formatted objects for transfer/display.
108         $ciexporter = new course_content_items_exporter(
109             $availablecontentitems,
110             ['context' => \context_course::instance($course->id)]
111         );
112         $exported = $ciexporter->export($PAGE->get_renderer('course'));
114         // Sort by title for return.
115         usort($exported->content_items, function($a, $b) {
116             return $a->title > $b->title;
117         });
119         return $exported->content_items;
120     }