MDL-31873 added mod_assign_get_grades web service function
[moodle.git] / cohort / locallib.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  * Cohort UI related functions and classes.
19  *
20  * @package    core_cohort
21  * @copyright  2012 Petr Skoda  {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->dirroot . '/cohort/lib.php');
28 require_once($CFG->dirroot . '/user/selector/lib.php');
31 /**
32  * Cohort assignment candidates
33  */
34 class cohort_candidate_selector extends user_selector_base {
35     protected $cohortid;
37     public function __construct($name, $options) {
38         $this->cohortid = $options['cohortid'];
39         parent::__construct($name, $options);
40     }
42     /**
43      * Candidate users
44      * @param string $search
45      * @return array
46      */
47     public function find_users($search) {
48         global $DB;
49         // By default wherecondition retrieves all users except the deleted, not confirmed and guest.
50         list($wherecondition, $params) = $this->search_sql($search, 'u');
51         $params['cohortid'] = $this->cohortid;
53         $fields      = 'SELECT ' . $this->required_fields_sql('u');
54         $countfields = 'SELECT COUNT(1)';
56         $sql = " FROM {user} u
57             LEFT JOIN {cohort_members} cm ON (cm.userid = u.id AND cm.cohortid = :cohortid)
58                 WHERE cm.id IS NULL AND $wherecondition";
60         $order = ' ORDER BY u.lastname ASC, u.firstname ASC';
62         if (!$this->is_validating()) {
63             $potentialmemberscount = $DB->count_records_sql($countfields . $sql, $params);
64             if ($potentialmemberscount > 100) {
65                 return $this->too_many_results($search, $potentialmemberscount);
66             }
67         }
69         $availableusers = $DB->get_records_sql($fields . $sql . $order, $params);
71         if (empty($availableusers)) {
72             return array();
73         }
76         if ($search) {
77             $groupname = get_string('potusersmatching', 'cohort', $search);
78         } else {
79             $groupname = get_string('potusers', 'cohort');
80         }
82         return array($groupname => $availableusers);
83     }
85     protected function get_options() {
86         $options = parent::get_options();
87         $options['cohortid'] = $this->cohortid;
88         $options['file'] = 'cohort/locallib.php';
89         return $options;
90     }
91 }
94 /**
95  * Cohort assignment candidates
96  */
97 class cohort_existing_selector extends user_selector_base {
98     protected $cohortid;
100     public function __construct($name, $options) {
101         $this->cohortid = $options['cohortid'];
102         parent::__construct($name, $options);
103     }
105     /**
106      * Candidate users
107      * @param string $search
108      * @return array
109      */
110     public function find_users($search) {
111         global $DB;
112         // By default wherecondition retrieves all users except the deleted, not confirmed and guest.
113         list($wherecondition, $params) = $this->search_sql($search, 'u');
114         $params['cohortid'] = $this->cohortid;
116         $fields      = 'SELECT ' . $this->required_fields_sql('u');
117         $countfields = 'SELECT COUNT(1)';
119         $sql = " FROM {user} u
120                  JOIN {cohort_members} cm ON (cm.userid = u.id AND cm.cohortid = :cohortid)
121                 WHERE $wherecondition";
123         $order = ' ORDER BY u.lastname ASC, u.firstname ASC';
125         if (!$this->is_validating()) {
126             $potentialmemberscount = $DB->count_records_sql($countfields . $sql, $params);
127             if ($potentialmemberscount > 100) {
128                 return $this->too_many_results($search, $potentialmemberscount);
129             }
130         }
132         $availableusers = $DB->get_records_sql($fields . $sql . $order, $params);
134         if (empty($availableusers)) {
135             return array();
136         }
139         if ($search) {
140             $groupname = get_string('currentusersmatching', 'cohort', $search);
141         } else {
142             $groupname = get_string('currentusers', 'cohort');
143         }
145         return array($groupname => $availableusers);
146     }
148     protected function get_options() {
149         $options = parent::get_options();
150         $options['cohortid'] = $this->cohortid;
151         $options['file'] = 'cohort/locallib.php';
152         return $options;
153     }