| 1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - http://moodle.org/
|
|
|
3 |
//
|
|
|
4 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
5 |
// it under the terms of the GNU General Public License as published by
|
|
|
6 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
7 |
// (at your option) any later version.
|
|
|
8 |
//
|
|
|
9 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
10 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
11 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
12 |
// GNU General Public License for more details.
|
|
|
13 |
//
|
|
|
14 |
// You should have received a copy of the GNU General Public License
|
|
|
15 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
namespace communication_matrix\local\spec\features\matrix;
|
|
|
18 |
|
|
|
19 |
use communication_matrix\local\command;
|
|
|
20 |
use GuzzleHttp\Psr7\Response;
|
|
|
21 |
|
|
|
22 |
/**
|
|
|
23 |
* Matrix API feature for room creation.
|
|
|
24 |
*
|
|
|
25 |
* https://spec.matrix.org/v1.1/client-server-api/#post_matrixclientv3createroom
|
|
|
26 |
*
|
|
|
27 |
* @package communication_matrix
|
|
|
28 |
* @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
|
|
|
29 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
30 |
* @codeCoverageIgnore
|
|
|
31 |
* This code does not warrant being tested. Testing offers no discernible benefit given its usage is tested.
|
|
|
32 |
*/
|
|
|
33 |
trait create_room_v3 {
|
|
|
34 |
/**
|
|
|
35 |
* Create a new room.
|
|
|
36 |
*
|
|
|
37 |
* @param string $name The room name
|
|
|
38 |
* @param null|string $visibility The room visibility
|
|
|
39 |
* @param null|string $preset The preset to use
|
|
|
40 |
* @param null|array $initialstate Initial state variables
|
|
|
41 |
* @param array $options Any additional options
|
|
|
42 |
* @return Response
|
|
|
43 |
*/
|
|
|
44 |
public function create_room(
|
|
|
45 |
string $name,
|
|
|
46 |
?string $visibility = null,
|
|
|
47 |
?string $preset = null,
|
|
|
48 |
?array $initialstate = null,
|
|
|
49 |
array $options = [],
|
|
|
50 |
): Response {
|
|
|
51 |
$params = [
|
|
|
52 |
'name' => $name,
|
|
|
53 |
];
|
|
|
54 |
|
|
|
55 |
if ($visibility !== null) {
|
|
|
56 |
$params['visibility'] = $visibility;
|
|
|
57 |
}
|
|
|
58 |
|
|
|
59 |
if ($preset !== null) {
|
|
|
60 |
$params['preset'] = $preset;
|
|
|
61 |
}
|
|
|
62 |
|
|
|
63 |
if ($initialstate !== null) {
|
|
|
64 |
$params['initial_state'] = $initialstate;
|
|
|
65 |
}
|
|
|
66 |
|
|
|
67 |
if (array_key_exists('topic', $options)) {
|
|
|
68 |
$params['topic'] = $options['topic'] ?? '';
|
|
|
69 |
}
|
|
|
70 |
|
|
|
71 |
return $this->execute(new command(
|
|
|
72 |
$this,
|
|
|
73 |
method: 'POST',
|
|
|
74 |
endpoint: '_matrix/client/v3/createRoom',
|
|
|
75 |
params: $params,
|
|
|
76 |
));
|
|
|
77 |
}
|
|
|
78 |
}
|