IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-01-06 06:03:09 -06:00
Code Issues Packages Projects Releases Wiki Activity

Some phpdoc.

Browse Source
This commit is contained in:
James Cole 2016-02-18 06:28:46 +01:00
parent f82a2b3bc5
commit 1b2873fc5f
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
app/Http/Controllers/RuleController.php
View File

@ -46,6 +46,8 @@ class RuleController extends Controller
} }
/** /**
* Create a new rule. It will be stored under the given $ruleGroup.
*
* @param RuleGroup $ruleGroup * @param RuleGroup $ruleGroup
* *
* @return View * @return View
@ -88,6 +90,8 @@ class RuleController extends Controller
} }
/** /**
* Delete a given rule.
*
* @param Rule $rule * @param Rule $rule
* *
* @return View * @return View
@ -106,6 +110,8 @@ class RuleController extends Controller
} }
/** /**
* Actually destroy the given rule.
*
* @param Rule $rule * @param Rule $rule
* @param RuleRepositoryInterface $repository * @param RuleRepositoryInterface $repository
* *
@ -266,6 +272,13 @@ class RuleController extends Controller
} }
/** /**
* This method allows the user to test a certain set of rule triggers. The rule triggers are passed along
* using the URL parameters (GET), and are usually put there using a Javascript thing.
*
* This method will parse and validate those rules and create a "TransactionMatcher" which will attempt
* to find transaction journals matching the users input. A maximum range of transactions to try (range) and
* a maximum number of transactions to return (limit) are set as well.
*
* @param TestRuleFormRequest $request * @param TestRuleFormRequest $request
* *
* @return \Illuminate\View\View * @return \Illuminate\View\View
@ -275,7 +288,6 @@ class RuleController extends Controller
// build trigger array from response // build trigger array from response
$triggers = $this->getValidTriggerList($request); $triggers = $this->getValidTriggerList($request);
if (count($triggers) == 0) { if (count($triggers) == 0) {
return Response::json(['html' => '', 'warning' => trans('firefly.warning_no_valid_triggers')]); return Response::json(['html' => '', 'warning' => trans('firefly.warning_no_valid_triggers')]);
} }