IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-02-25 18:45:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Can now automatically handle some rules. No user interface, yet.

Browse Source
This commit is contained in:
James Cole
2016-01-13 08:14:14 +01:00
parent ce250c85fc
commit 46ee2a0568
8 changed files with 200 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
app/Rules/Actions/ActionInterface.php Normal file
View File

@@ -0,0 +1,33 @@
<?php
/**
* ActionInterface.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Rules\Actions;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
/**
* Interface ActionInterface
*
* @package FireflyIII\Rules\Action
*/
interface ActionInterface
{
/**
* TriggerInterface constructor.
*
* @param RuleAction $action
* @param TransactionJournal $journal
*/
public function __construct(RuleAction $action, TransactionJournal $journal);
/**
* @return bool
*/
public function act();
}

64
app/Rules/Actions/SetBudget.php Normal file
View File

@@ -0,0 +1,64 @@
<?php
/**
* SetBudget.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Rules\Actions;
use FireflyIII\Models\Budget;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
use Log;
/**
* Class SetBudget
*
* @package FireflyIII\Rules\Action
*/
class SetBudget implements ActionInterface
{
private $action;
private $journal;
/**
* TriggerInterface constructor.
*
* @param RuleAction $action
* @param TransactionJournal $journal
*/
public function __construct(RuleAction $action, TransactionJournal $journal)
{
$this->action = $action;
$this->journal = $journal;
}
/**
* @return bool
*/
public function act()
{
/** @var BudgetRepositoryInterface $repository */
$repository = app('FireflyIII\Repositories\Budget\BudgetRepositoryInterface');
$search = $this->action->action_value;
$budgets = $repository->getActiveBudgets();
$budget = $budgets->filter(
function (Budget $current) use ($search) {
return $current->name == $search;
}
)->first();
if (!is_null($budget)) {
Log::debug('Will set budget "' . $search . '" (#' . $budget->id . ') on journal #' . $this->journal->id . '.');
$this->journal->budgets()->save($budget);
} else {
Log::debug('Could not find budget "'.$search.'". Failed.');
}
return true;
}
}

54
app/Rules/Actions/SetCategory.php Normal file
View File

@@ -0,0 +1,54 @@
<?php
/**
* SetCategory.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Rules\Actions;
use Auth;
use FireflyIII\Models\Category;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use Log;
/**
* Class SetCategory
*
* @package FireflyIII\Rules\Action
*/
class SetCategory implements ActionInterface
{
private $action;
private $journal;
/**
* TriggerInterface constructor.
*
* @param RuleAction $action
* @param TransactionJournal $journal
*/
public function __construct(RuleAction $action, TransactionJournal $journal)
{
$this->action = $action;
$this->journal = $journal;
}
/**
* @return bool
*/
public function act()
{
$name = $this->action->action_value;
$category = Category::firstOrCreateEncrypted(['name' => $name, 'user_id' => Auth::user()->id]);
Log::debug('Will set category "' . $name . '" (#' . $category->id . ') on journal #' . $this->journal->id . '.');
$this->journal->categories()->save($category);
return true;
}
}

41
app/Rules/TriggerProcessor.php → app/Rules/Processor.php
View File

@@ -1,6 +1,6 @@
<?php
/**
* TriggerProcessor.php
* Processor.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
@@ -10,18 +10,20 @@
namespace FireflyIII\Rules;
use FireflyIII\Models\Rule;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\RuleTrigger;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Rules\Actions\ActionInterface;
use FireflyIII\Rules\Triggers\TriggerInterface;
use FireflyIII\Support\Domain;
use Log;
/**
* Class TriggerProcessor
* Class Processor
*
* @package FireflyIII\Rules
*/
class TriggerProcessor
class Processor
{
/** @var Rule */
protected $rule;
@@ -29,16 +31,21 @@ class TriggerProcessor
/** @var TransactionJournal */
protected $journal;
/** @var array */
private $triggerTypes = [];
/** @var array */
private $actionTypes = [];
/**
* TriggerProcessor constructor.
* Processor constructor.
*/
public function __construct(Rule $rule, TransactionJournal $journal)
{
$this->rule = $rule;
$this->journal = $journal;
$this->triggerTypes = Domain::getRuleTriggers();
$this->actionTypes = Domain::getRuleActions();
}
public function handle()
@@ -47,6 +54,7 @@ class TriggerProcessor
$triggered = $this->triggered();
if ($triggered) {
Log::debug('Rule #' . $this->rule->id . ' was triggered. Now process each action.');
$this->actions();
}
}
@@ -82,6 +90,31 @@ class TriggerProcessor
}
/**
* @return bool
*/
protected function actions()
{
/**
* @var int $index
* @var RuleAction $action
*/
foreach ($this->rule->ruleActions()->orderBy('order', 'ASC')->get() as $index => $action) {
$type = $action->action_type;
$class = $this->actionTypes[$type];
Log::debug('Action #' . $action->id . ' for rule #' . $action->rule_id . ' (' . $type . ')');
if (!class_exists($class)) {
abort(500, 'Could not instantiate class for rule action type "' . $type . '" (' . $class . ').');
}
/** @var ActionInterface $actionClass */
$actionClass = new $class($action, $this->journal);
$actionClass->act();
}
return true;
}
/**
* @return Rule
*/