mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-12-25 08:21:08 -06:00
90 lines
2.8 KiB
PHP
90 lines
2.8 KiB
PHP
<?php
|
|
/**
|
|
* DescriptionEnds.php
|
|
* Copyright (C) 2016 thegrumpydictator@gmail.com
|
|
*
|
|
* This software may be modified and distributed under the terms
|
|
* of the MIT license. See the LICENSE file for details.
|
|
*/
|
|
|
|
declare(strict_types = 1);
|
|
|
|
namespace FireflyIII\Rules\Triggers;
|
|
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use Log;
|
|
|
|
/**
|
|
* Class DescriptionEnds
|
|
*
|
|
* @package FireflyIII\Rules\Triggers
|
|
*/
|
|
final class DescriptionEnds 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 = strval($value) === '';
|
|
if ($res === true) {
|
|
Log::error(sprintf('Cannot use %s with "" as a value.', 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
|
|
{
|
|
$description = strtolower($journal->description ?? '');
|
|
$descriptionLength = strlen($description);
|
|
$search = strtolower($this->triggerValue);
|
|
$searchLength = strlen($search);
|
|
|
|
// if the string to search for is longer than the description,
|
|
// shorten the search string.
|
|
if ($searchLength > $descriptionLength) {
|
|
$search = substr($search, ($descriptionLength * -1));
|
|
$searchLength = strlen($search);
|
|
}
|
|
|
|
$part = substr($description, $searchLength * -1);
|
|
|
|
if ($part === $search) {
|
|
|
|
Log::debug(sprintf('RuleTrigger DescriptionEnds for journal #%d: "%s" ends with "%s", return true.', $journal->id, $description, $search));
|
|
|
|
return true;
|
|
}
|
|
|
|
Log::debug(sprintf('RuleTrigger DescriptionEnds for journal #%d: "%s" does not end with "%s", return false.', $journal->id, $description, $search));
|
|
|
|
return false;
|
|
}
|
|
}
|