-
Notifications
You must be signed in to change notification settings - Fork 237
/
Guild.php
394 lines (346 loc) · 11.2 KB
/
Guild.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
<?php
/*
* This file is apart of the DiscordPHP project.
*
* Copyright (c) 2016-2020 David Cole <david.cole1340@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the LICENSE.md file.
*/
namespace Discord\Parts\Guild;
use Carbon\Carbon;
use Discord\Parts\Part;
use Discord\Parts\User\Member;
use Discord\Repository\Guild as Repository;
use Illuminate\Support\Collection;
use React\Promise\Deferred;
/**
* A Guild is Discord's equivalent of a server. It contains all the Members, Channels, Roles, Bans etc.
*
* @property string $id The unique identifier of the guild.
* @property string $name The name of the guild.
* @property string $icon The URL to the guild icon.
* @property string $icon_hash The icon hash for the guild.
* @property string $region The region the guild's voice channels are hosted in.
* @property \Discord\Parts\User\User $owner The owner of the guild.
* @property string $owner_id The unique identifier of the owner of the guild.
* @property Carbon $joined_at A timestamp of when the current user joined the guild.
* @property string $afk_channel_id The unique identifier of the AFK channel ID.
* @property int $afk_timeout How long you will remain in the voice channel until you are moved into the AFK channel.
* @property bool $embed_enabled Whether the embed is enabled.
* @property string $embed_channel_id The unique identifier of the channel that will be used for the embed.
* @property array[string] $features An array of features that the guild has.
* @property string $splash The URL to the guild splash.
* @property string $splash_hash The splash hash for the guild.
* @property bool $large Whether the guild is considered 'large' (over 250 members).
* @property int $verification_level The verification level used for the guild.
* @property int $member_count How many members are in the guild.
* @property \Discord\Repository\Guild\RoleRepository $roles
* @property \Discord\Repository\Guild\ChannelRepository $channels
* @property \Discord\Repository\Guild\MemberRepository $members
* @property \Discord\Repository\Guild\InviteRepository $invites
* @property \Discord\Repository\Guild\BanRepository $bans
* @property \Discord\Repository\Guild\EmojiRepository $emojis
*/
class Guild extends Part
{
const REGION_DEFAULT = 'us_west';
/**
* The 'off' verification level.
*
* @var int Raw verification level.
*/
const LEVEL_OFF = 0;
/**
* The 'low' verification level.
*
* Members must have a verified email before they can message.
*
* @var int Raw verification level.
*/
const LEVEL_LOW = 1;
/**
* The 'medium' verification level.
*
* Members must also be registered on Discord for more than 5 minutes.
*
* @var int Raw verification level.
*/
const LEVEL_MEDIUM = 2;
/**
* The 'tableflip' verification level.
*
* Members must also be a member of the guild for more than 10 minutes.
*
* @var int Raw verification level.
*/
const LEVEL_TABLEFLIP = 3;
/**
* {@inheritdoc}
*/
protected $fillable = [
'id',
'name',
'icon',
'region',
'owner_id',
'roles',
'joined_at',
'afk_channel_id',
'afk_timeout',
'embed_enabled',
'embed_channel_id',
'features',
'splash',
'emojis',
'large',
'verification_level',
'member_count',
];
/**
* {@inheritdoc}
*/
protected $repositories = [
'members' => Repository\MemberRepository::class,
'roles' => Repository\RoleRepository::class,
'channels' => Repository\ChannelRepository::class,
'bans' => Repository\BanRepository::class,
'invites' => Repository\InviteRepository::class,
'emojis' => Repository\EmojiRepository::class,
];
/**
* An array of valid regions.
*
* @var Collection|null
*/
protected $regions;
/**
* Gets the voice regions available.
*
* @return \React\Promise\Promise
*/
public function getVoiceRegions()
{
$deferred = new Deferred();
$this->http->get('voice/regions')->then(function ($regions) use ($deferred) {
$regions = new Collection($regions);
$this->regions = $regions;
$deferred->resolve($regions);
}, \React\Partial\bind([$deferred, 'reject']));
return $deferred->promise();
}
/**
* Creates a role.
*
* @param array $data The data to fill the role with.
*
* @return \React\Promise\Promise
*/
public function createRole(array $data = [])
{
$deferred = new Deferred();
$rolePart = $this->factory->create(Role::class);
$this->roles->save($rolePart)->then(
function ($role) use ($deferred, $data) {
$role->fill($data);
$this->roles->save($role)->then(
function ($role) use ($deferred) {
$deferred->resolve($role);
},
\React\Partial\bind([$deferred, 'reject'])
);
},
\React\Partial\bind([$deferred, 'reject'])
);
return $deferred->promise();
}
/**
* Transfers ownership of the guild to
* another member.
*
* @param Member|int $member The member to transfer ownership to.
*
* @return \React\Promise\Promise
*/
public function transferOwnership($member)
{
$deferred = new Deferred();
if ($member instanceof Member) {
$member = $member->id;
}
$this->http->patch(
$this->replaceWithVariables('guilds/:id'),
[
'owner_id' => $member,
]
)->then(
function ($response) use ($member, $deferred) {
if ($response->owner_id != $member) {
$deferred->reject(new \Exception('Ownership was not transferred correctly.'));
$this->fill((array) $response);
} else {
$deferred->resolve();
}
},
\React\Partial\bind([$deferred, 'reject'])
);
return $deferred->promise();
}
/**
* Returns the channels invites.
*
* @return \React\Promise\Promise
*/
public function getInvites()
{
$deferred = new Deferred();
$this->http->get($this->replaceWithVariables('guilds/:id/invites'))->then(
function ($response) use ($deferred) {
$invites = new Collection();
foreach ($response as $invite) {
$invite = $this->factory->create(Invite::class, $invite, true);
$invites->push($invite);
}
$deferred->resolve($invites);
},
\React\Partial\bind([$deferred, 'reject'])
);
return $deferred->promise();
}
/**
* Returns the owner.
*
* @return \React\Promise\Promise
*/
public function getOwnerAttribute()
{
return $this->discord->users->get('id', $this->owner_id);
}
/**
* Returns the joined_at attribute.
*
* @return Carbon|null The joined_at attribute.
*/
public function getJoinedAtAttribute()
{
if (! array_key_exists('joined_at', $this->attributes)) {
return;
}
return new Carbon($this->attributes['joined_at']);
}
/**
* Returns the guilds icon.
*
* @param string $format The image format.
* @param int $size The size of the image.
*
* @return string|null The URL to the guild icon or null.
*/
public function getIconAttribute($format = 'jpg', $size = 1024)
{
if (is_null($this->attributes['icon'])) {
return;
}
if (false === array_search($format, ['png', 'jpg', 'webp'])) {
$format = 'jpg';
}
return "https://cdn.discordapp.com/icons/{$this->id}/{$this->attributes['icon']}.{$format}?size={$size}";
}
/**
* Returns the guild icon hash.
*
* @return string|null The guild icon hash or null.
*/
public function getIconHashAttribute()
{
return $this->attributes['icon'];
}
/**
* Returns the guild splash.
*
* @param string $format The image format.
* @param int $size The size of the image.
*
* @return string|null The URL to the guild splash or null.
*/
public function getSplashAttribute($format = 'jpg', $size = 2048)
{
if (is_null($this->attributes['splash'])) {
return;
}
if (false === array_search($format, ['png', 'jpg', 'webp'])) {
$format = 'jpg';
}
return "https://cdn.discordapp.com/slashes/{$this->id}/{$this->attributes['splash']}.{$format}?size={$size}";
}
/**
* Returns the guild splash hash.
*
* @return string|null The guild splash hash or null.
*/
public function getSplashHashAttribute()
{
return $this->attributes['splash'];
}
/**
* Validates the specified region.
*
* @return \React\Promise\Promise
*
* @see self::REGION_DEFAULT The default region.
*/
public function validateRegion()
{
$deferred = new Deferred();
$validate = function () use ($deferred) {
$regions = $this->regions->map(function ($region) {
return $region->id;
})->toArray();
if (! in_array($this->region, $regions)) {
$deferred->resolve(self::REGION_DEFAULT);
} else {
$deferred->resolve($this->region);
}
};
if (! is_null($this->regions)) {
$validate();
} else {
$this->getVoiceRegions()->then($validate, \React\Partial\bind([$deferred, 'reject']));
}
return $deferred->promise();
}
/**
* {@inheritdoc}
*/
public function getCreatableAttributes()
{
return [
'name' => $this->name,
'region' => $this->region,
];
}
/**
* {@inheritdoc}
*/
public function getUpdatableAttributes()
{
return [
'name' => $this->name,
'region' => $this->region,
'logo' => $this->logo,
'splash' => $this->splash,
'verification_level' => $this->verification_level,
'afk_channel_id' => $this->afk_channel_id,
'afk_timeout' => $this->afk_timeout,
];
}
/**
* {@inheritdoc}
*/
public function getRepositoryAttributes()
{
return [
'guild_id' => $this->id,
];
}
}