MDL-61937 mod_data: implement privacy provider
[moodle.git] / competency / classes / external / performance_helper.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  * Performance helper.
19  *
20  * @package    core_competency
21  * @copyright  2016 Frédéric Massart - FMCorz.net
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_competency\external;
26 defined('MOODLE_INTERNAL') || die();
28 use core_competency\competency;
30 /**
31  * Performance helper class.
32  *
33  * This tool keeps a local cache of certain items, which means that subsequent
34  * calls to get the resource will not query the database. You will want to use
35  * this when many resources could be shared and need to be queried in a loop.
36  *
37  * Note that some of these improvements can only be achieved by knowing the
38  * logic deeper in other modules. For instance we know that a competency's context
39  * is the one of its framework. This tool must be kept in sync with those APIs.
40  *
41  * @package    core_competency
42  * @copyright  2016 Frédéric Massart - FMCorz.net
43  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44  */
45 class performance_helper {
47     /** @var \context Cache of contexts by framework ID. */
48     protected $frameworkscontexts = [];
50     /** @var competency_framework Cache of frameworks by framework ID. */
51     protected $frameworks = [];
53     /** @var \grade_scale[] Cache of scales by scale ID. */
54     protected $scales = [];
56     /**
57      * Get the context of a competency.
58      *
59      * @param competency $competency The competency.
60      * @return \context
61      */
62     public function get_context_from_competency(competency $competency) {
63         $frameworkid = $competency->get('competencyframeworkid');
64         if (!isset($this->frameworkscontexts[$frameworkid])) {
65             $framework = $this->get_framework_from_competency($competency);
66             $this->frameworkscontexts[$frameworkid] = $framework->get_context();
67         }
68         return $this->frameworkscontexts[$frameworkid];
69     }
71     /**
72      * Get the framework of a competency.
73      *
74      * @param competency $competency The competency.
75      * @return competency_framework
76      */
77     public function get_framework_from_competency(competency $competency) {
78         $frameworkid = $competency->get('competencyframeworkid');
79         if (!isset($this->frameworks[$frameworkid])) {
80             $this->frameworks[$frameworkid] = $competency->get_framework();
81         }
82         return $this->frameworks[$frameworkid];
83     }
85     /**
86      * Get the scale of a competency.
87      *
88      * /!\ Make sure that this is always kept in sync with:
89      *  - core_competency\competency::get_scale()
90      *  - core_competency\competency_framework::get_scale()
91      *
92      * @param competency $competency The competency.
93      * @return \grade_scale
94      */
95     public function get_scale_from_competency(competency $competency) {
96         $scaleid = $competency->get('scaleid');
97         if ($scaleid !== null && !isset($this->scales[$scaleid])) {
98             $this->scales[$scaleid] = $competency->get_scale();
100         } else if ($scaleid === null) {
101             $framework = $this->get_framework_from_competency($competency);
102             $scaleid = $framework->get('scaleid');
103             if (!isset($this->scales[$scaleid])) {
104                 $this->scales[$scaleid] = $framework->get_scale();
105             }
106         }
108         return $this->scales[$scaleid];
109     }