Better description for matchesAnything

This commit is contained in:
James Cole
2016-02-17 15:37:05 +01:00
parent 52481a6e8b
commit 9cac61dc33
19 changed files with 73 additions and 44 deletions

View File

@@ -29,8 +29,16 @@ interface TriggerInterface
public function __construct(RuleTrigger $trigger, TransactionJournal $journal);
/**
* Checks whether this trigger will match all transactions
* For example: amount > 0 or description starts with ''
* 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
*/