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

54 lines
1.1 KiB
PHP
Raw Normal View History

2016-01-13 08:10:49 -06:00
<?php
/**
* ClearBudget.php
2016-04-01 09:44:46 -05:00
* Copyright (C) 2016 thegrumpydictator@gmail.com
2016-01-13 08:10:49 -06:00
*
* This software may be modified and distributed under the terms of the
* Creative Commons Attribution-ShareAlike 4.0 International License.
*
* See the LICENSE file for details.
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;
use Log;
2016-01-13 08:10:49 -06:00
/**
* Class ClearBudget
*
2017-09-13 00:49:58 -05:00
* @package FireflyIII\TransactionRules\Action
2016-01-13 08:10:49 -06:00
*/
class ClearBudget 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->budgets()->detach();
Log::debug(sprintf('RuleAction ClearBudget removed all budgets from journal %d.', $journal->id));
2016-01-13 08:10:49 -06:00
return true;
}
}