SavingService::getSavingQuery() - Code Metrics - Inspection of "Added filter on savings in the meeting section." - lagdo/tontine - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( e5c1fd...5eb91d )

by Thierry

created 2024-01-02 20:56 UTC

SavingService::getSavingQuery() A

↳ Parent: SavingService

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	5
nc	1
nop	2
dl	0
loc	8
rs	10
c	1
b	0
f	0

<?php

namespace Siak\Tontine\Service\Meeting\Saving;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Siak\Tontine\Exception\MessageException;
use Siak\Tontine\Model\Saving;
use Siak\Tontine\Model\Member;
use Siak\Tontine\Model\Session;
use Siak\Tontine\Service\LocaleService;
use Siak\Tontine\Service\TenantService;
use Siak\Tontine\Service\Tontine\FundService;

use function trans;

class SavingService
{
    /**
     * @param LocaleService $localeService
     * @param TenantService $tenantService
     * @param FundService $fundService
     */
    public function __construct(private LocaleService $localeService,
        private TenantService $tenantService, private FundService $fundService)
    {}

    /**
     * @param Session $session
     * @param int $fundId
     *
     * @return mixed
     */
    private function getSavingQuery(Session $session, int $fundId)
    {
        return $session->savings()
            ->when($fundId === 0, function(Builder $query) {
                $query->whereNull('fund_id');
            })
            ->when($fundId > 0, function(Builder $query) use($fundId) {
                $query->where('fund_id', $fundId);
            });
    }

    /**
     * Count the savings for a given session.
     *
     * @param Session $session
     * @param int $fundId
     *
     * @return int
     */
    public function getSavingCount(Session $session, int $fundId): int
    {
        return $this->getSavingQuery($session, $fundId)->count();
    }

    /**
     * Get the savings for a given session.
     *
     * @param Session $session
     * @param int $fundId
     * @param int $page
     *
     * @return Collection
     */
    public function getSavings(Session $session, int $fundId, int $page = 0): Collection
    {
        return $this->getSavingQuery($session, $fundId)
            ->with(['member', 'fund'])
            ->page($page, $this->tenantService->getLimit())
            ->get();
    }

    /**
     * Get a saving for a given session.
     *
     * @param Session $session
     * @param int $savingId
     *
     * @return Saving|null
     */
    public function getSaving(Session $session, int $savingId): ?Saving
    {
        return $session->savings()->with(['member', 'fund'])->find($savingId);
    }

    /**
     * Create a saving.
     *
     * @param Member $member
     * @param Session $session The session
     * @param array $values
     *
     * @return void
     */
    public function createSaving(Member $member, Session $session, array $values): void
    {
        $saving = new Saving();
        $saving->amount = $values['amount'];
        $saving->member()->associate($member);
        $saving->session()->associate($session);
        if($values['fund_id'] !== 0)
        {
            $fund = $this->fundService->getFund($values['fund_id']);
            if($fund !== null)
            {
                $saving->fund()->associate($fund);
            }
        }
        $saving->save();
    }

    /**
     * Update a saving.
     *
     * @param Member $member
     * @param Session $session The session
     * @param array $values
     *
     * @return void
     */
    public function updateSaving(Member $member, Session $session, int $savingId, array $values): void
    {
        $saving = $session->savings()->find($savingId);
        if(!$saving)
        {
            throw new MessageException(trans('meeting.saving.errors.not_found'));
        }

        $saving->amount = $values['amount'];
        $saving->member()->associate($member);
        if($values['fund_id'] !== 0)
        {
            $fund = $this->fundService->getFund($values['fund_id']);
            if($fund !== null)
            {
                $saving->fund()->associate($fund);
            }
        }
        else
        {
            $saving->fund()->dissociate();
        }
        $saving->save();
    }

    /**
     * Delete a saving.
     *
     * @param Session $session The session
     * @param int $savingId
     *
     * @return void
     */
    public function deleteSaving(Session $session, int $savingId): void
    {
        $session->savings()->where('id', $savingId)->delete();
    }

    /**
     * Get all closings for a given fund.
     *
     * @param int $fundId
     *
     * @return array
     */
    public function getFundClosings(int $fundId): array
    {
        $closings = $this->tenantService->tontine()->properties['closings'] ?? [];

        $closings = Arr::where($closings, fn($closing) => isset($closing[$fundId]));
        return Arr::map($closings, fn($closing) => $closing[$fundId]);
    }

    /**
     * Save the given session as closing for the fund.
     *
     * @param Session $session
     * @param int $fundId
     * @param int $profitAmount
     *
     * @return void
     */
    public function saveFundClosing(Session $session, int $fundId, int $profitAmount)
    {
        $tontine = $this->tenantService->tontine();
        $properties = $tontine->properties;

        $properties['closings'][$session->id][$fundId] = $profitAmount;
        $tontine->saveProperties($properties);
    }

    /**
     * Check if the given session is closing the fund.
     *
     * @param Session $session
     * @param int $fundId
     *
     * @return bool
     */
    public function hasFundClosing(Session $session, int $fundId): bool
    {
        $properties = $this->tenantService->tontine()->properties;

        return isset($properties['closings'][$session->id][$fundId]);
    }

    /**
     * Set the given session as closing the fund.
     *
     * @param Session $session
     * @param int $fundId
     *
     * @return void
     */
    public function deleteFundClosing(Session $session, int $fundId)
    {
        $tontine = $this->tenantService->tontine();
        $properties = $tontine->properties;

        if(isset($properties['closings'][$session->id][$fundId]))
        {
            unset($properties['closings'][$session->id][$fundId]);
            if(count($properties['closings'][$session->id]) == 0)
            {
                unset($properties['closings'][$session->id]);
            }
        }
        $tontine->saveProperties($properties);
    }

    /**
     * Get the profit amount saved on a given session.
     *
     * @param Session $session
     * @param int $fundId
     *
     * @return int
     */
    public function getProfitAmount(Session $session, int $fundId): int
    {
        $tontine = $this->tenantService->tontine();
        return $tontine->properties['closings'][$session->id][$fundId] ?? 0;

    }

    /**
     * Get all the fund closings on a given session.
     *
     * @param Session $session
     *
     * @return array
     */
    public function getSessionClosings(Session $session): array
    {
        $tontine = $this->tenantService->tontine();
        return $tontine->properties['closings'][$session->id] ?? [];

    }
}


1			<?php
2
3			namespace Siak\Tontine\Service\Meeting\Saving;
4
5			use Illuminate\Database\Eloquent\Builder;
6			use Illuminate\Support\Arr;
7			use Illuminate\Support\Collection;
8			use Siak\Tontine\Exception\MessageException;
9			use Siak\Tontine\Model\Saving;
10			use Siak\Tontine\Model\Member;
11			use Siak\Tontine\Model\Session;
12			use Siak\Tontine\Service\LocaleService;
13			use Siak\Tontine\Service\TenantService;
14			use Siak\Tontine\Service\Tontine\FundService;
15
16			use function trans;
17
18			class SavingService
19			{
20			/**
21			* @param LocaleService $localeService
22			* @param TenantService $tenantService
23			* @param FundService $fundService
24			*/
25			public function __construct(private LocaleService $localeService,
26			private TenantService $tenantService, private FundService $fundService)
27			{}
28
29			/**
30			* @param Session $session
31			* @param int $fundId
32			*
33			* @return mixed
34			*/
35			private function getSavingQuery(Session $session, int $fundId)
36			{
37			return $session->savings()
38			->when($fundId === 0, function(Builder $query) {
39			$query->whereNull('fund_id');
40			})
41			->when($fundId > 0, function(Builder $query) use($fundId) {
42			$query->where('fund_id', $fundId);
43			});
44			}
45
46			/**
47			* Count the savings for a given session.
48			*
49			* @param Session $session
50			* @param int $fundId
51			*
52			* @return int
53			*/
54			public function getSavingCount(Session $session, int $fundId): int
55			{
56			return $this->getSavingQuery($session, $fundId)->count();
57			}
58
59			/**
60			* Get the savings for a given session.
61			*
62			* @param Session $session
63			* @param int $fundId
64			* @param int $page
65			*
66			* @return Collection
67			*/
68			public function getSavings(Session $session, int $fundId, int $page = 0): Collection
69			{
70			return $this->getSavingQuery($session, $fundId)
71			->with(['member', 'fund'])
72			->page($page, $this->tenantService->getLimit())
73			->get();
74			}
75
76			/**
77			* Get a saving for a given session.
78			*
79			* @param Session $session
80			* @param int $savingId
81			*
82			* @return Saving\|null
83			*/
84			public function getSaving(Session $session, int $savingId): ?Saving
85			{
86			return $session->savings()->with(['member', 'fund'])->find($savingId);
87			}
88
89			/**
90			* Create a saving.
91			*
92			* @param Member $member
93			* @param Session $session The session
94			* @param array $values
95			*
96			* @return void
97			*/
98			public function createSaving(Member $member, Session $session, array $values): void
99			{
100			$saving = new Saving();
101			$saving->amount = $values['amount'];
102			$saving->member()->associate($member);
103			$saving->session()->associate($session);
104			if($values['fund_id'] !== 0)
105			{
106			$fund = $this->fundService->getFund($values['fund_id']);
107			if($fund !== null)
108			{
109			$saving->fund()->associate($fund);
110			}
111			}
112			$saving->save();
113			}
114
115			/**
116			* Update a saving.
117			*
118			* @param Member $member
119			* @param Session $session The session
120			* @param array $values
121			*
122			* @return void
123			*/
124			public function updateSaving(Member $member, Session $session, int $savingId, array $values): void
125			{
126			$saving = $session->savings()->find($savingId);
127			if(!$saving)
128			{
129			throw new MessageException(trans('meeting.saving.errors.not_found'));
130			}
131
132			$saving->amount = $values['amount'];
133			$saving->member()->associate($member);
134			if($values['fund_id'] !== 0)
135			{
136			$fund = $this->fundService->getFund($values['fund_id']);
137			if($fund !== null)
138			{
139			$saving->fund()->associate($fund);
140			}
141			}
142			else
143			{
144			$saving->fund()->dissociate();
145			}
146			$saving->save();
147			}
148
149			/**
150			* Delete a saving.
151			*
152			* @param Session $session The session
153			* @param int $savingId
154			*
155			* @return void
156			*/
157			public function deleteSaving(Session $session, int $savingId): void
158			{
159			$session->savings()->where('id', $savingId)->delete();
160			}
161
162			/**
163			* Get all closings for a given fund.
164			*
165			* @param int $fundId
166			*
167			* @return array
168			*/
169			public function getFundClosings(int $fundId): array
170			{
171			$closings = $this->tenantService->tontine()->properties['closings'] ?? [];
			0 ignored issues – show Bug introduced 2023-12-13 13:06 UTC by Report Bug Copy Issue Report The property `properties` does not seem to exist on `Siak\Tontine\Model\Tontine`. 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...
172			$closings = Arr::where($closings, fn($closing) => isset($closing[$fundId]));
173			return Arr::map($closings, fn($closing) => $closing[$fundId]);
174			}
175
176			/**
177			* Save the given session as closing for the fund.
178			*
179			* @param Session $session
180			* @param int $fundId
181			* @param int $profitAmount
182			*
183			* @return void
184			*/
185			public function saveFundClosing(Session $session, int $fundId, int $profitAmount)
186			{
187			$tontine = $this->tenantService->tontine();
188			$properties = $tontine->properties;
			0 ignored issues – show Bug introduced 2023-12-13 13:06 UTC by Report Bug Copy Issue Report The property `properties` does not seem to exist on `Siak\Tontine\Model\Tontine`. 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...
189			$properties['closings'][$session->id][$fundId] = $profitAmount;
190			$tontine->saveProperties($properties);
191			}
192
193			/**
194			* Check if the given session is closing the fund.
195			*
196			* @param Session $session
197			* @param int $fundId
198			*
199			* @return bool
200			*/
201			public function hasFundClosing(Session $session, int $fundId): bool
202			{
203			$properties = $this->tenantService->tontine()->properties;
			0 ignored issues – show Bug introduced 2023-12-13 13:06 UTC by Report Bug Copy Issue Report The property `properties` does not seem to exist on `Siak\Tontine\Model\Tontine`. 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			return isset($properties['closings'][$session->id][$fundId]);
205			}
206
207			/**
208			* Set the given session as closing the fund.
209			*
210			* @param Session $session
211			* @param int $fundId
212			*
213			* @return void
214			*/
215			public function deleteFundClosing(Session $session, int $fundId)
216			{
217			$tontine = $this->tenantService->tontine();
218			$properties = $tontine->properties;
			0 ignored issues – show Bug introduced 2023-12-13 13:06 UTC by Report Bug Copy Issue Report The property `properties` does not seem to exist on `Siak\Tontine\Model\Tontine`. 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...
219			if(isset($properties['closings'][$session->id][$fundId]))
220			{
221			unset($properties['closings'][$session->id][$fundId]);
222			if(count($properties['closings'][$session->id]) == 0)
223			{
224			unset($properties['closings'][$session->id]);
225			}
226			}
227			$tontine->saveProperties($properties);
228			}
229
230			/**
231			* Get the profit amount saved on a given session.
232			*
233			* @param Session $session
234			* @param int $fundId
235			*
236			* @return int
237			*/
238			public function getProfitAmount(Session $session, int $fundId): int
239			{
240			$tontine = $this->tenantService->tontine();
241			return $tontine->properties['closings'][$session->id][$fundId] ?? 0;
			0 ignored issues – show Bug introduced 2023-12-13 13:06 UTC by Report Bug Copy Issue Report The property `properties` does not seem to exist on `Siak\Tontine\Model\Tontine`. 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...
242			}
243
244			/**
245			* Get all the fund closings on a given session.
246			*
247			* @param Session $session
248			*
249			* @return array
250			*/
251			public function getSessionClosings(Session $session): array
252			{
253			$tontine = $this->tenantService->tontine();
254			return $tontine->properties['closings'][$session->id] ?? [];
			0 ignored issues – show Bug introduced 2023-12-13 15:57 UTC by Report Bug Copy Issue Report The property `properties` does not seem to exist on `Siak\Tontine\Model\Tontine`. 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...
255			}
256			}
257

lagdo / tontine

Push — main ( e5c1fd...5eb91d )

SavingService::getSavingQuery() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like