mirror of
https://github.com/moodle/moodle.git
synced 2025-02-23 19:44:19 +01:00
ba1f804ffa
This has been generated running the following Sniffs, all them part of the Moodle's CodeSniffer standard: - PSR12.Functions.ReturnTypeDeclaration - PSR12.Functions.NullableTypeDeclaration - moodle.Methods.MethodDeclarationSpacing - Squiz.Whitespace.ScopeKeywordSpacing All them are, exclusively, about correct spacing, so the changes are, all them, only white space changes. Only exceptions to the above are 3 changes what were setting the return type in a new line, and, when that happens, the closing parenthesis (bracket) has to go to the same line than the colon.
105 lines
3.0 KiB
PHP
105 lines
3.0 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* List of users from the Privacy API Search functions.
|
|
*
|
|
* @package core_privacy
|
|
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core_privacy\local\request;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* List of users from the Privacy API Search functions.
|
|
*
|
|
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class userlist extends userlist_base {
|
|
|
|
/**
|
|
* Add a set of users from SQL.
|
|
*
|
|
* The SQL should only return a list of user IDs.
|
|
*
|
|
* @param string $fieldname The name of the field which holds the user id
|
|
* @param string $sql The SQL which will fetch the list of * user IDs
|
|
* @param array $params The set of SQL parameters
|
|
* @return $this
|
|
*/
|
|
public function add_from_sql(string $fieldname, string $sql, array $params): userlist {
|
|
global $DB;
|
|
|
|
// Able to guess a field name.
|
|
$wrapper = "
|
|
SELECT DISTINCT u.id
|
|
FROM {user} u
|
|
JOIN ({$sql}) target ON u.id = target.{$fieldname}";
|
|
|
|
$users = $DB->get_records_sql($wrapper, $params);
|
|
$this->add_userids(array_keys($users));
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds the user user for a given user.
|
|
*
|
|
* @param int $userid
|
|
* @return $this
|
|
*/
|
|
public function add_user(int $userid): userlist {
|
|
$this->add_users([$userid]);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds the user users for given users.
|
|
*
|
|
* @param int[] $userids
|
|
* @return $this
|
|
*/
|
|
public function add_users(array $userids): userlist {
|
|
global $DB;
|
|
|
|
if (!empty($userids)) {
|
|
list($useridsql, $useridparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
|
|
$sql = "SELECT DISTINCT u.id
|
|
FROM {user} u
|
|
WHERE u.id {$useridsql}";
|
|
$this->add_from_sql('id', $sql, $useridparams);
|
|
}
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets the component for this userlist.
|
|
*
|
|
* @param string $component the frankenstyle component name.
|
|
* @return $this
|
|
*/
|
|
public function set_component($component): userlist_base {
|
|
parent::set_component($component);
|
|
|
|
return $this;
|
|
}
|
|
}
|