Roles

Class  ·  Sharkord\Collections\Roles

Class Roles

An array-accessible, iterable cache of Role objects keyed by role ID (string).

Examples

$role = $sharkord->roles->collection()->get(1);

foreach ($sharkord->roles->collection() as $id => $role) {
    echo "{$role->name}\n";
}

echo count($sharkord->roles->collection());

Methods

__construct()

Roles constructor.

Parameters

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

---

get()

Retrieves a role by ID.

Parameters

Parameter	Type	Description
$id	`int	string`

Returns \Role|null

---

offsetExists()

Parameters

Parameter	Type	Description
$offset	mixed

Returns bool

---

offsetGet()

Parameters

Parameter	Type	Description
$offset	mixed

Returns ?Role

---

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<string,\Role>

---