]>
jfr.im git - irc/unrealircd/unrealircd-rpc-php.git/blob - lib/Channel.php
11 public Connection
$connection;
13 public function __construct(Connection
$conn)
15 $this->connection
= $conn;
19 * Return a list of channels users.
21 * @return stdClass|array|bool
24 public function getAll(): stdClass
|array|bool
26 $response = $this->connection
->query('channel.list');
28 if(!is_bool($response)) {
29 return $response->list;
32 throw new Exception('Invalid JSON Response from UnrealIRCd RPC.');
36 * Get a channel object
38 * @return stdClass|array|bool
41 public function get(string $channel): stdClass
|array|bool
43 $response = $this->connection
->query('channel.get', ['channel' => $channel]);
45 if (!is_bool($response)) {
49 throw new Exception('Invalid JSON Response from UnrealIRCd RPC.');
53 * Set and unset modes on a channel.
55 * @return stdClass|array|bool
58 public function set_mode(string $channel, string $modes, string $parameters): stdClass
|array|bool
60 return $this->connection
->query('channel.set_mode', [
61 'channel' => $channel,
63 'parameters' => $parameters,
68 * Set the channel topic.
70 * @return stdClass|array|bool
73 public function set_topic(string $channel, string $topic,
74 string $set_by=null, string $set_at=null): stdClass
|array|bool
76 return $this->connection
->query('channel.set_topic', [
77 'channel' => $channel,
85 * Kick a user from the channel.
87 * @return stdClass|array|bool
90 public function kick(string $channel, string $nick, string $reason): stdClass
|array|bool
92 return $this->connection
->query('user.kick', [
94 'channel' => $channel,