moodle/user/filters/globalrole.php
poltawski 85de84a89f MDL-13262 - role related user filters were assuming roleids because array_merge
was stomping on keys. Patch by Dennis Rochford

merged from MOODLE_19_STABLE
2008-02-08 12:16:00 +00:00

88 lines
2.7 KiB
PHP

<?php //$Id$
require_once($CFG->dirroot.'/user/filters/lib.php');
/**
* User filter based on global roles.
*/
class user_filter_globalrole extends user_filter_type {
/**
* Constructor
* @param string $name the name of the filter instance
* @param string $label the label of the filter instance
* @param boolean $advanced advanced form element flag
*/
function user_filter_globalrole($name, $label, $advanced) {
parent::user_filter_type($name, $label, $advanced);
}
/**
* Returns an array of available roles
* @return array of availble roles
*/
function get_roles() {
$context = get_context_instance(CONTEXT_SYSTEM);
$roles = array(0=> get_string('anyrole','filters')) + get_assignable_roles($context);
return $roles;
}
/**
* Adds controls specific to this filter in the form.
* @param object $mform a MoodleForm object to setup
*/
function setupForm(&$mform) {
$obj =& $mform->addElement('select', $this->_name, $this->_label, $this->get_roles());
$obj->setHelpButton(array('globalrole', $this->_label, 'filters'));
$mform->setDefault($this->_name, 0);
if ($this->_advanced) {
$mform->setAdvanced($this->_name);
}
}
/**
* Retrieves data from the form data
* @param object $formdata data submited with the form
* @return mixed array filter data or false when filter not set
*/
function check_data($formdata) {
$field = $this->_name;
if (array_key_exists($field, $formdata) and !empty($formdata->$field)) {
return array('value' => (int)$formdata->$field);
}
return false;
}
/**
* Returns the condition to be used with SQL where
* @param array $data filter settings
* @return string the filtering condition or null if the filter is disabled
*/
function get_sql_filter($data) {
global $CFG;
$value = $data['value'];
$timenow = round(time(), 100);
return "id IN (SELECT userid
FROM {$CFG->prefix}role_assignments a
WHERE a.contextid=".SYSCONTEXTID." AND a.roleid=$value AND a.timestart<$timenow
AND (a.timeend=0 OR a.timeend>$timenow))";
}
/**
* Returns a human friendly description of the filter used as label.
* @param array $data filter settings
* @return string active filter label
*/
function get_label($data) {
$rolename = get_field('role', 'name', 'id', $data['value']);
$a = new object();
$a->label = $this->_label;
$a->value = '"'.format_string($rolename).'"';
return get_string('globalrolelabel', 'filters', $a);
}
}