1. class
  2. CharlotteDunois
  3. \
  4. Yasmin
  5. \
  6. Models
  7. \
  8. GuildMemberStorage

GuildMemberStorage

class GuildMemberStorage extends Storage implements GuildMemberStorageInterface (View source)

Guild Member Storage to store guild members, utilizes Collection.

Properties

protected Client $client The client this storage belongs to. from Storage
protected array $baseStorageArgs Basic storage args. from Storage
protected Guild $guild The guild this storage belongs to.

Methods

__construct(Client $client, Guild $guild, array $data = null)

No description

bool
__isset(string $name)

No description

from Storage
string
__get(string $name)

No description

from Storage
bool
has(mixed $key)

Determines if a given key exists in the collection.

mixed|null
get(mixed $key)

Returns the item at a given key. If the key does not exist, null is returned.

$this
set(mixed $key, mixed $value)

Sets a key-value pair.

$this
delete(mixed $key)

Removes an item.

StorageInterface
copy()

Returns a copy of itself. This does not make a copy of the stored data.

from Storage
StorageInterface
filter(callable $closure)

Filters the storage by a given callback, keeping only those items that pass a given truth test. Returns a new Storage instance.

from Storage
StorageInterface
sort(bool $descending = false, int $options = \SORT_REGULAR)

Sorts the collection. Returns a new Storage instance.

from Storage
Collection
sortKey(bool $descending = false, int $options = \SORT_REGULAR)

Sorts the collection by key. Returns a new Storage instance.

from Storage
Collection
sortCustom(callable $closure)

Sorts the collection using a custom sorting function. Returns a new Storage instance.

from Storage
Collection
sortCustomKey(callable $closure)

Sorts the collection by key using a custom sorting function. Returns a new Storage instance.

from Storage
GuildMember
resolve(GuildMember|User|string|int $guildmember)

Resolves given data to a guildmember.

GuildMember
factory(array $data)

Factory to create (or retrieve existing) guild members.

Details

at line 25
__construct(Client $client, Guild $guild, array $data = null)

Parameters

Client $client
Guild $guild
array $data

in Storage at line 46
bool __isset(string $name)

Parameters

string $name

Return Value

bool

Exceptions

Exception

in Storage at line 64
string __get(string $name)

Parameters

string $name

Return Value

string

Exceptions

RuntimeException

at line 63
bool has(mixed $key)

Determines if a given key exists in the collection.

Parameters

mixed $key

Return Value

bool

Exceptions

InvalidArgumentException

at line 72
mixed|null get(mixed $key)

Returns the item at a given key. If the key does not exist, null is returned.

Parameters

mixed $key

Return Value

mixed|null

Exceptions

InvalidArgumentException

at line 82
$this set(mixed $key, mixed $value)

Sets a key-value pair.

Parameters

mixed $key
mixed $value

Return Value

$this

Exceptions

InvalidArgumentException

at line 92
$this delete(mixed $key)

Removes an item.

Parameters

mixed $key

Return Value

$this

in Storage at line 132
StorageInterface copy()

Returns a copy of itself. This does not make a copy of the stored data.

Return Value

StorageInterface

in Storage at line 144
StorageInterface filter(callable $closure)

Filters the storage by a given callback, keeping only those items that pass a given truth test. Returns a new Storage instance.

Parameters

callable $closure

Return Value

StorageInterface

in Storage at line 157
StorageInterface sort(bool $descending = false, int $options = \SORT_REGULAR)

Sorts the collection. Returns a new Storage instance.

Parameters

bool $descending
int $options

Return Value

StorageInterface

in Storage at line 170
Collection sortKey(bool $descending = false, int $options = \SORT_REGULAR)

Sorts the collection by key. Returns a new Storage instance.

Parameters

bool $descending
int $options

Return Value

Collection

in Storage at line 182
Collection sortCustom(callable $closure)

Sorts the collection using a custom sorting function. Returns a new Storage instance.

Parameters

callable $closure Callback specification: function ($a, $b): int

Return Value

Collection

in Storage at line 194
Collection sortCustomKey(callable $closure)

Sorts the collection by key using a custom sorting function. Returns a new Storage instance.

Parameters

callable $closure Callback specification: function ($a, $b): int

Return Value

Collection

at line 38
GuildMember resolve(GuildMember|User|string|int $guildmember)

Resolves given data to a guildmember.

Parameters

GuildMember|User|string|int $guildmember string/int = user ID

Return Value

GuildMember

Exceptions

InvalidArgumentException

at line 103
GuildMember factory(array $data)

Factory to create (or retrieve existing) guild members.

Parameters

array $data

Return Value

GuildMember