MDL-63658 core_favourites: add business logic aware service layer
[moodle.git] / favourites / classes / local / user_favourites_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 user_favourites_service class, part of the service layer for the favourites subsystem.
19  *
20  * @package   core_favourites
21  * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace core_favourites\local;
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Class service, providing an single API for interacting with the favourites subsystem for a SINGLE USER.
30  *
31  * This class is responsible for exposing key operations (add, remove, find) and enforces any business logic necessary to validate
32  * authorization/data integrity for these operations.
33  *
34  * All object persistence is delegated to the ifavourites_repository.
35  *
36  * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
37  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class user_favourites_service {
41     /** @var user_favourites_repository $repo the user favourites repository object. */
42     protected $repo;
44     /** @var int $userid the id of the user to which this favourites service is scoped. */
45     protected $userid;
47     /**
48      * Helper, returning a flat list of component names.
49      *
50      * @return array the array of component names.
51      */
52     protected function get_component_list() {
53         return array_keys(array_reduce(\core_component::get_component_list(), function($carry, $item) {
54             return array_merge($carry, $item);
55         }, []));
56     }
58     /**
59      * The user_favourites_service constructor.
60      *
61      * @param \context_user $usercontext The context of the user to which this service operations are scoped.
62      * @param ifavourites_repository $repository a user favourites repository.
63      */
64     public function __construct(\context_user $usercontext, ifavourites_repository $repository) {
65         $this->repo = $repository;
66         $this->userid = $usercontext->instanceid;
67     }
69     /**
70      * Favourite an item defined by itemid/context, in the area defined by component/itemtype.
71      *
72      * @param string $component the frankenstyle component name.
73      * @param string $itemtype the type of the item being favourited.
74      * @param int $itemid the id of the item which is to be favourited.
75      * @param \context $context the context in which the item is to be favourited.
76      * @param int|null $ordering optional ordering integer used for sorting the favourites in an area.
77      * @return \stdClass the favourite, once created.
78      * @throws \moodle_exception if the component name is invalid, or if the repository encounters any errors.
79      */
80     public function create_favourite(string $component, string $itemtype, int $itemid, \context $context,
81                                      int $ordering = null) : \stdClass {
82         // Access: Any component can ask to favourite something, we can't verify access to that 'something' here though.
84         // Validate the component name.
85         if (!in_array($component, $this->get_component_list())) {
86             throw new \moodle_exception("Invalid component name '$component'");
87         }
89         $favourite = (object) [
90             'userid' => $this->userid,
91             'component' => $component,
92             'itemtype' => $itemtype,
93             'itemid' => $itemid,
94             'contextid' => $context->id,
95             'ordering' => $ordering > 0 ? $ordering : null
96         ];
97         return $this->repo->add($favourite);
98     }
100     /**
101      * Find a list of favourites, by type, where type is the component/itemtype pair.
102      *
103      * E.g. "Find all favourite courses" might result in:
104      * $favcourses = find_favourites_by_type('core_course', 'course');
105      *
106      * @param string $component the frankenstyle component name.
107      * @param string $itemtype the type of the favourited item.
108      * @return array the list of favourites found.
109      * @throws \moodle_exception if the component name is invalid, or if the repository encounters any errors.
110      */
111     public function find_favourites_by_type(string $component, string $itemtype) : array {
112         if (!in_array($component, $this->get_component_list())) {
113             throw new \moodle_exception("Invalid component name '$component'");
114         }
115         return $this->repo->find_by(['userid' => $this->userid, 'component' => $component, 'itemtype' => $itemtype]);
116     }
118     /**
119      * Delete a favourite item from an area and from within a context.
120      *
121      * E.g. delete a favourite course from the area 'core_course', 'course' with itemid 3 and from within the CONTEXT_USER context.
122      *
123      * @param string $component the frankenstyle component name.
124      * @param string $itemtype the type of the favourited item.
125      * @param int $itemid the id of the item which was favourited (not the favourite's id).
126      * @param \context $context the context of the item which was favourited.
127      * @throws \moodle_exception if the user does not control the favourite, or it doesn't exist.
128      */
129     public function delete_favourite(string $component, string $itemtype, int $itemid, \context $context) {
130         if (!in_array($component, $this->get_component_list())) {
131             throw new \moodle_exception("Invalid component name '$component'");
132         }
134         // Business logic: check the user owns the favourite.
135         try {
136             $favourite = $this->repo->find_favourite($this->userid, $component, $itemtype, $itemid, $context->id);
137         } catch (\moodle_exception $e) {
138             throw new \moodle_exception("Favourite does not exist for the user. Cannot delete.");
139         }
141         $this->repo->delete($favourite->id);
142     }