2016-01-13 08:14:14 +01:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* ActionInterface.php
|
2019-10-02 06:37:26 +02:00
|
|
|
* Copyright (c) 2019 thegrumpydictator@gmail.com
|
2016-01-13 08:14:14 +01:00
|
|
|
*
|
2019-10-02 06:37:26 +02:00
|
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
2016-10-05 06:52:15 +02:00
|
|
|
*
|
2019-10-02 06:37:26 +02:00
|
|
|
* 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 08:40:00 +02:00
|
|
|
*
|
2019-10-02 06:37:26 +02:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2017-10-21 08:40:00 +02:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
2019-10-02 06:37:26 +02:00
|
|
|
* GNU Affero General Public License for more details.
|
2017-10-21 08:40:00 +02:00
|
|
|
*
|
2019-10-02 06:37:26 +02: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:14:14 +01:00
|
|
|
*/
|
2017-04-09 07:44:22 +02:00
|
|
|
declare(strict_types=1);
|
2016-05-20 12:41:23 +02:00
|
|
|
|
2017-09-13 07:49:58 +02:00
|
|
|
namespace FireflyIII\TransactionRules\Actions;
|
2016-01-15 23:12:52 +01:00
|
|
|
|
2016-01-13 08:14:14 +01:00
|
|
|
use FireflyIII\Models\RuleAction;
|
|
|
|
use FireflyIII\Models\TransactionJournal;
|
|
|
|
|
|
|
|
/**
|
2017-11-15 12:25:49 +01:00
|
|
|
* Interface ActionInterface.
|
2016-01-13 08:14:14 +01:00
|
|
|
*/
|
|
|
|
interface ActionInterface
|
|
|
|
{
|
|
|
|
/**
|
2018-09-15 13:43:57 +02:00
|
|
|
* ActionInterface constructor.
|
2016-01-13 08:14:14 +01:00
|
|
|
*
|
2016-02-17 19:56:05 +01:00
|
|
|
* @param RuleAction $action
|
2016-01-13 08:14:14 +01:00
|
|
|
*/
|
2016-02-17 19:56:05 +01:00
|
|
|
public function __construct(RuleAction $action);
|
2016-01-13 08:14:14 +01:00
|
|
|
|
|
|
|
/**
|
2017-11-25 15:20:53 +01:00
|
|
|
* Execute the action.
|
|
|
|
*
|
2016-02-17 19:56:05 +01:00
|
|
|
* @param TransactionJournal $journal
|
|
|
|
*
|
2016-01-13 08:14:14 +01:00
|
|
|
* @return bool
|
|
|
|
*/
|
2016-04-05 22:00:03 +02:00
|
|
|
public function act(TransactionJournal $journal): bool;
|
2016-01-28 21:50:20 +01:00
|
|
|
}
|