MDL-70159 tool_capability: order capabilities by their name.

This commit is contained in:
Paul Holden
2021-01-14 07:32:56 +00:00
parent ed2400457b
commit 20905a1481
5 changed files with 105 additions and 60 deletions
+47 -56
View File
@@ -4873,6 +4873,9 @@ function role_change_permission($roleid, $context, $capname, $permission) {
*/
abstract class context extends stdClass implements IteratorAggregate {
/** @var string Default sorting of capabilities in {@see get_capabilities} */
protected const DEFAULT_CAPABILITY_SORT = 'contextlevel, component, name';
/**
* The context id
* Can be accessed publicly through $context->id
@@ -5559,9 +5562,10 @@ abstract class context extends stdClass implements IteratorAggregate {
/**
* Returns array of relevant context capability records.
*
* @param string $sort SQL order by snippet for sorting returned capabilities sensibly for display
* @return array
*/
public abstract function get_capabilities();
public abstract function get_capabilities(string $sort = self::DEFAULT_CAPABILITY_SORT);
/**
* Recursive function which, given a context, find all its children context ids.
@@ -6186,8 +6190,10 @@ class context_helper extends context {
/**
* not used
*
* @param string $sort
*/
public function get_capabilities() {
public function get_capabilities(string $sort = self::DEFAULT_CAPABILITY_SORT) {
}
}
@@ -6247,18 +6253,13 @@ class context_system extends context {
/**
* Returns array of relevant context capability records.
*
* @param string $sort
* @return array
*/
public function get_capabilities() {
public function get_capabilities(string $sort = self::DEFAULT_CAPABILITY_SORT) {
global $DB;
$sort = 'ORDER BY contextlevel,component,name'; // To group them sensibly for display
$params = array();
$sql = "SELECT *
FROM {capabilities}";
return $DB->get_records_sql($sql.' '.$sort, $params);
return $DB->get_records('capabilities', [], $sort);
}
/**
@@ -6522,21 +6523,17 @@ class context_user extends context {
/**
* Returns array of relevant context capability records.
*
* @param string $sort
* @return array
*/
public function get_capabilities() {
public function get_capabilities(string $sort = self::DEFAULT_CAPABILITY_SORT) {
global $DB;
$sort = 'ORDER BY contextlevel,component,name'; // To group them sensibly for display
$extracaps = array('moodle/grade:viewall');
list($extra, $params) = $DB->get_in_or_equal($extracaps, SQL_PARAMS_NAMED, 'cap');
$sql = "SELECT *
FROM {capabilities}
WHERE contextlevel = ".CONTEXT_USER."
OR name $extra";
return $records = $DB->get_records_sql($sql.' '.$sort, $params);
return $DB->get_records_select('capabilities', "contextlevel = :level OR name {$extra}",
$params + ['level' => CONTEXT_USER], $sort);
}
/**
@@ -6702,19 +6699,18 @@ class context_coursecat extends context {
/**
* Returns array of relevant context capability records.
*
* @param string $sort
* @return array
*/
public function get_capabilities() {
public function get_capabilities(string $sort = self::DEFAULT_CAPABILITY_SORT) {
global $DB;
$sort = 'ORDER BY contextlevel,component,name'; // To group them sensibly for display
$params = array();
$sql = "SELECT *
FROM {capabilities}
WHERE contextlevel IN (".CONTEXT_COURSECAT.",".CONTEXT_COURSE.",".CONTEXT_MODULE.",".CONTEXT_BLOCK.")";
return $DB->get_records_sql($sql.' '.$sort, $params);
return $DB->get_records_list('capabilities', 'contextlevel', [
CONTEXT_COURSECAT,
CONTEXT_COURSE,
CONTEXT_MODULE,
CONTEXT_BLOCK,
], $sort);
}
/**
@@ -6946,19 +6942,17 @@ class context_course extends context {
/**
* Returns array of relevant context capability records.
*
* @param string $sort
* @return array
*/
public function get_capabilities() {
public function get_capabilities(string $sort = self::DEFAULT_CAPABILITY_SORT) {
global $DB;
$sort = 'ORDER BY contextlevel,component,name'; // To group them sensibly for display
$params = array();
$sql = "SELECT *
FROM {capabilities}
WHERE contextlevel IN (".CONTEXT_COURSE.",".CONTEXT_MODULE.",".CONTEXT_BLOCK.")";
return $DB->get_records_sql($sql.' '.$sort, $params);
return $DB->get_records_list('capabilities', 'contextlevel', [
CONTEXT_COURSE,
CONTEXT_MODULE,
CONTEXT_BLOCK,
], $sort);
}
/**
@@ -7171,13 +7165,12 @@ class context_module extends context {
/**
* Returns array of relevant context capability records.
*
* @param string $sort
* @return array
*/
public function get_capabilities() {
public function get_capabilities(string $sort = self::DEFAULT_CAPABILITY_SORT) {
global $DB, $CFG;
$sort = 'ORDER BY contextlevel,component,name'; // To group them sensibly for display
$cm = $DB->get_record('course_modules', array('id'=>$this->_instanceid));
$module = $DB->get_record('modules', array('id'=>$cm->module));
@@ -7251,9 +7244,10 @@ class context_module extends context {
WHERE (contextlevel = ".CONTEXT_MODULE."
AND component {$notcompsql}
AND {$notlikesql})
$extra";
$extra
ORDER BY $sort";
return $DB->get_records_sql($sql.' '.$sort, $params);
return $DB->get_records_sql($sql, $params);
}
/**
@@ -7440,31 +7434,28 @@ class context_block extends context {
/**
* Returns array of relevant context capability records.
*
* @param string $sort
* @return array
*/
public function get_capabilities() {
public function get_capabilities(string $sort = self::DEFAULT_CAPABILITY_SORT) {
global $DB;
$sort = 'ORDER BY contextlevel,component,name'; // To group them sensibly for display
$params = array();
$bi = $DB->get_record('block_instances', array('id' => $this->_instanceid));
$extra = '';
$select = '(contextlevel = :level AND component = :component)';
$params = [
'level' => CONTEXT_BLOCK,
'component' => 'block_' . $bi->blockname,
];
$extracaps = block_method_result($bi->blockname, 'get_extra_capabilities');
if ($extracaps) {
list($extra, $params) = $DB->get_in_or_equal($extracaps, SQL_PARAMS_NAMED, 'cap');
$extra = "OR name $extra";
list($extra, $extraparams) = $DB->get_in_or_equal($extracaps, SQL_PARAMS_NAMED, 'cap');
$select .= " OR name $extra";
$params = array_merge($params, $extraparams);
}
$sql = "SELECT *
FROM {capabilities}
WHERE (contextlevel = ".CONTEXT_BLOCK."
AND component = :component)
$extra";
$params['component'] = 'block_' . $bi->blockname;
return $DB->get_records_sql($sql.' '.$sort, $params);
return $DB->get_records_select('capabilities', $select, $params, $sort);
}
/**