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

63 lines
1.6 KiB
PHP
Raw Normal View History

2016-01-13 08:10:49 -06:00
<?php
/**
* ClearCategory.php
2017-10-21 01:40:00 -05:00
* Copyright (c) 2017 thegrumpydictator@gmail.com
2016-01-13 08:10:49 -06:00
*
2017-10-21 01:40:00 -05:00
* This file is part of Firefly III.
*
2017-10-21 01:40:00 -05:00
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Firefly III. If not, see <http://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;
use FireflyIII\Models\TransactionJournal;
2016-11-06 09:17:22 -06:00
use Log;
2016-01-13 08:10:49 -06:00
/**
* Class ClearCategory
*
2017-09-13 00:49:58 -05:00
* @package FireflyIII\TransactionRules\Action
2016-01-13 08:10:49 -06:00
*/
class ClearCategory implements ActionInterface
{
private $action;
2016-01-13 08:10:49 -06:00
/**
* 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
{
$this->action = $action;
2016-01-13 08:10:49 -06:00
}
/**
* @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();
Log::debug(sprintf('RuleAction ClearCategory removed all categories from journal %d.', $journal->id));
2016-01-13 08:10:49 -06:00
return true;
}
}