firefly-iii/app/TransactionRules/Actions/LinkToBill.php

<?php

/**
 * LinkToBill.php
 * Copyright (c) 2019 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\TransactionRules\Actions;

use FireflyIII\Enums\TransactionTypeEnum;
use FireflyIII\Events\Model\Rule\RuleActionFailedOnArray;
use FireflyIII\Events\Model\TransactionGroup\TransactionGroupRequestsAuditLogEntry;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Repositories\Bill\BillRepositoryInterface;
use FireflyIII\User;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;

/**
 * Class LinkToBill.
 */
class LinkToBill implements ActionInterface
{
    /**
     * TriggerInterface constructor.
     */
    public function __construct(
        private readonly RuleAction $action
    ) {}

    public function actOnArray(array $journal): bool
    {
        /** @var User $user */
        $user       = User::find($journal['user_id']);

        /** @var BillRepositoryInterface $repository */
        $repository = app(BillRepositoryInterface::class);
        $repository->setUser($user);
        $billName   = $this->action->getValue($journal);
        $bill       = $repository->findByName($billName);

        /** @var TransactionJournal $object */
        $object     = TransactionJournal::with('transactionType')->find($journal['transaction_journal_id']);
        $type       = $object->transactionType->type;

        if (null !== $bill && TransactionTypeEnum::WITHDRAWAL->value === $type) {
            $count  = DB::table('transaction_journals')
                ->where('id', '=', $journal['transaction_journal_id'])
                ->where('bill_id', $bill->id)
                ->count()
            ;
            if (0 !== $count) {
                Log::error(sprintf(
                    'RuleAction LinkToBill could not set the bill of journal #%d to bill "%s": already set.',
                    $journal['transaction_journal_id'],
                    $billName
                ));
                // event(new RuleActionFailedOnArray($this->action, $journal, trans('rules.already_linked_to_subscription', ['name' => $billName])));

                return false;
            }

            DB::table('transaction_journals')->where('id', '=', $journal['transaction_journal_id'])->update(['bill_id' => $bill->id]);
            Log::debug(sprintf(
                'RuleAction LinkToBill set the bill of journal #%d to bill #%d ("%s").',
                $journal['transaction_journal_id'],
                $bill->id,
                $bill->name
            ));

            /** @var TransactionJournal $object */
            $object = TransactionJournal::where('user_id', $journal['user_id'])->find($journal['transaction_journal_id']);
            event(new TransactionGroupRequestsAuditLogEntry($this->action->rule, $object, 'set_bill', null, $bill->name));

            return true;
        }

        Log::error(sprintf(
            'RuleAction LinkToBill could not set the bill of journal #%d to bill "%s": no such bill found or not a withdrawal.',
            $journal['transaction_journal_id'],
            $billName
        ));
        event(new RuleActionFailedOnArray($this->action, $journal, trans('rules.cannot_find_subscription', ['name' => $billName])));

        return false;
    }
}