4c023ca4fe3e7af8e1067770d6db765304c0c66c
[moodle.git] / course / classes / local / repository / content_item_readonly_repository_interface.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 interface content_item_readonly_repository_interface, defining operations for readonly content item repositories.
19  *
20  * This interface is not considered a published interface and serves to govern internal, local repository objects only.
21  * All calling code should use instances of the service classes, and should not interact with repositories directly.
22  *
23  * @package    core
24  * @subpackage course
25  * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
28 namespace core_course\local\repository;
30 defined('MOODLE_INTERNAL') || die();
32 interface content_item_readonly_repository_interface {
33     /**
34      * Find all content items for a given course and user.
35      *
36      * @param \stdClass $course the course object.
37      * @param \stdClass $user the user object.
38      * @return array the array of content items.
39      */
40     public function find_all_for_course(\stdClass $course, \stdClass $user): array;
41 }