Accept array of groups for user->isInGroup()

[chasegiunta]

I've found myself needing to verify if a user is in any of a set of groups to access certain pages, eg:

{% if currentUser.isInGroup('coachingStaff') or currentUser.isInGroup('teamAdmin') or currentUser.isInGroup('conferenceChair') %}

<!-- or the inverse -->

{% if not currentUser.isInGroup('coachingStaff') and not currentUser.isInGroup('teamAdmin') and not currentUser.isInGroup('conferenceChair') %}
  {% exit 403 %}
{% endif %}

I was hoping the isInGroup() function would accept an array:

{% if not currentUser.isInGroup(['coachingStaff', 'teamAdmin', 'conferenceChair']) %}

Our AI overlords recommended this change:

    /**
     * Returns whether the user is in a specific group or any of the provided groups.
     *
     * @param int|string|UserGroup|array $group The user group model, its handle, ID — or an array of those.
     * @return bool
     */
    public function isInGroup(UserGroup|int|string|array $group): bool
    {
        if (Craft::$app->edition < CmsEdition::Pro) {
            return false;
        }

        // Normalize to an array of group identifiers/models
        $groups = is_array($group) ? $group : [$group];

        foreach ($groups as $g) {
            $idOrHandle = $g;
            if ($g instanceof UserGroup) {
                $idOrHandle = $g->id;
            }

            if (is_numeric($idOrHandle)) {
                if (ArrayHelper::contains($this->getGroups(), fn(UserGroup $ug) => $ug->id == $idOrHandle)) {
                    return true;
                }
            } else {
                if (ArrayHelper::contains($this->getGroups(), fn(UserGroup $ug) => $ug->handle === $idOrHandle)) {
                    return true;
                }
            }
        }

        return false;
    }

I realize this could bring up a potential OR vs AND concern, which is why I didn't just PR this idea. I also realize this is a relatively minor DX improvement. Let me know it if feasible! Thanks

[brandonkelly]

Added a new isInGroups() method for Craft 5.9: 1965587

[chasegiunta]

Thank you!

[brandonkelly]

Craft 5.9.0 is out with that change 🎉