Reactions

Class  ·  Sharkord\Collections\Reactions

Class Reactions

An array-accessible, iterable collection of reaction group objects keyed by emoji shortcode name.

Built from the raw reactions array on a Message, grouping individual reactions by their emoji so callers can work with them naturally.

Examples

$reactions = $message->reactions;

// Total number of distinct emoji types
echo count($reactions);

// Iterate over all emoji groups
foreach ($reactions as $emoji => $group) {
    echo ":{$emoji}: — {$group->count} reaction(s)\n";
    foreach ($group->users as $user) {
        echo "  {$user->name}\n";
    }
}

// Access a specific emoji group directly
if (isset($reactions['olive'])) {
    $group = $reactions['olive'];
    echo $group->count;
    echo $group->hasUser($sharkord->bot->id);
}

// Check whether the message has any reactions at all
if ($message->reactions->isEmpty()) {
    echo "No reactions yet.";
}

Methods

__construct()

Reactions constructor.

Parameters

Parameter	Type	Description
$sharkord	Sharkord	Reference to the main bot instance.
$rawReactions	array	The raw reactions array from the API payload.

---

emojis()

Returns all emoji shortcode names present on the message.

Returns string[]

---

isEmpty()

Returns true if the message has no reactions at all.

Returns bool

---

offsetExists()

Parameters

Parameter	Type	Description
$offset	mixed	The emoji shortcode name.

Returns bool

---

offsetGet()

Parameters

Parameter	Type	Description
$offset	mixed	The emoji shortcode name.

Returns \ReactionGroup|null

---

offsetSet()

Parameters

Parameter	Type	Description
$offset	mixed
$value	mixed

Throws

• \LogicException — Reaction collections are read-only.

---

offsetUnset()

Parameters

Parameter	Type	Description
$offset	mixed

Throws

• \LogicException — Reaction collections are read-only.

---

count()

Returns the number of distinct emoji types on the message.

Returns int

---

getIterator()

Returns \ArrayIterator<string,\Sharkord\Collections\Groups\Reactions>

---