mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
139 lines
3.8 KiB
PHP
139 lines
3.8 KiB
PHP
<?php
|
|
declare(strict_types = 1);
|
|
/**
|
|
* TransactionMatcher.php
|
|
* Copyright (C) 2016 Robert Horlings
|
|
*
|
|
* This software may be modified and distributed under the terms
|
|
* of the MIT license. See the LICENSE file for details.
|
|
*/
|
|
|
|
namespace FireflyIII\Rules;
|
|
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use FireflyIII\Models\TransactionType;
|
|
use FireflyIII\Repositories\Journal\JournalRepositoryInterface;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* Class TransactionMatcher is used to find a list of
|
|
* transaction matching a set of triggers
|
|
*
|
|
* @package FireflyIII\Rules
|
|
*/
|
|
class TransactionMatcher
|
|
{
|
|
/** @var int */
|
|
private $limit = 10;
|
|
/** @var int Maximum number of transaction to search in (for performance reasons) * */
|
|
private $range = 200;
|
|
/** @var array */
|
|
private $transactionTypes = [TransactionType::DEPOSIT, TransactionType::WITHDRAWAL, TransactionType::TRANSFER];
|
|
/** @var array List of triggers to match */
|
|
private $triggers = [];
|
|
|
|
/**
|
|
* Find matching transactions for the current set of triggers
|
|
*
|
|
* @return array
|
|
*
|
|
*/
|
|
public function findMatchingTransactions()
|
|
{
|
|
/** @var JournalRepositoryInterface $repository */
|
|
$repository = app('FireflyIII\Repositories\Journal\JournalRepositoryInterface');
|
|
$pagesize = min($this->range / 2, $this->limit * 2);
|
|
|
|
// Variables used within the loop
|
|
$processed = 0;
|
|
$page = 1;
|
|
$result = new Collection();
|
|
$processor = Processor::makeFromStringArray($this->triggers);
|
|
|
|
// Start a loop to fetch batches of transactions. The loop will finish if:
|
|
// - all transactions have been fetched from the database
|
|
// - the maximum number of transactions to return has been found
|
|
// - the maximum number of transactions to search in have been searched
|
|
do {
|
|
// Fetch a batch of transactions from the database
|
|
$offset = $page > 0 ? ($page - 1) * $pagesize : 0;
|
|
$set = $repository->getCollectionOfTypes($this->transactionTypes, $offset, $pagesize);
|
|
|
|
// Filter transactions that match the given triggers.
|
|
$filtered = $set->filter(
|
|
function (TransactionJournal $journal) use ($processor) {
|
|
return $processor->handleTransactionJournal($journal);
|
|
}
|
|
);
|
|
|
|
// merge:
|
|
$result = $result->merge($filtered);
|
|
|
|
// Update counters
|
|
$page++;
|
|
$processed += count($set);
|
|
|
|
// Check for conditions to finish the loop
|
|
$reachedEndOfList = $set->count() < $pagesize;
|
|
$foundEnough = $result->count() >= $this->limit;
|
|
$searchedEnough = ($processed >= $this->range);
|
|
} while (!$reachedEndOfList && !$foundEnough && !$searchedEnough);
|
|
|
|
// If the list of matchingTransactions is larger than the maximum number of results
|
|
// (e.g. if a large percentage of the transactions match), truncate the list
|
|
$result = $result->slice(0, $this->limit);
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getLimit()
|
|
{
|
|
return $this->limit;
|
|
}
|
|
|
|
/**
|
|
* @param int $limit
|
|
*/
|
|
public function setLimit($limit)
|
|
{
|
|
$this->limit = $limit;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getRange()
|
|
{
|
|
return $this->range;
|
|
}
|
|
|
|
/**
|
|
* @param int $range
|
|
*/
|
|
public function setRange($range)
|
|
{
|
|
$this->range = $range;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getTriggers()
|
|
{
|
|
return $this->triggers;
|
|
}
|
|
|
|
/**
|
|
* @param array $triggers
|
|
*/
|
|
public function setTriggers($triggers)
|
|
{
|
|
$this->triggers = $triggers;
|
|
}
|
|
|
|
|
|
}
|