Categories

Class  ·  Sharkord\Collections\Categories

Class Categories

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

Examples

$category = $sharkord->categories->collection()->get(1);

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

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

Methods

__construct()

Categories constructor.

Parameters

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

---

get()

Retrieves a category by ID.

Parameters

Parameter	Type	Description
$id	`int	string`

Returns \Category|null

---

offsetExists()

Parameters

Parameter	Type	Description
$offset	mixed

Returns bool

---

offsetGet()

Parameters

Parameter	Type	Description
$offset	mixed

Returns ?Category

---

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,\Category>

---