mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
82 lines
2.5 KiB
PHP
82 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* AmountMore.php
|
|
* Copyright (C) 2016 thegrumpydictator@gmail.com
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
declare(strict_types = 1);
|
|
|
|
namespace FireflyIII\Rules\Triggers;
|
|
|
|
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use Log;
|
|
|
|
/**
|
|
* Class AmountMore
|
|
*
|
|
* @package FireflyIII\Rules\Triggers
|
|
*/
|
|
final class AmountMore extends AbstractTrigger implements TriggerInterface
|
|
{
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param null $value
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function willMatchEverything($value = null)
|
|
{
|
|
if (!is_null($value)) {
|
|
$res = bccomp('0', strval($value)) === 0;
|
|
if ($res === true) {
|
|
Log::error(sprintf('Cannot use %s with a value equal to 0.', self::class));
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
|
|
Log::error(sprintf('Cannot use %s with a null value.', self::class));
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function triggered(TransactionJournal $journal): bool
|
|
{
|
|
$amount = $journal->destination_amount ?? TransactionJournal::amountPositive($journal);
|
|
$compare = $this->triggerValue;
|
|
$result = bccomp($amount, $compare, 4);
|
|
if ($result === 1) {
|
|
Log::debug(sprintf('RuleTrigger AmountMore for journal #%d: %d is more than %d, so return true', $journal->id, $amount, $compare));
|
|
|
|
return true;
|
|
}
|
|
|
|
Log::debug(sprintf('RuleTrigger AmountMore for journal #%d: %d is NOT more than %d, so return false', $journal->id, $amount, $compare));
|
|
|
|
return false;
|
|
|
|
}
|
|
}
|