RecurrenceUpdateRequest::getTransactionData() - Code Metrics - firefly-iii/firefly-iii - Measure and Improve Code Quality continuously with Scrutinizer

RecurrenceUpdateRequest::getTransactionData() A
last analyzed 2020-04-14 19:36 UTC

↳ Parent: RecurrenceUpdateRequest

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	7
c	0
b	0
f	0
dl	0
loc	15
rs	10
cc	3
nc	3
nop	0

<?php
/**
 * RecurrenceUpdateRequest.php
 * Copyright (c) 2019 [email protected]
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace FireflyIII\Api\V1\Requests;

use FireflyIII\Models\Recurrence;
use FireflyIII\Rules\BelongsUser;
use FireflyIII\Rules\IsBoolean;
use FireflyIII\Validation\CurrencyValidation;
use FireflyIII\Validation\RecurrenceValidation;
use FireflyIII\Validation\TransactionValidation;
use Illuminate\Validation\Validator;

/**
 * Class RecurrenceUpdateRequest
 */
class RecurrenceUpdateRequest extends Request
{
    use RecurrenceValidation, TransactionValidation, CurrencyValidation;


    /**
     * Authorize logged in users.
     *
     * @return bool
     */
    public function authorize(): bool
    {
        // Only allow authenticated users
        return auth()->check();
    }

    /**
     * Get all data from the request.
     *
     * @return array
     */
    public function getAll(): array
    {
        $active     = null;
        $applyRules = null;
        if (null !== $this->get('active')) {
            $active = $this->boolean('active');
        }
        if (null !== $this->get('apply_rules')) {
            $applyRules = $this->boolean('apply_rules');
        }

        return [
            'recurrence'   => [
                'type'              => $this->nullableString('type'),
                'title'             => $this->nullableString('title'),
                'description'       => $this->nullableString('description'),
                'first_date'        => $this->date('first_date'),
                'notes'             => $this->nullableNlString('notes'),
                'repeat_until'      => $this->date('repeat_until'),
                'nr_of_repetitions' => $this->nullableInteger('nr_of_repetitions'),
                'apply_rules'       => $applyRules,
                'active'            => $active,
            ],
            'transactions' => $this->getTransactionData(),
            'repetitions'  => $this->getRepetitionData(),
        ];
    }

    /**
     * The rules that the incoming request must be matched against.
     *
     * @return array
     */
    public function rules(): array
    {
        /** @var Recurrence $recurrence */
        $recurrence = $this->route()->parameter('recurrence');

        return [
            'type'                  => 'in:withdrawal,transfer,deposit',
            'title'                 => sprintf('between:1,255|uniqueObjectForUser:recurrences,title,%d', $recurrence->id),
            'description'           => 'between:1,65000',
            'first_date'            => 'date',
            'apply_rules'           => [new IsBoolean],
            'active'                => [new IsBoolean],
            'repeat_until'          => 'date',
            'nr_of_repetitions'     => 'numeric|between:1,31',
            'repetitions.*.type'    => 'in:daily,weekly,ndom,monthly,yearly',
            'repetitions.*.moment'  => 'between:0,10',
            'repetitions.*.skip'    => 'required|numeric|between:0,31',
            'repetitions.*.weekend' => 'required|numeric|min:1|max:4',

            'transactions.*.description'           => 'required|between:1,255',
            'transactions.*.amount'                => 'required|numeric|more:0',
            'transactions.*.foreign_amount'        => 'numeric|more:0',
            'transactions.*.currency_id'           => 'numeric|exists:transaction_currencies,id',
            'transactions.*.currency_code'         => 'min:3|max:3|exists:transaction_currencies,code',
            'transactions.*.foreign_currency_id'   => 'numeric|exists:transaction_currencies,id',
            'transactions.*.foreign_currency_code' => 'min:3|max:3|exists:transaction_currencies,code',
            'transactions.*.source_id'             => ['numeric', 'nullable', new BelongsUser],
            'transactions.*.source_name'           => 'between:1,255|nullable',
            'transactions.*.destination_id'        => ['numeric', 'nullable', new BelongsUser],
            'transactions.*.destination_name'      => 'between:1,255|nullable',

            // new and updated fields:
            'transactions.*.budget_id'             => ['mustExist:budgets,id', new BelongsUser],
            'transactions.*.budget_name'           => ['between:1,255', 'nullable', new BelongsUser],
            'transactions.*.category_id'           => ['mustExist:categories,id', new BelongsUser],
            'transactions.*.category_name'         => 'between:1,255|nullable',
            'transactions.*.piggy_bank_id'         => ['numeric', 'mustExist:piggy_banks,id', new BelongsUser],
            'transactions.*.piggy_bank_name'       => ['between:1,255', 'nullable', new BelongsUser],
            'transactions.*.tags'                  => 'between:1,64000',

        ];
    }

    /**
     * Configure the validator instance.
     *
     * @param Validator $validator
     *
     * @return void
     */
    public function withValidator(Validator $validator): void
    {
        $validator->after(
            function (Validator $validator) {
                $this->validateOneRecurrenceTransaction($validator);
                $this->validateOneRepetitionUpdate($validator);
                $this->validateRecurrenceRepetition($validator);
                $this->validateRepetitionMoment($validator);
                $this->validateForeignCurrencyInformation($validator);
                $this->valUpdateAccountInfo($validator);
            }
        );
    }

    /**
     * Returns the repetition data as it is found in the submitted data.
     *
     * @return array|null
     */
    private function getRepetitionData(): ?array
    {
        $return = [];
        // repetition data:
        /** @var array $repetitions */
        $repetitions = $this->get('repetitions');
        if (null === $repetitions) {

            return null;
        }
        /** @var array $repetition */
        foreach ($repetitions as $repetition) {
            $return[] = [
                'type'    => $repetition['type'],
                'moment'  => $repetition['moment'],
                'skip'    => (int) $repetition['skip'],
                'weekend' => (int) $repetition['weekend'],
            ];
        }

        return $return;
    }

    /**
     * Returns the transaction data as it is found in the submitted data. It's a complex method according to code
     * standards but it just has a lot of ??-statements because of the fields that may or may not exist.
     *
     * @return array|null
     */
    private function getTransactionData(): ?array
    {
        $return = [];
        // transaction data:
        /** @var array $transactions */
        $transactions = $this->get('transactions');
        if (null === $transactions) {

            return null;
        }
        /** @var array $transaction */
        foreach ($transactions as $transaction) {
            $return[] = $this->getSingleRecurrenceData($transaction);
        }

        return $return;
    }
}


1			<?php
2			/**
3			* RecurrenceUpdateRequest.php
4			* Copyright (c) 2019 [email protected]
5			*
6			* This file is part of Firefly III (https://github.com/firefly-iii).
7			*
8			* This program is free software: you can redistribute it and/or modify
9			* it under the terms of the GNU Affero General Public License as
10			* published by the Free Software Foundation, either version 3 of the
11			* License, or (at your option) any later version.
12			*
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU Affero General Public License for more details.
17			*
18			* You should have received a copy of the GNU Affero General Public License
19			* along with this program. If not, see <https://www.gnu.org/licenses/>.
20			*/
21
22			declare(strict_types=1);
23
24			namespace FireflyIII\Api\V1\Requests;
25
26			use FireflyIII\Models\Recurrence;
27			use FireflyIII\Rules\BelongsUser;
28			use FireflyIII\Rules\IsBoolean;
29			use FireflyIII\Validation\CurrencyValidation;
30			use FireflyIII\Validation\RecurrenceValidation;
31			use FireflyIII\Validation\TransactionValidation;
32			use Illuminate\Validation\Validator;
33
34			/**
35			* Class RecurrenceUpdateRequest
36			*/
37			class RecurrenceUpdateRequest extends Request
38			{
39			use RecurrenceValidation, TransactionValidation, CurrencyValidation;
			0 ignored issues – show introduced 2020-03-21 05:12 UTC by Report Bug Copy Issue Report The trait `FireflyIII\Validation\TransactionValidation` requires some properties which are not provided by `FireflyIII\Api\V1\Requests\RecurrenceUpdateRequest`: `$name`, `$sourceError`, `$destError`, `$transactionType`, `$account_id`, `$account`, `$type` Loading history... introduced 2020-03-21 05:12 UTC by Report Bug Copy Issue Report The trait `FireflyIII\Validation\RecurrenceValidation` requires some properties which are not provided by `FireflyIII\Api\V1\Requests\RecurrenceUpdateRequest`: `$sourceError`, `$destError` Loading history...
40
41			/**
42			* Authorize logged in users.
43			*
44			* @return bool
45			*/
46			public function authorize(): bool
47			{
48			// Only allow authenticated users
49			return auth()->check();
50			}
51
52			/**
53			* Get all data from the request.
54			*
55			* @return array
56			*/
57			public function getAll(): array
58			{
59			$active = null;
60			$applyRules = null;
61			if (null !== $this->get('active')) {
62			$active = $this->boolean('active');
63			}
64			if (null !== $this->get('apply_rules')) {
65			$applyRules = $this->boolean('apply_rules');
66			}
67
68			return [
69			'recurrence' => [
70			'type' => $this->nullableString('type'),
71			'title' => $this->nullableString('title'),
72			'description' => $this->nullableString('description'),
73			'first_date' => $this->date('first_date'),
74			'notes' => $this->nullableNlString('notes'),
75			'repeat_until' => $this->date('repeat_until'),
76			'nr_of_repetitions' => $this->nullableInteger('nr_of_repetitions'),
77			'apply_rules' => $applyRules,
78			'active' => $active,
79			],
80			'transactions' => $this->getTransactionData(),
81			'repetitions' => $this->getRepetitionData(),
82			];
83			}
84
85			/**
86			* The rules that the incoming request must be matched against.
87			*
88			* @return array
89			*/
90			public function rules(): array
91			{
92			/** @var Recurrence $recurrence */
93			$recurrence = $this->route()->parameter('recurrence');
94
95			return [
96			'type' => 'in:withdrawal,transfer,deposit',
97			'title' => sprintf('between:1,255\|uniqueObjectForUser:recurrences,title,%d', $recurrence->id),
98			'description' => 'between:1,65000',
99			'first_date' => 'date',
100			'apply_rules' => [new IsBoolean],
101			'active' => [new IsBoolean],
102			'repeat_until' => 'date',
103			'nr_of_repetitions' => 'numeric\|between:1,31',
104			'repetitions.*.type' => 'in:daily,weekly,ndom,monthly,yearly',
105			'repetitions.*.moment' => 'between:0,10',
106			'repetitions.*.skip' => 'required\|numeric\|between:0,31',
107			'repetitions.*.weekend' => 'required\|numeric\|min:1\|max:4',
108
109			'transactions.*.description' => 'required\|between:1,255',
110			'transactions.*.amount' => 'required\|numeric\|more:0',
111			'transactions.*.foreign_amount' => 'numeric\|more:0',
112			'transactions.*.currency_id' => 'numeric\|exists:transaction_currencies,id',
113			'transactions.*.currency_code' => 'min:3\|max:3\|exists:transaction_currencies,code',
114			'transactions.*.foreign_currency_id' => 'numeric\|exists:transaction_currencies,id',
115			'transactions.*.foreign_currency_code' => 'min:3\|max:3\|exists:transaction_currencies,code',
116			'transactions.*.source_id' => ['numeric', 'nullable', new BelongsUser],
117			'transactions.*.source_name' => 'between:1,255\|nullable',
118			'transactions.*.destination_id' => ['numeric', 'nullable', new BelongsUser],
119			'transactions.*.destination_name' => 'between:1,255\|nullable',
120
121			// new and updated fields:
122			'transactions.*.budget_id' => ['mustExist:budgets,id', new BelongsUser],
123			'transactions.*.budget_name' => ['between:1,255', 'nullable', new BelongsUser],
124			'transactions.*.category_id' => ['mustExist:categories,id', new BelongsUser],
125			'transactions.*.category_name' => 'between:1,255\|nullable',
126			'transactions.*.piggy_bank_id' => ['numeric', 'mustExist:piggy_banks,id', new BelongsUser],
127			'transactions.*.piggy_bank_name' => ['between:1,255', 'nullable', new BelongsUser],
128			'transactions.*.tags' => 'between:1,64000',
129
130			];
131			}
132
133			/**
134			* Configure the validator instance.
135			*
136			* @param Validator $validator
137			*
138			* @return void
139			*/
140			public function withValidator(Validator $validator): void
141			{
142			$validator->after(
143			function (Validator $validator) {
144			$this->validateOneRecurrenceTransaction($validator);
145			$this->validateOneRepetitionUpdate($validator);
146			$this->validateRecurrenceRepetition($validator);
147			$this->validateRepetitionMoment($validator);
148			$this->validateForeignCurrencyInformation($validator);
149			$this->valUpdateAccountInfo($validator);
150			}
151			);
152			}
153
154			/**
155			* Returns the repetition data as it is found in the submitted data.
156			*
157			* @return array\|null
158			*/
159			private function getRepetitionData(): ?array
160			{
161			$return = [];
162			// repetition data:
163			/** @var array $repetitions */
164			$repetitions = $this->get('repetitions');
165			if (null === $repetitions) {
			0 ignored issues – show introduced 2019-08-26 17:20 UTC by Report Bug Copy Issue Report The condition `null === $repetitions` is always `false`. Loading history...
166			return null;
167			}
168			/** @var array $repetition */
169			foreach ($repetitions as $repetition) {
170			$return[] = [
171			'type' => $repetition['type'],
172			'moment' => $repetition['moment'],
173			'skip' => (int) $repetition['skip'],
174			'weekend' => (int) $repetition['weekend'],
175			];
176			}
177
178			return $return;
179			}
180
181			/**
182			* Returns the transaction data as it is found in the submitted data. It's a complex method according to code
183			* standards but it just has a lot of ??-statements because of the fields that may or may not exist.
184			*
185			* @return array\|null
186			*/
187			private function getTransactionData(): ?array
188			{
189			$return = [];
190			// transaction data:
191			/** @var array $transactions */
192			$transactions = $this->get('transactions');
193			if (null === $transactions) {
			0 ignored issues – show introduced 2019-08-26 17:20 UTC by Report Bug Copy Issue Report The condition `null === $transactions` is always `false`. Loading history...
194			return null;
195			}
196			/** @var array $transaction */
197			foreach ($transactions as $transaction) {
198			$return[] = $this->getSingleRecurrenceData($transaction);
199			}
200
201			return $return;
202			}
203			}
204

firefly-iii / firefly-iii

GitHub Access Token became invalid

RecurrenceUpdateRequest::getTransactionData() A last analyzed 2020-04-14 19:36 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RecurrenceUpdateRequest::getTransactionData() A
last analyzed 2020-04-14 19:36 UTC