Add new action to link a transaction to a bill.

This commit is contained in:
James Cole
2018-04-07 06:20:45 +02:00
parent b54e99642b
commit 7af10aca9e
5 changed files with 91 additions and 1 deletions

View File

@@ -0,0 +1,76 @@
<?php
/**
* LinkToBill.php
* Copyright (c) 2018 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\Actions;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Bill\BillRepositoryInterface;
use Log;
/**
* Class LinkToBill.
*/
class LinkToBill implements ActionInterface
{
/** @var RuleAction The rule action */
private $action;
/**
* TriggerInterface constructor.
*
* @param RuleAction $action
*/
public function __construct(RuleAction $action)
{
$this->action = $action;
}
/**
* Set bill to be X.
*
* @param TransactionJournal $journal
*
* @return bool
*/
public function act(TransactionJournal $journal): bool
{
/** @var BillRepositoryInterface $repository */
$repository = app(BillRepositoryInterface::class);
$billName = (string)$this->action->action_value;
$bill = $repository->findByName($billName);
if (null !== $bill && $journal->transactionType->type === TransactionType::WITHDRAWAL) {
$journal->bill()->associate($bill);
$journal->save();
Log::debug(sprintf('RuleAction LinkToBill set the bill of journal #%d to bill #%d ("%s").', $journal->id, $bill->id, $bill->name));
}
if (null === $bill) {
Log::error(sprintf('RuleAction LinkToBill could not set the bill of journal #%d to bill "%s": no such bill found!', $journal->id, $billName));
}
return true;
}
}

View File

@@ -31,6 +31,7 @@ use FireflyIII\Models\AccountType;
use FireflyIII\Models\Budget;
use FireflyIII\Models\PiggyBank;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Bill\BillRepositoryInterface;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use FireflyIII\Services\Password\Verifier;
use FireflyIII\TransactionRules\Triggers\TriggerInterface;
@@ -254,6 +255,12 @@ class FireflyValidator extends Validator
)->count();
return 1 === $count;
case 'link_to_bill':
/** @var BillRepositoryInterface $repository */
$repository = app(BillRepositoryInterface::class);
$bill = $repository->findByName((string)$value);
return null !== $bill;
case 'invalid':
return false;
}
@@ -275,7 +282,7 @@ class FireflyValidator extends Validator
// loop all rule-triggers.
// check if rule-value matches the thing.
if (is_array($this->data['rule-trigger'])) {
if (\is_array($this->data['rule-trigger'])) {
$name = $this->getRuleTriggerName($index);
$value = $this->getRuleTriggerValue($index);

View File

@@ -9,6 +9,7 @@ use FireflyIII\TransactionRules\Actions\AppendNotes;
use FireflyIII\TransactionRules\Actions\ClearBudget;
use FireflyIII\TransactionRules\Actions\ClearCategory;
use FireflyIII\TransactionRules\Actions\ClearNotes;
use FireflyIII\TransactionRules\Actions\LinkToBill;
use FireflyIII\TransactionRules\Actions\PrependDescription;
use FireflyIII\TransactionRules\Actions\PrependNotes;
use FireflyIII\TransactionRules\Actions\RemoveAllTags;
@@ -354,6 +355,7 @@ return [
'append_notes' => AppendNotes::class,
'prepend_notes' => PrependNotes::class,
'clear_notes' => ClearNotes::class,
'link_to_bill' => LinkToBill::class,
],
'rule-actions-text' => [
'set_category',

View File

@@ -224,6 +224,9 @@ function updateActionInput(selectList) {
case 'set_destination_account':
createAutoComplete(input, 'json/all-accounts');
break;
case 'link_to_bill':
createAutoComplete(input, 'json/bills');
break;
default:
input.typeahead('destroy');
break;

View File

@@ -404,6 +404,8 @@ return [
'rule_action_clear_notes_choice' => 'Remove any notes',
'rule_action_clear_notes' => 'Remove any notes',
'rule_action_set_notes_choice' => 'Set notes to..',
'rule_action_link_to_bill_choice' => 'Link to a bill..',
'rule_action_link_to_bill' => 'Link to bill ":action_value"',
'rule_action_set_notes' => 'Set notes to ":action_value"',
'rules_have_read_warning' => 'Have you read the warning?',