Invites

Class  ·  Sharkord\Collections\Invites

Class Invites

An array-accessible, iterable cache of Invite objects keyed by invite ID.

Examples

$invites = $sharkord->invites->collection();

foreach ($invites as $id => $invite) {
    echo "{$invite->code} — {$invite->uses} uses\n";
}

$invite = $invites->get(5);

echo count($invites) . " active invites\n";

Methods

__construct()

Invites constructor.

Parameters

Parameter	Type	Description
$sharkord	Sharkord	Reference to the main bot instance.

---

get()

Retrieves an invite by ID.

Parameters

Parameter	Type	Description
$id	int	The invite ID.

Returns \Invite|null — The cached Invite model, or null if not found.

---

all()

Returns all cached invites as an array.

Returns array<int,\Invite>

---

offsetExists()

Parameters

Parameter	Type	Description
$offset	mixed

Returns bool

---

offsetGet()

Parameters

Parameter	Type	Description
$offset	mixed

Returns ?Invite

---

offsetSet()

Parameters

Parameter	Type	Description
$offset	mixed
$value	mixed

Throws

• \LogicException

---

offsetUnset()

Parameters

Parameter	Type	Description
$offset	mixed

Throws

• \LogicException

---

count()

Returns int

---

getIterator()

Returns \ArrayIterator<int,\Invite>

---