1. interface
  2. CharlotteDunois
  3. \
  4. Yasmin
  5. \
  6. Interfaces
  7. \
  8. UserStorageInterface

UserStorageInterface

interface UserStorageInterface implements StorageInterface (View source)

Something all user storages implement. The storage also is used as factory.

Methods

mixed
current()

Returns the current element. From Iterator interface.

mixed
key()

Fetch the key from the current element. From Iterator interface.

mixed|false
next()

Advances the internal pointer. From Iterator interface.

mixed|false
rewind()

Resets the internal pointer. From Iterator interface.

bool
valid()

Checks if current position is valid. From Iterator interface.

mixed[]
all()

Returns all items.

int
count()

Returns the total number of items. From Countable interface.

from StorageInterface
StorageInterface
copy()

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

from StorageInterface
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.

from StorageInterface
$this
clear()

Clears the Storage.

from StorageInterface
int|null
indexOf(mixed $value)

Returns the position of the given value in the storage. Returns null if the given value couldn't be found.

from StorageInterface
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 StorageInterface
mixed|null
first(callable|null $closure = null)

Returns the first element that passes a given truth test.

from StorageInterface
mixed|null
last(callable|null $closure = null)

Returns the last element that passes a given truth test.

from StorageInterface
mixed|null|void
reduce(callable $closure, mixed|null $carry = null)

Reduces the collection to a single value, passing the result of each iteration into the subsequent iteration.

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

Sorts the collection. Returns a new Storage instance.

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

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

from StorageInterface
Collection
sortCustom(callable $closure)

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

from StorageInterface
Collection
sortCustomKey(callable $closure)

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

from StorageInterface
int
max(mixed $key = '')

Return the maximum value of a given key.

from StorageInterface
int
min(mixed|null $key = null)

Return the minimum value of a given key.

from StorageInterface
User
resolve(User|GuildMember|string|int $user)

Resolves given data to an user.

User|null
patch(array $user)

Patches an user (retrieves the user if the user exists), returns null if only the ID is in the array, or creates an user.

User
factory(array $data, bool $userFetched = false)

Factory to create (or retrieve existing) users.

Details

at line 20
mixed current()

Returns the current element. From Iterator interface.

Return Value

mixed

at line 26
mixed key()

Fetch the key from the current element. From Iterator interface.

Return Value

mixed

at line 32
mixed|false next()

Advances the internal pointer. From Iterator interface.

Return Value

mixed|false

at line 38
mixed|false rewind()

Resets the internal pointer. From Iterator interface.

Return Value

mixed|false

at line 44
bool valid()

Checks if current position is valid. From Iterator interface.

Return Value

bool

at line 50
mixed[] all()

Returns all items.

Return Value

mixed[]

in StorageInterface at line 56
int count()

Returns the total number of items. From Countable interface.

Return Value

int

in StorageInterface at line 62
StorageInterface copy()

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

Return Value

StorageInterface

at line 73
bool has(mixed $key)

Determines if a given key exists in the collection.

Parameters

mixed $key

Return Value

bool

Exceptions

InvalidArgumentException

at line 81
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 90
$this set(mixed $key, mixed $value)

Sets a key-value pair.

Parameters

mixed $key
mixed $value

Return Value

$this

Exceptions

InvalidArgumentException

in StorageInterface at line 94
$this delete(mixed $key)

Removes an item.

Parameters

mixed $key

Return Value

$this

in StorageInterface at line 100
$this clear()

Clears the Storage.

Return Value

$this

in StorageInterface at line 107
int|null indexOf(mixed $value)

Returns the position of the given value in the storage. Returns null if the given value couldn't be found.

Parameters

mixed $value

Return Value

int|null

in StorageInterface at line 114
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 StorageInterface at line 121
mixed|null first(callable|null $closure = null)

Returns the first element that passes a given truth test.

Parameters

callable|null $closure

Return Value

mixed|null

in StorageInterface at line 128
mixed|null last(callable|null $closure = null)

Returns the last element that passes a given truth test.

Parameters

callable|null $closure

Return Value

mixed|null

in StorageInterface at line 136
mixed|null|void reduce(callable $closure, mixed|null $carry = null)

Reduces the collection to a single value, passing the result of each iteration into the subsequent iteration.

Parameters

callable $closure
mixed|null $carry

Return Value

mixed|null|void

in StorageInterface at line 143
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 StorageInterface at line 151
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 StorageInterface at line 158
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 StorageInterface at line 165
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

in StorageInterface at line 172
int max(mixed $key = '')

Return the maximum value of a given key.

Parameters

mixed $key

Return Value

int

in StorageInterface at line 179
int min(mixed|null $key = null)

Return the minimum value of a given key.

Parameters

mixed|null $key

Return Value

int

at line 58
User resolve(User|GuildMember|string|int $user)

Resolves given data to an user.

Parameters

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

Return Value

User

Exceptions

InvalidArgumentException

at line 65
User|null patch(array $user)

Patches an user (retrieves the user if the user exists), returns null if only the ID is in the array, or creates an user.

Parameters

array $user

Return Value

User|null

at line 99
User factory(array $data, bool $userFetched = false)

Factory to create (or retrieve existing) users.

Parameters

array $data
bool $userFetched

Return Value

User