moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-06 17:36:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-32941 external: core_course_get_categories() fixing.

Browse source 
This includes:

- Multiple coding violations.
- Better detection of criteria, avoiding troublemaker 0 != ''
- Minor formatting.
- Ordering by path always to cause excludes to work ok.
This commit is contained in:
Eloy Lafuente (stronk7) 2012-05-04 02:29:28 +02:00 • committed by Jerome Mouneyrac
parent d4a17894ef
commit 20854c75f1
1 changed files with 43 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

39
course/externallib.php
View file

@ -269,7 +269,8 @@ class core_course_external extends external_api {
"theme" (string) category theme'), "theme" (string) category theme'),
'value' => new external_value(PARAM_RAW, 'the value to match') 'value' => new external_value(PARAM_RAW, 'the value to match')
) )
), VALUE_DEFAULT, array()), ), VALUE_DEFAULT, array()
),
'addsubcategories' => new external_value(PARAM_BOOL, 'return the sub categories infos 'addsubcategories' => new external_value(PARAM_BOOL, 'return the sub categories infos
(1 - default) otherwise only the category info (0)', VALUE_DEFAULT, 1) (1 - default) otherwise only the category info (0)', VALUE_DEFAULT, 1)
) )
@ -280,7 +281,7 @@ class core_course_external extends external_api {
* Get categories * Get categories
* *
* @param array $criteria Criteria to match the results * @param array $criteria Criteria to match the results
* @param boolean $addsubcategories obtain only the category (false) or its subcategories (true - default) * @param booln $addsubcategories obtain only the category (false) or its subcategories (true - default)
* @return array list of categories * @return array list of categories
* @since Moodle 2.3 * @since Moodle 2.3
*/ */
@ -305,36 +306,42 @@ class core_course_external extends external_api {
if (!isset($conditions[$key])) { if (!isset($conditions[$key])) {
$context = context_system::instance(); $context = context_system::instance();
$value = ''; $value = null;
switch ($key) { switch ($key) {
case 'id': $value = clean_param($crit['value'], PARAM_INT); case 'id':
$value = clean_param($crit['value'], PARAM_INT);
break; break;
case 'idnumber': if (has_capability('moodle/category:manage', $context)) { case 'idnumber':
if (has_capability('moodle/category:manage', $context)) {
$value = clean_param($crit['value'], PARAM_RAW); $value = clean_param($crit['value'], PARAM_RAW);
} }
break; break;
case 'name': $value = clean_param($crit['value'], PARAM_TEXT); case 'name':
$value = clean_param($crit['value'], PARAM_TEXT);
break; break;
case 'parent': $value = clean_param($crit['value'], PARAM_INT); case 'parent':
$value = clean_param($crit['value'], PARAM_INT);
break; break;
case 'visible': $value = clean_param($crit['value'], PARAM_INT); case 'visible':
$value = clean_param($crit['value'], PARAM_INT);
break; break;
case 'theme': if (has_capability('moodle/category:manage', $context)) { case 'theme':
if (has_capability('moodle/category:manage', $context)) {
$value = clean_param($crit['value'], PARAM_THEME); $value = clean_param($crit['value'], PARAM_THEME);
} }
break; break;
default: throw new moodle_exception('invalidextparam', 'webservice', '', $key); default:
throw new moodle_exception('invalidextparam', 'webservice', '', $key);
} }
// 0 is a valid value. I.e visible = 0. So we check for not empty string. if (isset($value)) {
if ($value != '') {
$conditions[$key] = $crit['value']; $conditions[$key] = $crit['value'];
$wheres[] = $key . " = :" . $key; $wheres[] = $key . " = :" . $key;
} }
@ -344,7 +351,7 @@ class core_course_external extends external_api {
if (!empty($wheres)) { if (!empty($wheres)) {
$wheres = implode(" AND ", $wheres); $wheres = implode(" AND ", $wheres);
$categories = $DB->get_records_select('course_categories', $wheres, $conditions); $categories = $DB->get_records_select('course_categories', $wheres, $conditions 'path');
// Retrieve its sub subcategories (all levels). // Retrieve its sub subcategories (all levels).
if ($categories and !empty($params['addsubcategories'])) { if ($categories and !empty($params['addsubcategories'])) {
@ -352,7 +359,7 @@ class core_course_external extends external_api {
foreach ($categories as $category) { foreach ($categories as $category) {
$sqllike = $DB->sql_like('path', ':path'); $sqllike = $DB->sql_like('path', ':path');
$sqlparams = array('path' => $category->path.'/%'); // It will include the specified category. $sqlparams = array('path' => $category->path.'/%'); // It will NOT include the specified category.
$subcategories = $DB->get_records_select('course_categories', $sqllike, $sqlparams, 'path'); $subcategories = $DB->get_records_select('course_categories', $sqllike, $sqlparams, 'path');
$newcategories = array_merge($newcategories, $subcategories); // Both arrays have integer as keys. $newcategories = array_merge($newcategories, $subcategories); // Both arrays have integer as keys.
} }
@ -362,7 +369,7 @@ class core_course_external extends external_api {
} else { } else {
// Retrieve all categories in the database. // Retrieve all categories in the database.
$categories = $DB->get_records('course_categories', array(), 'sortorder ASC'); $categories = $DB->get_records('course_categories', array(), 'path');
} }
// The not returned categories. key => category id, value => reason of exclusion. // The not returned categories. key => category id, value => reason of exclusion.
@ -479,7 +486,9 @@ class core_course_external extends external_api {
/** /**
* Returns description of method parameters * Returns description of method parameters
*
* @return external_function_parameters * @return external_function_parameters
* @since Moodle 2.2
*/ */
public static function get_courses_parameters() { public static function get_courses_parameters() {
return new external_function_parameters( return new external_function_parameters(