mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-12-01 21:19:11 -06:00
67 lines
1.8 KiB
PHP
67 lines
1.8 KiB
PHP
<?php
|
|
/**
|
|
* ClearBudget.php
|
|
* Copyright (c) 2019 thegrumpydictator@gmail.com
|
|
*
|
|
* 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\Models\RuleAction;
|
|
use FireflyIII\Models\Transaction;
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use Log;
|
|
|
|
/**
|
|
* Class ClearBudget.
|
|
*/
|
|
class ClearBudget implements ActionInterface
|
|
{
|
|
/**
|
|
* TriggerInterface constructor.
|
|
*
|
|
* @param RuleAction $action
|
|
*/
|
|
public function __construct(RuleAction $action)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Clear all budgets
|
|
*
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function act(TransactionJournal $journal): bool
|
|
{
|
|
$journal->budgets()->detach();
|
|
$journal->touch();
|
|
|
|
// also remove budgets from transactions (although no longer necessary)
|
|
/** @var Transaction $transaction */
|
|
foreach ($journal->transactions as $transaction) {
|
|
$transaction->budgets()->detach();
|
|
}
|
|
|
|
Log::debug(sprintf('RuleAction ClearBudget removed all budgets from journal %d.', $journal->id));
|
|
|
|
return true;
|
|
}
|
|
}
|