mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-11-03 04:41:41 +00:00
69 lines
1.8 KiB
PHP
69 lines
1.8 KiB
PHP
<?php
|
|
|
|
/*
|
|
* RuleEngineInterface.php
|
|
* Copyright (c) 2021 james@firefly-iii.org
|
|
*
|
|
* 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\Engine;
|
|
|
|
use FireflyIII\User;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* Interface RuleEngineInterface
|
|
*/
|
|
interface RuleEngineInterface
|
|
{
|
|
/**
|
|
* Add operators added to each search by the rule engine.
|
|
*/
|
|
public function addOperator(array $operator): void;
|
|
|
|
/**
|
|
* Find all transactions only, dont apply anything.
|
|
*/
|
|
public function find(): Collection;
|
|
|
|
/**
|
|
* Fire the rule engine.
|
|
*/
|
|
public function fire(): void;
|
|
|
|
/**
|
|
* Return the number of changed transactions from the previous "fire" action.
|
|
*/
|
|
public function getResults(): int;
|
|
|
|
public function setRefreshTriggers(bool $refreshTriggers): void;
|
|
|
|
/**
|
|
* Add entire rule groups for the engine to execute.
|
|
*/
|
|
public function setRuleGroups(Collection $ruleGroups): void;
|
|
|
|
/**
|
|
* Add rules for the engine to execute.
|
|
*/
|
|
public function setRules(Collection $rules): void;
|
|
|
|
public function setUser(User $user): void;
|
|
}
|