mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
93 lines
3.2 KiB
PHP
93 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* AmountMore.php
|
|
* Copyright (c) 2017 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III.
|
|
*
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Firefly III 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\TransactionRules\Triggers;
|
|
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use FireflyIII\Repositories\Journal\JournalRepositoryInterface;
|
|
use Log;
|
|
|
|
/**
|
|
* Class AmountMore.
|
|
*/
|
|
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 (null !== $value) {
|
|
$res = 0 === bccomp('0', (string)$value);
|
|
if (true === $res) {
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Returns true when amount is more than X.
|
|
*
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function triggered(TransactionJournal $journal): bool
|
|
{
|
|
/** @var JournalRepositoryInterface $repos */
|
|
$repos = app(JournalRepositoryInterface::class);
|
|
$repos->setUser($journal->user);
|
|
|
|
$amount = $journal->destination_amount ?? $repos->getJournalTotal($journal);
|
|
$compare = $this->triggerValue;
|
|
$result = bccomp($amount, $compare);
|
|
if (1 === $result) {
|
|
Log::debug(sprintf('RuleTrigger AmountMore for journal #%d: %f is more than %f, so return true', $journal->id, $amount, $compare));
|
|
|
|
return true;
|
|
}
|
|
|
|
Log::debug(sprintf('RuleTrigger AmountMore for journal #%d: %f is NOT more than %f, so return false', $journal->id, $amount, $compare));
|
|
|
|
return false;
|
|
}
|
|
}
|