mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-12-27 01:11:37 -06:00
52 lines
1.5 KiB
PHP
52 lines
1.5 KiB
PHP
<?php
|
|
declare(strict_types = 1);
|
|
/**
|
|
* TriggerInterface.php
|
|
* Copyright (C) 2016 Sander Dorigo
|
|
*
|
|
* This software may be modified and distributed under the terms
|
|
* of the MIT license. See the LICENSE file for details.
|
|
*/
|
|
|
|
namespace FireflyIII\Rules\Triggers;
|
|
|
|
use FireflyIII\Models\RuleTrigger;
|
|
use FireflyIII\Models\TransactionJournal;
|
|
|
|
/**
|
|
* Interface TriggerInterface
|
|
*
|
|
* @package FireflyIII\Rules\Triggers
|
|
*/
|
|
interface TriggerInterface
|
|
{
|
|
/**
|
|
* TriggerInterface constructor.
|
|
*
|
|
* @param RuleTrigger $trigger
|
|
* @param TransactionJournal $journal
|
|
*/
|
|
public function __construct(RuleTrigger $trigger, TransactionJournal $journal);
|
|
|
|
/**
|
|
* A trigger is said to "match anything", or match any given transaction,
|
|
* when the trigger value is very vague or has no restrictions. Easy examples
|
|
* are the "AmountMore"-trigger combined with an amount of 0: any given transaction
|
|
* has an amount of more than zero! Other examples are all the "Description"-triggers
|
|
* which have hard time handling empty trigger values such as "" or "*" (wild cards).
|
|
*
|
|
* If the user tries to create such a trigger, this method MUST return true so Firefly III
|
|
* can stop the storing / updating the trigger. If the trigger is in any way restrictive
|
|
* (even if it will still include 99.9% of the users transactions), this method MUST return
|
|
* false.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function matchesAnything();
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function triggered();
|
|
}
|