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

67 lines
1.8 KiB
PHP
Raw Normal View History

2016-01-13 08:10:49 -06:00
<?php
/**
* ClearCategory.php
* Copyright (c) 2019 thegrumpydictator@gmail.com
2016-01-13 08:10:49 -06:00
*
* 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.
2017-10-21 01:40:00 -05:00
*
* This program is distributed in the hope that it will be useful,
2017-10-21 01:40:00 -05:00
* 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.
2017-10-21 01:40:00 -05:00
*
* 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/>.
2016-01-13 08:10:49 -06:00
*/
declare(strict_types=1);
2017-09-13 00:49:58 -05:00
namespace FireflyIII\TransactionRules\Actions;
2016-01-13 08:10:49 -06:00
use FireflyIII\Models\RuleAction;
2018-03-04 09:42:29 -06:00
use FireflyIII\Models\Transaction;
2016-01-13 08:10:49 -06:00
use FireflyIII\Models\TransactionJournal;
2016-11-06 09:17:22 -06:00
use Log;
2016-01-13 08:10:49 -06:00
/**
2017-11-15 05:25:49 -06:00
* Class ClearCategory.
2016-01-13 08:10:49 -06:00
*/
class ClearCategory implements ActionInterface
{
/**
* TriggerInterface constructor.
*
* @param RuleAction $action
2016-01-13 08:10:49 -06:00
*/
public function __construct(RuleAction $action)
2016-01-13 08:10:49 -06:00
{
}
/**
2017-11-25 08:20:53 -06:00
* Clear all categories
*
* @param TransactionJournal $journal
*
2016-01-13 08:10:49 -06:00
* @return bool
*/
2016-04-05 15:00:03 -05:00
public function act(TransactionJournal $journal): bool
2016-01-13 08:10:49 -06:00
{
$journal->categories()->detach();
$journal->touch();
2018-03-04 09:42:29 -06:00
// also remove categories from transactions:
/** @var Transaction $transaction */
2018-03-10 15:38:20 -06:00
foreach ($journal->transactions as $transaction) {
2018-03-04 09:42:29 -06:00
$transaction->categories()->detach();
}
Log::debug(sprintf('RuleAction ClearCategory removed all categories from journal %d.', $journal->id));
2016-01-13 08:10:49 -06:00
return true;
}
}