UserService::getHostGuildAccess() - Code Metrics - Inspection of "Fix guest invite deletion." - lagdo/tontine - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 44c26a...0f42fc )

by Thierry

created 2025-08-05 11:31 UTC

UserService::getHostGuildAccess() A

↳ Parent: UserService

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	2
nc	2
nop	2
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Siak\Tontine\Service\Guild;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Siak\Tontine\Exception\MessageException;
use Siak\Tontine\Model\GuestInvite;
use Siak\Tontine\Model\Guild;
use Siak\Tontine\Model\User;
use Siak\Tontine\Service\TenantService;

use function count;
use function now;

class UserService
{
    /**
     * @param TenantService $tenantService
     */
    public function __construct(protected TenantService $tenantService)
    {}

    /**
     * Get a paginated list of invites sent.
     *
     * @param User $user
     * @param int $page
     *
     * @return Collection
     */
    public function getHostInvites(User $user, int $page = 0): Collection
    {
        return $user->host_invites()
            ->page($page, $this->tenantService->getLimit())
            ->orderByDesc('created_at')
            ->get();
    }

    /**
     * Get the number of members.
     *
     * @param User $user
     *
     * @return int
     */
    public function getHostInviteCount(User $user): int
    {
        return $user->host_invites()->count();
    }

    /**
     * Get a paginated list of invites received.
     *
     * @param User $user
     * @param int $page
     *
     * @return Collection
     */
    public function getGuestInvites(User $user, int $page = 0): Collection
    {
        return $user->guest_invites()
            ->page($page, $this->tenantService->getLimit())
            ->orderByDesc('created_at')
            ->get();
    }

    /**
     * Get the number of invites.
     *
     * @param User $user
     *
     * @return int
     */
    public function getGuestInviteCount(User $user): int
    {
        return $user->guest_invites()->count();
    }

    /**
     * Find an invite.
     *
     * @param User $user
     * @param int $inviteId
     *
     * @return GuestInvite|null
     */
    public function getHostInvite(User $user, int $inviteId): ?GuestInvite
    {
        return $user->host_invites()->find($inviteId);
    }

    /**
     * Find an invite.
     *
     * @param User $user
     * @param int $inviteId
     *
     * @return GuestInvite|null
     */
    public function getGuestInvite(User $user, int $inviteId): ?GuestInvite
    {
        return $user->guest_invites()->find($inviteId);
    }

    /**
     * Create an invite.
     *
     * @param User $host
     * @param string $guestEmail
     *
     * @return void
     */
    public function createInvite(User $host, string $guestEmail)
    {
        // The current user is the host.
        $guest = User::where('email', $guestEmail)
            ->with('guest_invites', fn($query) => $query->where('host_id', $host->id))
            ->first();
        if(!$guest)
        {
            throw new MessageException(trans('tontine.invite.errors.user_not_found'));
        }
        if($guest->id === $host->id || $guest->guest_invites->count() > 0)
        {
            throw new MessageException(trans('tontine.invite.errors.cannot_invite'));
        }

        $invite = new GuestInvite();
        $invite->status = GuestInvite::STATUS_PENDING;
        $invite->active = true;
        // One week validity by default.
        $invite->expires_at = now()->addWeek();
        $invite->host()->associate($host);
        $invite->guest()->associate($guest);
        $invite->save();
    }

    /**
     * Accept an invite.
     *
     * @param User $user
     * @param int $inviteId
     *
     * @return void
     */
    public function acceptInvite(User $user, int $inviteId)
    {
        if(!($invite = $this->getGuestInvite($user, $inviteId)))
        {
            throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
        }
        if($invite->is_expired)

        {
            throw new MessageException(trans('tontine.invite.errors.invite_expired'));
        }
        if(!$invite->is_pending)

        {
            throw new MessageException(trans('tontine.invite.errors.not_allowed'));
        }
        $invite->update(['status' => GuestInvite::STATUS_ACCEPTED]);
    }

    /**
     * Refuse an invite.
     *
     * @param User $user
     * @param int $inviteId
     *
     * @return void
     */
    public function refuseInvite(User $user, int $inviteId)
    {
        if(!($invite = $this->getGuestInvite($user, $inviteId)))
        {
            throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
        }
        if($invite->is_expired)

        {
            throw new MessageException(trans('tontine.invite.errors.invite_expired'));
        }
        if(!$invite->is_pending)

        {
            throw new MessageException(trans('tontine.invite.errors.not_allowed'));
        }
        $invite->update(['status' => GuestInvite::STATUS_REFUSED]);
    }

    /**
     * Cancel an invite.
     *
     * @param User $user
     * @param int $inviteId
     *
     * @return void
     */
    public function cancelInvite(User $user, int $inviteId)
    {
        if(!($invite = $this->getHostInvite($user, $inviteId)))
        {
            throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
        }
        if($invite->is_expired)

        {
            throw new MessageException(trans('tontine.invite.errors.invite_expired'));
        }
        if(!$invite->is_pending)

        {
            throw new MessageException(trans('tontine.invite.errors.not_allowed'));
        }
        $invite->update(['status' => GuestInvite::STATUS_CANCELLED]);
    }

    /**
     * Delete an invite.
     *
     * @param GuestInvite $invite
     *
     * @return void
     */
    private function deleteInvite(GuestInvite $invite)
    {
        DB::transaction(function() use($invite) {
            DB::table('guest_options')->where('invite_id', $invite->id)->delete();
            $invite->delete();
        });
    }

    /**
     * Delete an invite.
     *
     * @param User $user
     * @param int $inviteId
     *
     * @return void
     */
    public function deleteHostInvite(User $user, int $inviteId)
    {
        if(!($invite = $this->getHostInvite($user, $inviteId)))
        {
            throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
        }

        $this->deleteInvite($invite);
    }

    /**
     * Delete an invite.
     *
     * @param User $user
     * @param int $inviteId
     *
     * @return void
     */
    public function deleteGuestInvite(User $user, int $inviteId)
    {
        if(!($invite = $this->getGuestInvite($user, $inviteId)))
        {
            throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
        }

        $this->deleteInvite($invite);
    }

    /**
     * Delete an invite.
     *
     * @param Guild $guild
     * @param int $inviteId
     *
     * @return bool
     */
    public function guildBelongsToInvite(Guild $guild, int $inviteId): bool
    {
        return DB::table('guest_options')
            ->where('guild_id', $guild->id)
            ->where('invite_id', $inviteId)
            ->exists();
    }

    /**
     * Get the guest access on a given guild
     *
     * @param GuestInvite $invite
     * @param Guild $guild
     *
     * @return array
     */
    public function getHostGuildAccess(GuestInvite $invite, Guild $guild): array
    {
        $inviteTontine = $invite->guilds()->find($guild->id);
        return !$inviteTontine ? [] : $inviteTontine->options->access;
    }

    /**
     * Get the guest access on a given guild
     *
     * @param GuestInvite $invite
     * @param Guild $guild
     * @param array $access
     *
     * @return void
     */
    public function saveHostGuildAccess(GuestInvite $invite, Guild $guild, array $access)
    {
        DB::transaction(function() use($invite, $guild, $access) {
            $invite->guilds()->detach($guild->id);
            if(count($access) > 0)
            {
                $invite->guilds()->attach($guild->id, ['access' => $access]);
            }
        });
    }
}


1			<?php
2
3			namespace Siak\Tontine\Service\Guild;
4
5			use Illuminate\Support\Collection;
6			use Illuminate\Support\Facades\DB;
7			use Siak\Tontine\Exception\MessageException;
8			use Siak\Tontine\Model\GuestInvite;
9			use Siak\Tontine\Model\Guild;
10			use Siak\Tontine\Model\User;
11			use Siak\Tontine\Service\TenantService;
12
13			use function count;
14			use function now;
15
16			class UserService
17			{
18			/**
19			* @param TenantService $tenantService
20			*/
21			public function __construct(protected TenantService $tenantService)
22			{}
23
24			/**
25			* Get a paginated list of invites sent.
26			*
27			* @param User $user
28			* @param int $page
29			*
30			* @return Collection
31			*/
32			public function getHostInvites(User $user, int $page = 0): Collection
33			{
34			return $user->host_invites()
35			->page($page, $this->tenantService->getLimit())
36			->orderByDesc('created_at')
37			->get();
38			}
39
40			/**
41			* Get the number of members.
42			*
43			* @param User $user
44			*
45			* @return int
46			*/
47			public function getHostInviteCount(User $user): int
48			{
49			return $user->host_invites()->count();
50			}
51
52			/**
53			* Get a paginated list of invites received.
54			*
55			* @param User $user
56			* @param int $page
57			*
58			* @return Collection
59			*/
60			public function getGuestInvites(User $user, int $page = 0): Collection
61			{
62			return $user->guest_invites()
63			->page($page, $this->tenantService->getLimit())
64			->orderByDesc('created_at')
65			->get();
66			}
67
68			/**
69			* Get the number of invites.
70			*
71			* @param User $user
72			*
73			* @return int
74			*/
75			public function getGuestInviteCount(User $user): int
76			{
77			return $user->guest_invites()->count();
78			}
79
80			/**
81			* Find an invite.
82			*
83			* @param User $user
84			* @param int $inviteId
85			*
86			* @return GuestInvite\|null
87			*/
88			public function getHostInvite(User $user, int $inviteId): ?GuestInvite
89			{
90			return $user->host_invites()->find($inviteId);
91			}
92
93			/**
94			* Find an invite.
95			*
96			* @param User $user
97			* @param int $inviteId
98			*
99			* @return GuestInvite\|null
100			*/
101			public function getGuestInvite(User $user, int $inviteId): ?GuestInvite
102			{
103			return $user->guest_invites()->find($inviteId);
104			}
105
106			/**
107			* Create an invite.
108			*
109			* @param User $host
110			* @param string $guestEmail
111			*
112			* @return void
113			*/
114			public function createInvite(User $host, string $guestEmail)
115			{
116			// The current user is the host.
117			$guest = User::where('email', $guestEmail)
118			->with('guest_invites', fn($query) => $query->where('host_id', $host->id))
119			->first();
120			if(!$guest)
121			{
122			throw new MessageException(trans('tontine.invite.errors.user_not_found'));
123			}
124			if($guest->id === $host->id \|\| $guest->guest_invites->count() > 0)
125			{
126			throw new MessageException(trans('tontine.invite.errors.cannot_invite'));
127			}
128
129			$invite = new GuestInvite();
130			$invite->status = GuestInvite::STATUS_PENDING;
131			$invite->active = true;
132			// One week validity by default.
133			$invite->expires_at = now()->addWeek();
134			$invite->host()->associate($host);
135			$invite->guest()->associate($guest);
136			$invite->save();
137			}
138
139			/**
140			* Accept an invite.
141			*
142			* @param User $user
143			* @param int $inviteId
144			*
145			* @return void
146			*/
147			public function acceptInvite(User $user, int $inviteId)
148			{
149			if(!($invite = $this->getGuestInvite($user, $inviteId)))
150			{
151			throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
152			}
153			if($invite->is_expired)
			0 ignored issues – show Bug introduced 2024-01-29 11:47 UTC by Report Bug Copy Issue Report The property `is_expired` does not seem to exist on `Siak\Tontine\Model\GuestInvite`. Are you sure there is no database migration missing? Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct. Loading history...
154			{
155			throw new MessageException(trans('tontine.invite.errors.invite_expired'));
156			}
157			if(!$invite->is_pending)
			0 ignored issues – show Bug introduced 2024-01-29 11:47 UTC by Report Bug Copy Issue Report The property `is_pending` does not seem to exist on `Siak\Tontine\Model\GuestInvite`. Are you sure there is no database migration missing? Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct. Loading history...
158			{
159			throw new MessageException(trans('tontine.invite.errors.not_allowed'));
160			}
161			$invite->update(['status' => GuestInvite::STATUS_ACCEPTED]);
162			}
163
164			/**
165			* Refuse an invite.
166			*
167			* @param User $user
168			* @param int $inviteId
169			*
170			* @return void
171			*/
172			public function refuseInvite(User $user, int $inviteId)
173			{
174			if(!($invite = $this->getGuestInvite($user, $inviteId)))
175			{
176			throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
177			}
178			if($invite->is_expired)
			0 ignored issues – show Bug introduced 2024-01-29 11:47 UTC by Report Bug Copy Issue Report The property `is_expired` does not seem to exist on `Siak\Tontine\Model\GuestInvite`. Are you sure there is no database migration missing? Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct. Loading history...
179			{
180			throw new MessageException(trans('tontine.invite.errors.invite_expired'));
181			}
182			if(!$invite->is_pending)
			0 ignored issues – show Bug introduced 2024-01-29 11:47 UTC by Report Bug Copy Issue Report The property `is_pending` does not seem to exist on `Siak\Tontine\Model\GuestInvite`. Are you sure there is no database migration missing? Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct. Loading history...
183			{
184			throw new MessageException(trans('tontine.invite.errors.not_allowed'));
185			}
186			$invite->update(['status' => GuestInvite::STATUS_REFUSED]);
187			}
188
189			/**
190			* Cancel an invite.
191			*
192			* @param User $user
193			* @param int $inviteId
194			*
195			* @return void
196			*/
197			public function cancelInvite(User $user, int $inviteId)
198			{
199			if(!($invite = $this->getHostInvite($user, $inviteId)))
200			{
201			throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
202			}
203			if($invite->is_expired)
			0 ignored issues – show Bug introduced 2024-01-29 11:47 UTC by Report Bug Copy Issue Report The property `is_expired` does not seem to exist on `Siak\Tontine\Model\GuestInvite`. Are you sure there is no database migration missing? Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct. Loading history...
204			{
205			throw new MessageException(trans('tontine.invite.errors.invite_expired'));
206			}
207			if(!$invite->is_pending)
			0 ignored issues – show Bug introduced 2024-01-29 11:47 UTC by Report Bug Copy Issue Report The property `is_pending` does not seem to exist on `Siak\Tontine\Model\GuestInvite`. Are you sure there is no database migration missing? Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct. Loading history...
208			{
209			throw new MessageException(trans('tontine.invite.errors.not_allowed'));
210			}
211			$invite->update(['status' => GuestInvite::STATUS_CANCELLED]);
212			}
213
214			/**
215			* Delete an invite.
216			*
217			* @param GuestInvite $invite
218			*
219			* @return void
220			*/
221			private function deleteInvite(GuestInvite $invite)
222			{
223			DB::transaction(function() use($invite) {
224			DB::table('guest_options')->where('invite_id', $invite->id)->delete();
225			$invite->delete();
226			});
227			}
228
229			/**
230			* Delete an invite.
231			*
232			* @param User $user
233			* @param int $inviteId
234			*
235			* @return void
236			*/
237			public function deleteHostInvite(User $user, int $inviteId)
238			{
239			if(!($invite = $this->getHostInvite($user, $inviteId)))
240			{
241			throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
242			}
243
244			$this->deleteInvite($invite);
245			}
246
247			/**
248			* Delete an invite.
249			*
250			* @param User $user
251			* @param int $inviteId
252			*
253			* @return void
254			*/
255			public function deleteGuestInvite(User $user, int $inviteId)
256			{
257			if(!($invite = $this->getGuestInvite($user, $inviteId)))
258			{
259			throw new MessageException(trans('tontine.invite.errors.invite_not_found'));
260			}
261
262			$this->deleteInvite($invite);
263			}
264
265			/**
266			* Delete an invite.
267			*
268			* @param Guild $guild
269			* @param int $inviteId
270			*
271			* @return bool
272			*/
273			public function guildBelongsToInvite(Guild $guild, int $inviteId): bool
274			{
275			return DB::table('guest_options')
276			->where('guild_id', $guild->id)
277			->where('invite_id', $inviteId)
278			->exists();
279			}
280
281			/**
282			* Get the guest access on a given guild
283			*
284			* @param GuestInvite $invite
285			* @param Guild $guild
286			*
287			* @return array
288			*/
289			public function getHostGuildAccess(GuestInvite $invite, Guild $guild): array
290			{
291			$inviteTontine = $invite->guilds()->find($guild->id);
292			return !$inviteTontine ? [] : $inviteTontine->options->access;
293			}
294
295			/**
296			* Get the guest access on a given guild
297			*
298			* @param GuestInvite $invite
299			* @param Guild $guild
300			* @param array $access
301			*
302			* @return void
303			*/
304			public function saveHostGuildAccess(GuestInvite $invite, Guild $guild, array $access)
305			{
306			DB::transaction(function() use($invite, $guild, $access) {
307			$invite->guilds()->detach($guild->id);
308			if(count($access) > 0)
309			{
310			$invite->guilds()->attach($guild->id, ['access' => $access]);
311			}
312			});
313			}
314			}
315

lagdo / tontine

Push — main ( 44c26a...0f42fc )

UserService::getHostGuildAccess() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like