mirror of
https://github.com/moodle/moodle.git
synced 2025-03-24 09:30:17 +01:00
MDL-45627 mod_fourm: Move subscriber classes to separate class files
This commit is contained in:
Andrew Nicols
parent
a929fd50f9
commit
2789afa842
64
mod/forum/classes/existing_subscriber_selector.php
Normal file
64
mod/forum/classes/existing_subscriber_selector.php
Normal file
@ -0,0 +1,64 @@
|
||||
<?php
|
||||
// This file is part of Moodle - http://moodle.org/
|
||||
//
|
||||
// Moodle is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// Moodle is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
/**
|
||||
* A type of forum.
|
||||
*
|
||||
* @package mod_forum
|
||||
* @copyright 2014 Andrew Robert Nicols <andrew@nicols.co.uk>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
require_once($CFG->dirroot.'/user/selector/lib.php');
|
||||
|
||||
/**
|
||||
* User selector control for removing subscribed users
|
||||
* @package mod_forum
|
||||
* @copyright 2009 Sam Hemelryk
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class mod_forum_existing_subscriber_selector extends mod_forum_subscriber_selector_base {
|
||||
|
||||
/**
|
||||
* Finds all subscribed users
|
||||
*
|
||||
* @param string $search
|
||||
* @return array
|
||||
*/
|
||||
public function find_users($search) {
|
||||
global $DB;
|
||||
list($wherecondition, $params) = $this->search_sql($search, 'u');
|
||||
$params['forumid'] = $this->forumid;
|
||||
|
||||
// only active enrolled or everybody on the frontpage
|
||||
list($esql, $eparams) = get_enrolled_sql($this->context, '', $this->currentgroup, true);
|
||||
$fields = $this->required_fields_sql('u');
|
||||
list($sort, $sortparams) = users_order_by_sql('u', $search, $this->accesscontext);
|
||||
$params = array_merge($params, $eparams, $sortparams);
|
||||
|
||||
$subscribers = $DB->get_records_sql("SELECT $fields
|
||||
FROM {user} u
|
||||
JOIN ($esql) je ON je.id = u.id
|
||||
JOIN {forum_subscriptions} s ON s.userid = u.id
|
||||
WHERE $wherecondition AND s.forum = :forumid
|
||||
ORDER BY $sort", $params);
|
||||
|
||||
return array(get_string("existingsubscribers", 'forum') => $subscribers);
|
||||
}
|
||||
|
||||
}
|
||||
156
mod/forum/classes/potential_subscriber_selector.php
Normal file
156
mod/forum/classes/potential_subscriber_selector.php
Normal file
@ -0,0 +1,156 @@
|
||||
<?php
|
||||
// This file is part of Moodle - http://moodle.org/
|
||||
//
|
||||
// Moodle is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// Moodle is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
/**
|
||||
* A type of forum.
|
||||
*
|
||||
* @package mod_forum
|
||||
* @copyright 2014 Andrew Robert Nicols <andrew@nicols.co.uk>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
require_once($CFG->dirroot.'/user/selector/lib.php');
|
||||
|
||||
/**
|
||||
* A user selector control for potential subscribers to the selected forum
|
||||
* @package mod_forum
|
||||
* @copyright 2009 Sam Hemelryk
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class mod_forum_potential_subscriber_selector extends mod_forum_subscriber_selector_base {
|
||||
/**
|
||||
* If set to true EVERYONE in this course is force subscribed to this forum
|
||||
* @var bool
|
||||
*/
|
||||
protected $forcesubscribed = false;
|
||||
/**
|
||||
* Can be used to store existing subscribers so that they can be removed from
|
||||
* the potential subscribers list
|
||||
*/
|
||||
protected $existingsubscribers = array();
|
||||
|
||||
/**
|
||||
* Constructor method
|
||||
* @param string $name
|
||||
* @param array $options
|
||||
*/
|
||||
public function __construct($name, $options) {
|
||||
parent::__construct($name, $options);
|
||||
if (isset($options['forcesubscribed'])) {
|
||||
$this->forcesubscribed=true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an arary of options for this control
|
||||
* @return array
|
||||
*/
|
||||
protected function get_options() {
|
||||
$options = parent::get_options();
|
||||
if ($this->forcesubscribed===true) {
|
||||
$options['forcesubscribed']=1;
|
||||
}
|
||||
return $options;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds all potential users
|
||||
*
|
||||
* Potential subscribers are all enroled users who are not already subscribed.
|
||||
*
|
||||
* @param string $search
|
||||
* @return array
|
||||
*/
|
||||
public function find_users($search) {
|
||||
global $DB;
|
||||
|
||||
$whereconditions = array();
|
||||
list($wherecondition, $params) = $this->search_sql($search, 'u');
|
||||
if ($wherecondition) {
|
||||
$whereconditions[] = $wherecondition;
|
||||
}
|
||||
|
||||
if (!$this->forcesubscribed) {
|
||||
$existingids = array();
|
||||
foreach ($this->existingsubscribers as $group) {
|
||||
foreach ($group as $user) {
|
||||
$existingids[$user->id] = 1;
|
||||
}
|
||||
}
|
||||
if ($existingids) {
|
||||
list($usertest, $userparams) = $DB->get_in_or_equal(
|
||||
array_keys($existingids), SQL_PARAMS_NAMED, 'existing', false);
|
||||
$whereconditions[] = 'u.id ' . $usertest;
|
||||
$params = array_merge($params, $userparams);
|
||||
}
|
||||
}
|
||||
|
||||
if ($whereconditions) {
|
||||
$wherecondition = 'WHERE ' . implode(' AND ', $whereconditions);
|
||||
}
|
||||
|
||||
list($esql, $eparams) = get_enrolled_sql($this->context, '', $this->currentgroup, true);
|
||||
$params = array_merge($params, $eparams);
|
||||
|
||||
$fields = 'SELECT ' . $this->required_fields_sql('u');
|
||||
$countfields = 'SELECT COUNT(u.id)';
|
||||
|
||||
$sql = " FROM {user} u
|
||||
JOIN ($esql) je ON je.id = u.id
|
||||
$wherecondition";
|
||||
|
||||
list($sort, $sortparams) = users_order_by_sql('u', $search, $this->accesscontext);
|
||||
$order = ' ORDER BY ' . $sort;
|
||||
|
||||
// Check to see if there are too many to show sensibly.
|
||||
if (!$this->is_validating()) {
|
||||
$potentialmemberscount = $DB->count_records_sql($countfields . $sql, $params);
|
||||
if ($potentialmemberscount > $this->maxusersperpage) {
|
||||
return $this->too_many_results($search, $potentialmemberscount);
|
||||
}
|
||||
}
|
||||
|
||||
// If not, show them.
|
||||
$availableusers = $DB->get_records_sql($fields . $sql . $order, array_merge($params, $sortparams));
|
||||
|
||||
if (empty($availableusers)) {
|
||||
return array();
|
||||
}
|
||||
|
||||
if ($this->forcesubscribed) {
|
||||
return array(get_string("existingsubscribers", 'forum') => $availableusers);
|
||||
} else {
|
||||
return array(get_string("potentialsubscribers", 'forum') => $availableusers);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the existing subscribers
|
||||
* @param array $users
|
||||
*/
|
||||
public function set_existing_subscribers(array $users) {
|
||||
$this->existingsubscribers = $users;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets this forum as force subscribed or not
|
||||
*/
|
||||
public function set_force_subscribed($setting=true) {
|
||||
$this->forcesubscribed = true;
|
||||
}
|
||||
}
|
||||
87
mod/forum/classes/subscriber_selector_base.php
Normal file
87
mod/forum/classes/subscriber_selector_base.php
Normal file
@ -0,0 +1,87 @@
|
||||
<?php
|
||||
// This file is part of Moodle - http://moodle.org/
|
||||
//
|
||||
// Moodle is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// Moodle is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
/**
|
||||
* A type of forum.
|
||||
*
|
||||
* @package mod_forum
|
||||
* @copyright 2014 Andrew Robert Nicols <andrew@nicols.co.uk>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
require_once($CFG->dirroot.'/user/selector/lib.php');
|
||||
|
||||
/**
|
||||
* Abstract class used by forum subscriber selection controls
|
||||
* @package mod_forum
|
||||
* @copyright 2009 Sam Hemelryk
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
abstract class mod_forum_subscriber_selector_base extends user_selector_base {
|
||||
|
||||
/**
|
||||
* The id of the forum this selector is being used for
|
||||
* @var int
|
||||
*/
|
||||
protected $forumid = null;
|
||||
/**
|
||||
* The context of the forum this selector is being used for
|
||||
* @var object
|
||||
*/
|
||||
protected $context = null;
|
||||
/**
|
||||
* The id of the current group
|
||||
* @var int
|
||||
*/
|
||||
protected $currentgroup = null;
|
||||
|
||||
/**
|
||||
* Constructor method
|
||||
* @param string $name
|
||||
* @param array $options
|
||||
*/
|
||||
public function __construct($name, $options) {
|
||||
$options['accesscontext'] = $options['context'];
|
||||
parent::__construct($name, $options);
|
||||
if (isset($options['context'])) {
|
||||
$this->context = $options['context'];
|
||||
}
|
||||
if (isset($options['currentgroup'])) {
|
||||
$this->currentgroup = $options['currentgroup'];
|
||||
}
|
||||
if (isset($options['forumid'])) {
|
||||
$this->forumid = $options['forumid'];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of options to seralise and store for searches
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function get_options() {
|
||||
global $CFG;
|
||||
$options = parent::get_options();
|
||||
$options['file'] = substr(__FILE__, strlen($CFG->dirroot.'/'));
|
||||
$options['context'] = $this->context;
|
||||
$options['currentgroup'] = $this->currentgroup;
|
||||
$options['forumid'] = $this->forumid;
|
||||
return $options;
|
||||
}
|
||||
|
||||
}
|
||||
@ -25,7 +25,6 @@ defined('MOODLE_INTERNAL') || die();
|
||||
/** Include required files */
|
||||
require_once($CFG->libdir.'/filelib.php');
|
||||
require_once($CFG->libdir.'/eventslib.php');
|
||||
require_once($CFG->dirroot.'/user/selector/lib.php');
|
||||
|
||||
/// CONSTANTS ///////////////////////////////////////////////////////////
|
||||
|
||||
@ -7834,232 +7833,6 @@ function forum_extend_settings_navigation(settings_navigation $settingsnav, navi
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Abstract class used by forum subscriber selection controls
|
||||
* @package mod_forum
|
||||
* @copyright 2009 Sam Hemelryk
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
abstract class forum_subscriber_selector_base extends user_selector_base {
|
||||
|
||||
/**
|
||||
* The id of the forum this selector is being used for
|
||||
* @var int
|
||||
*/
|
||||
protected $forumid = null;
|
||||
/**
|
||||
* The context of the forum this selector is being used for
|
||||
* @var object
|
||||
*/
|
||||
protected $context = null;
|
||||
/**
|
||||
* The id of the current group
|
||||
* @var int
|
||||
*/
|
||||
protected $currentgroup = null;
|
||||
|
||||
/**
|
||||
* Constructor method
|
||||
* @param string $name
|
||||
* @param array $options
|
||||
*/
|
||||
public function __construct($name, $options) {
|
||||
$options['accesscontext'] = $options['context'];
|
||||
parent::__construct($name, $options);
|
||||
if (isset($options['context'])) {
|
||||
$this->context = $options['context'];
|
||||
}
|
||||
if (isset($options['currentgroup'])) {
|
||||
$this->currentgroup = $options['currentgroup'];
|
||||
}
|
||||
if (isset($options['forumid'])) {
|
||||
$this->forumid = $options['forumid'];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of options to seralise and store for searches
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function get_options() {
|
||||
global $CFG;
|
||||
$options = parent::get_options();
|
||||
$options['file'] = substr(__FILE__, strlen($CFG->dirroot.'/'));
|
||||
$options['context'] = $this->context;
|
||||
$options['currentgroup'] = $this->currentgroup;
|
||||
$options['forumid'] = $this->forumid;
|
||||
return $options;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* A user selector control for potential subscribers to the selected forum
|
||||
* @package mod_forum
|
||||
* @copyright 2009 Sam Hemelryk
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class forum_potential_subscriber_selector extends forum_subscriber_selector_base {
|
||||
/**
|
||||
* If set to true EVERYONE in this course is force subscribed to this forum
|
||||
* @var bool
|
||||
*/
|
||||
protected $forcesubscribed = false;
|
||||
/**
|
||||
* Can be used to store existing subscribers so that they can be removed from
|
||||
* the potential subscribers list
|
||||
*/
|
||||
protected $existingsubscribers = array();
|
||||
|
||||
/**
|
||||
* Constructor method
|
||||
* @param string $name
|
||||
* @param array $options
|
||||
*/
|
||||
public function __construct($name, $options) {
|
||||
parent::__construct($name, $options);
|
||||
if (isset($options['forcesubscribed'])) {
|
||||
$this->forcesubscribed=true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an arary of options for this control
|
||||
* @return array
|
||||
*/
|
||||
protected function get_options() {
|
||||
$options = parent::get_options();
|
||||
if ($this->forcesubscribed===true) {
|
||||
$options['forcesubscribed']=1;
|
||||
}
|
||||
return $options;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds all potential users
|
||||
*
|
||||
* Potential subscribers are all enroled users who are not already subscribed.
|
||||
*
|
||||
* @param string $search
|
||||
* @return array
|
||||
*/
|
||||
public function find_users($search) {
|
||||
global $DB;
|
||||
|
||||
$whereconditions = array();
|
||||
list($wherecondition, $params) = $this->search_sql($search, 'u');
|
||||
if ($wherecondition) {
|
||||
$whereconditions[] = $wherecondition;
|
||||
}
|
||||
|
||||
if (!$this->forcesubscribed) {
|
||||
$existingids = array();
|
||||
foreach ($this->existingsubscribers as $group) {
|
||||
foreach ($group as $user) {
|
||||
$existingids[$user->id] = 1;
|
||||
}
|
||||
}
|
||||
if ($existingids) {
|
||||
list($usertest, $userparams) = $DB->get_in_or_equal(
|
||||
array_keys($existingids), SQL_PARAMS_NAMED, 'existing', false);
|
||||
$whereconditions[] = 'u.id ' . $usertest;
|
||||
$params = array_merge($params, $userparams);
|
||||
}
|
||||
}
|
||||
|
||||
if ($whereconditions) {
|
||||
$wherecondition = 'WHERE ' . implode(' AND ', $whereconditions);
|
||||
}
|
||||
|
||||
list($esql, $eparams) = get_enrolled_sql($this->context, '', $this->currentgroup, true);
|
||||
$params = array_merge($params, $eparams);
|
||||
|
||||
$fields = 'SELECT ' . $this->required_fields_sql('u');
|
||||
$countfields = 'SELECT COUNT(u.id)';
|
||||
|
||||
$sql = " FROM {user} u
|
||||
JOIN ($esql) je ON je.id = u.id
|
||||
$wherecondition";
|
||||
|
||||
list($sort, $sortparams) = users_order_by_sql('u', $search, $this->accesscontext);
|
||||
$order = ' ORDER BY ' . $sort;
|
||||
|
||||
// Check to see if there are too many to show sensibly.
|
||||
if (!$this->is_validating()) {
|
||||
$potentialmemberscount = $DB->count_records_sql($countfields . $sql, $params);
|
||||
if ($potentialmemberscount > $this->maxusersperpage) {
|
||||
return $this->too_many_results($search, $potentialmemberscount);
|
||||
}
|
||||
}
|
||||
|
||||
// If not, show them.
|
||||
$availableusers = $DB->get_records_sql($fields . $sql . $order, array_merge($params, $sortparams));
|
||||
|
||||
if (empty($availableusers)) {
|
||||
return array();
|
||||
}
|
||||
|
||||
if ($this->forcesubscribed) {
|
||||
return array(get_string("existingsubscribers", 'forum') => $availableusers);
|
||||
} else {
|
||||
return array(get_string("potentialsubscribers", 'forum') => $availableusers);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the existing subscribers
|
||||
* @param array $users
|
||||
*/
|
||||
public function set_existing_subscribers(array $users) {
|
||||
$this->existingsubscribers = $users;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets this forum as force subscribed or not
|
||||
*/
|
||||
public function set_force_subscribed($setting=true) {
|
||||
$this->forcesubscribed = true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* User selector control for removing subscribed users
|
||||
* @package mod_forum
|
||||
* @copyright 2009 Sam Hemelryk
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class forum_existing_subscriber_selector extends forum_subscriber_selector_base {
|
||||
|
||||
/**
|
||||
* Finds all subscribed users
|
||||
*
|
||||
* @param string $search
|
||||
* @return array
|
||||
*/
|
||||
public function find_users($search) {
|
||||
global $DB;
|
||||
list($wherecondition, $params) = $this->search_sql($search, 'u');
|
||||
$params['forumid'] = $this->forumid;
|
||||
|
||||
// only active enrolled or everybody on the frontpage
|
||||
list($esql, $eparams) = get_enrolled_sql($this->context, '', $this->currentgroup, true);
|
||||
$fields = $this->required_fields_sql('u');
|
||||
list($sort, $sortparams) = users_order_by_sql('u', $search, $this->accesscontext);
|
||||
$params = array_merge($params, $eparams, $sortparams);
|
||||
|
||||
$subscribers = $DB->get_records_sql("SELECT $fields
|
||||
FROM {user} u
|
||||
JOIN ($esql) je ON je.id = u.id
|
||||
JOIN {forum_subscriptions} s ON s.userid = u.id
|
||||
WHERE $wherecondition AND s.forum = :forumid
|
||||
ORDER BY $sort", $params);
|
||||
|
||||
return array(get_string("existingsubscribers", 'forum') => $subscribers);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds information about unread messages, that is only required for the course view page (and
|
||||
* similar), to the course-module object.
|
||||
|
||||
@ -64,8 +64,8 @@ $event->trigger();
|
||||
$forumoutput = $PAGE->get_renderer('mod_forum');
|
||||
$currentgroup = groups_get_activity_group($cm);
|
||||
$options = array('forumid'=>$forum->id, 'currentgroup'=>$currentgroup, 'context'=>$context);
|
||||
$existingselector = new forum_existing_subscriber_selector('existingsubscribers', $options);
|
||||
$subscriberselector = new forum_potential_subscriber_selector('potentialsubscribers', $options);
|
||||
$existingselector = new mod_forum_existing_subscriber_selector('existingsubscribers', $options);
|
||||
$subscriberselector = new mod_forum_potential_subscriber_selector('potentialsubscribers', $options);
|
||||
$subscriberselector->set_existing_subscribers($existingselector->find_users(''));
|
||||
|
||||
if (data_submitted()) {
|
||||
@ -118,4 +118,4 @@ if (empty($USER->subscriptionsediting)) {
|
||||
} else {
|
||||
echo $forumoutput->subscriber_selection_form($existingselector, $subscriberselector);
|
||||
}
|
||||
echo $OUTPUT->footer();
|
||||
echo $OUTPUT->footer();
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user