lagdo / tontine

src/Service/Guild/GuildService.php

<?php

namespace Siak\Tontine\Service\Guild;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Siak\Tontine\Model\FundDef;
use Siak\Tontine\Model\Guild;
use Siak\Tontine\Model\User;
use Siak\Tontine\Service\TenantService;

use function config;
use function tap;

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

    /**
     * Get a paginated list of guilds in the selected round.
     *
     * @param User $user
     * @param int $page
     *
     * @return Collection
     */
    public function getGuilds(User $user, int $page = 0): Collection
    {
        return $user->guilds()
            ->page($page, $this->tenantService->getLimit())
            ->get();
    }

    /**
     * Get the number of guilds in the selected round.
     *
     * @param User $user
     *
     * @return int
     */
    public function getGuildCount(User $user): int
    {
        return $user->guilds()->count();
    }

    /**
     * Get a single guild.
     *
     * @param User $user
     * @param int $guildId    The guild id
     *
     * @return Guild|null
     */
    public function getGuild(User $user, int $guildId): ?Guild
    {
        return $user->guilds()->find($guildId);
    }

    /**
     * @param User $user
     *
     * @return Builder|Relation
     */
    public function getGuestGuildsQuery(User $user): Builder|Relation
    {
        return Guild::whereHas('invites', fn(Builder $query) =>

The expression return Siak\Tontine\Model\Guild::whereHas('invites', function(...) { /* ... */ }) could return the type Illuminate\Database\Eloquent\PendingHasThroughRelationship|Illuminate\Database\Query\Builder|Siak\Tontine\Model\Guild which is incompatible with the type-hinted return Illuminate\Database\Eloquent\Builder|Illuminate\Database\Eloquent\Relations\Relation. Consider adding an additional type-check to rule them out.

            $query->where('guest_id', $user->id));
    }

    /**
     * Check if the user has guest guilds
     *
     * @param User $user
     *
     * @return bool
     */
    public function hasGuestGuilds(User $user): bool
    {
        return $this->getGuestGuildsQuery($user)->exists();

The expression return $this->getGuestGuildsQuery($user)->exists() could return the type Illuminate\Database\Eloquent\Builder which is incompatible with the type-hinted return boolean. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get a paginated list of guest guilds.
     *
     * @param User $user
     * @param int $page
     *
     * @return Collection
     */
    public function getGuestGuilds(User $user, int $page = 0): Collection
    {
        return $this->getGuestGuildsQuery($user)
            ->with(['user'])
            ->orderBy('guilds.id')
            ->page($page, $this->tenantService->getLimit())
            ->get()
            ->each(fn($guild) => $guild->isGuest = true);
    }

    /**
     * Get the number of guest guilds.
     *
     * @param User $user
     *
     * @return int
     */
    public function getGuestGuildCount(User $user): int
    {
        return $this->getGuestGuildsQuery($user)->count();

The expression return $this->getGuestGuildsQuery($user)->count() could return the type Illuminate\Database\Eloquent\Builder which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get a single guild.
     *
     * @param User $user
     * @param int $guildId    The guild id
     *
     * @return Guild|null
     */
    public function getGuestGuild(User $user, int $guildId): ?Guild
    {
        return tap($this->getGuestGuildsQuery($user)->find($guildId), function($guild) {
            if($guild !== null)
            {
                $guild->isGuest = true;
            }
        });
    }

    /**
     * Get a single guild.
     *
     * @param User $user
     * @param int $guildId    The guild id
     *
     * @return Guild|null
     */
    public function getUserOrGuestGuild(User $user, int $guildId): ?Guild
    {
        return $this->getGuild($user, $guildId) ??
            $this->getGuestGuild($user, $guildId);
    }

    /**
     * @param User $user
     *
     * @return Guild|null
     */
    public function getFirstGuild(User $user): ?Guild
    {
        return $this->getGuilds($user)->first() ??
            $this->getGuestGuilds($user)->first();
    }

    /**
     * Add a new guild.
     *
     * @param User $user
     * @param array $values
     *
     * @return Guild|null
     */
    public function createGuild(User $user, array $values): ?Guild
    {
        return DB::transaction(function() use($user, $values) {
            $guild = $user->guilds()->create($values);
            // Also create the default savings fund for the new guild.
            $fund = $guild->funds()->create(['title' => '', 'active' => true]);
            $this->setDefaultFund($guild, $fund);
            return $guild;
        });
    }

    /**
     * Update a guild.
     *
     * @param User $user
     * @param int $guildId
     * @param array $values
     *
     * @return bool
     */
    public function updateGuild(User $user, int $guildId, array $values): bool
    {
        return $user->guilds()->where('id', $guildId)->update($values);
    }

    /**
     * Delete a guild.
     *
     * @param User $user
     * @param int $guildId
     *
     * @return void
     */
    public function deleteGuild(User $user, int $guildId)
    {
        $guild = $user->guilds()->find($guildId);
        if(!$guild)
        {
            return;
        }
        DB::transaction(function() use($guild) {
            $guild->funds()->delete();
            $guild->members()->delete();
            $guild->rounds()->delete();
            $guild->charges()->delete();
            $guild->categories()->delete();
            $guild->invites()->detach();
            $guild->delete();
        });
    }

    /**
     * Get the guild options
     *
     * @param Guild $guild
     *
     * @return array
     */
    public function getGuildOptions(Guild $guild): array
    {
        return $guild->properties;

The property properties does not seem to exist on Siak\Tontine\Model\Guild. Are you sure there is no database migration missing?

    }

    /**
     * Get the report template name
     *
     * @return string
     */
    public function getReportTemplate(Guild $guild): string
    {
        $options = $this->getGuildOptions($guild);
        return $options['reports']['template'] ??
            config('tontine.templates.report', 'default');
    }

    /**
     * Save the guild options
     *
     * @param Guild $guild
     * @param array $options
     *
     * @return void
     */
    public function saveGuildOptions(Guild $guild, array $options)
    {
        $properties = $guild->properties;

The property properties does not seem to exist on Siak\Tontine\Model\Guild. Are you sure there is no database migration missing?

        $properties['reports'] = $options['reports'];
        $guild->saveProperties($properties);
    }

    /**
     * Set the default fund
     *
     * @param Guild $guild
     * @param FundDef $fund
     *
     * @return void
     */
    public function setDefaultFund(Guild $guild, FundDef $fund): void
    {
        $properties = $guild->properties;

The property properties does not seem to exist on Siak\Tontine\Model\Guild. Are you sure there is no database migration missing?

        $properties['savings']['fund']['default'] = $fund->id;
        $guild->saveProperties($properties);
    }
}