firefly-iii/app/Api/V1/Requests/Models/Recurrence/StoreRequest.php

<?php
/*
 * RecurrenceStoreRequest.php
 * Copyright (c) 2021 james@firefly-iii.org
 *
 * 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\Models\Recurrence;

use FireflyIII\Rules\BelongsUser;
use FireflyIII\Rules\IsBoolean;
use FireflyIII\Support\Request\ChecksLogin;
use FireflyIII\Support\Request\ConvertsDataTypes;
use FireflyIII\Support\Request\GetRecurrenceData;
use FireflyIII\Validation\CurrencyValidation;
use FireflyIII\Validation\RecurrenceValidation;
use FireflyIII\Validation\TransactionValidation;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Validator;

/**
 * Class StoreRequest
 */
class StoreRequest extends FormRequest
{
    use ConvertsDataTypes;
    use RecurrenceValidation;
    use TransactionValidation;
    use CurrencyValidation;
    use GetRecurrenceData;
    use ChecksLogin;

    /**
     * Get all data from the request.
     *
     * @return array
     */
    public function getAll(): array
    {
        $fields     = [
            'type'              => ['type', 'convertString'],
            'title'             => ['title', 'convertString'],
            'description'       => ['description', 'convertString'],
            'first_date'        => ['first_date', 'date'],
            'repeat_until'      => ['repeat_until', 'date'],
            'nr_of_repetitions' => ['nr_of_repetitions', 'convertInteger'],
            'apply_rules'       => ['apply_rules', 'boolean'],
            'active'            => ['active', 'boolean'],
            'notes'             => ['notes', 'stringWithNewlines'],
        ];
        $recurrence = $this->getAllData($fields);

        return [
            'recurrence'   => $recurrence,
            'transactions' => $this->getTransactionData(),
            'repetitions'  => $this->getRepetitionData(),
        ];
    }

    /**
     * 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
     */
    private function getTransactionData(): array
    {
        $return = [];
        // transaction data:
        /** @var array|null $transactions */
        $transactions = $this->get('transactions');
        if (null === $transactions) {
            return [];
        }
        /** @var array $transaction */
        foreach ($transactions as $transaction) {
            $return[] = $this->getSingleTransactionData($transaction);
        }

        return $return;
    }

    /**
     * Returns the repetition data as it is found in the submitted data.
     *
     * @return array
     */
    private function getRepetitionData(): array
    {
        $return = [];
        // repetition data:
        /** @var array|null $repetitions */
        $repetitions = $this->get('repetitions');
        if (null === $repetitions) {
            return [];
        }
        /** @var array $repetition */
        foreach ($repetitions as $repetition) {
            $current = [];
            if (array_key_exists('type', $repetition)) {
                $current['type'] = $repetition['type'];
            }
            if (array_key_exists('moment', $repetition)) {
                $current['moment'] = $repetition['moment'];
            }
            if (array_key_exists('skip', $repetition)) {
                $current['skip'] = (int)$repetition['skip'];
            }
            if (array_key_exists('weekend', $repetition)) {
                $current['weekend'] = (int)$repetition['weekend'];
            }

            $return[] = $current;
        }

        return $return;
    }

    /**
     * The rules that the incoming request must be matched against.
     *
     * @return array
     */
    public function rules(): array
    {
        return [
            'type'              => 'required|in:withdrawal,transfer,deposit',
            'title'             => 'required|between:1,255|uniqueObjectForUser:recurrences,title',
            'description'       => 'between:1,65000',
            'first_date'        => 'required|date',
            'apply_rules'       => [new IsBoolean()],
            'active'            => [new IsBoolean()],
            'repeat_until'      => 'nullable|date',
            'nr_of_repetitions' => 'nullable|numeric|between:1,31',

            'repetitions.*.type'    => 'required|in:daily,weekly,ndom,monthly,yearly',
            'repetitions.*.moment'  => 'between:0,10',
            'repetitions.*.skip'    => 'nullable|numeric|between:0,31',
            'repetitions.*.weekend' => 'numeric|min:1|max:4',

            'transactions.*.description'           => 'required|between:1,255',
            'transactions.*.amount'                => 'required|numeric|gt:0',
            'transactions.*.foreign_amount'        => 'nullable|numeric|gt:0',
            'transactions.*.currency_id'           => 'nullable|numeric|exists:transaction_currencies,id',
            'transactions.*.currency_code'         => 'nullable|min:3|max:3|exists:transaction_currencies,code',
            'transactions.*.foreign_currency_id'   => 'nullable|numeric|exists:transaction_currencies,id',
            'transactions.*.foreign_currency_code' => 'nullable|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'             => ['nullable', 'mustExist:budgets,id', new BelongsUser()],
            'transactions.*.budget_name'           => ['between:1,255', 'nullable', new BelongsUser()],
            'transactions.*.category_id'           => ['nullable', 'mustExist:categories,id', new BelongsUser()],
            'transactions.*.category_name'         => 'between:1,255|nullable',
            'transactions.*.piggy_bank_id'         => ['nullable', 'numeric', 'mustExist:piggy_banks,id', new BelongsUser()],
            'transactions.*.piggy_bank_name'       => ['between:1,255', 'nullable', new BelongsUser()],
            'transactions.*.tags'                  => 'nullable|between:1,64000',
        ];
    }

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