InvoiceShelf/app/Domains/Accounts/Application/MemberService.php

<?php

namespace App\Domains\Accounts\Application;

use App\Domains\Accounts\Contracts\MemberReferencesCleaner;
use App\Domains\Accounts\Models\User;
use Illuminate\Support\Collection;
use Silber\Bouncer\BouncerFacade;

/**
 * Every write behind the member endpoints: filing a staff account, pointing it
 * at a set of companies, and erasing one outright.
 *
 * A submitted membership list is authoritative rather than additive — a company
 * left off the list is detached — and each entry names the single role the
 * account is to hold inside that company, displacing whatever it held there
 * before.
 *
 * Handing out a role means moving Bouncer's scope onto the company first. The
 * scope is left wherever the last company in the list put it; nothing here puts
 * it back. Kept as it stands.
 */
class MemberService
{
    public function __construct(
        private readonly MemberReferencesCleaner $memberReferencesCleaner,
    ) {}

    /**
     * File a new account and place it in the listed companies.
     *
     * Its language preference is written as the sentinel `default`, so the new
     * member reads the app in whatever language their company is set to rather
     * than in a frozen copy of the language whoever added them was using.
     *
     * @param  array<string, mixed>  $attributes
     * @param  iterable<int, array{id: int, role: string}>  $companies
     */
    public function create(array $attributes, iterable $companies): User
    {
        $member = User::create($attributes);

        $member->setSettings(['language' => 'default']);

        $memberships = collect($companies);

        $member->companies()->sync($memberships->pluck('id'));

        $this->grantRoles($member, $memberships);

        return $member;
    }

    /**
     * Overwrite an account and re-point it at the listed companies.
     *
     * Memberships are replaced wholesale, so an edit that omits a company both
     * detaches the account from it and leaves the roles it held there behind —
     * the role sync below only visits companies still on the list.
     *
     * @param  array<string, mixed>  $attributes
     * @param  iterable<int, array{id: int, role: string}>  $companies
     */
    public function update(User $user, array $attributes, iterable $companies): User
    {
        $user->update($attributes);

        $memberships = collect($companies);

        $user->companies()->sync($memberships->pluck('id'));

        $this->grantRoles($user, $memberships);

        return $user;
    }

    /**
     * Erase the named accounts, one after another.
     *
     * An id naming nobody is skipped rather than reported. Everything the
     * account authored outlives it: invoices, estimates, contacts, recurring
     * invoices, expenses, payments and catalog entries are left standing with
     * no author against them, and only the preferences rows and the account
     * itself actually go.
     *
     * @param  array<int, int|string>  $ids
     */
    public function delete(array $ids): bool
    {
        foreach ($ids as $id) {
            $member = User::find($id);

            if ($member === null) {
                continue;
            }

            $this->memberReferencesCleaner->clear($member);

            if ($member->settings()->exists()) {
                $member->settings()->delete();
            }

            $member->delete();
        }

        return true;
    }

    /**
     * Give the account exactly the one role each company named, discarding any
     * role it already held in that company.
     *
     * @param  Collection<int, array{id: int, role: string}>  $memberships
     */
    private function grantRoles(User $member, Collection $memberships): void
    {
        foreach ($memberships as $membership) {
            BouncerFacade::scope()->to($membership['id']);

            BouncerFacade::sync($member)->roles([$membership['role']]);
        }
    }
}