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

New phpdoc.

Browse Source
This commit is contained in:
James Cole 2016-02-18 06:38:37 +01:00
parent 106bae5c97
commit b8df2226ae
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
app/Rules/Factory/ActionFactory.php
View File

@ -26,7 +26,10 @@ class ActionFactory
protected static $actionTypes = null; protected static $actionTypes = null;
/** /**
* Returns the action for the given type and journal * This method returns the actual implementation (Rules/Action/[object]) for a given
* RuleAction (database object). If for example the database object contains action_type "change_category"
* with value "Groceries" this method will return a corresponding SetCategory object preset
* to "Groceries". Any transaction journal then fed to this object will have its category changed.
* *
* @param RuleAction $action * @param RuleAction $action
* *
@ -34,18 +37,19 @@ class ActionFactory
*/ */
public static function getAction(RuleAction $action): ActionInterface public static function getAction(RuleAction $action): ActionInterface
{ {
$actionType = $action->action_type; $class = self::getActionClass($action->action_type);
$class = self::getActionClass($actionType);
return new $class($action); return new $class($action);
} }
/** /**
* Returns the class name to be used for actions with the given name * Returns the class name to be used for actions with the given name. This is a lookup function
* that will match the given action type (ie. "change_category") to the matching class name
* (SetCategory) using the configuration (firefly.php).
* *
* @param string $actionType * @param string $actionType
* *
* @return ActionInterface|string * @return string
* @throws FireflyException * @throws FireflyException
*/ */
public static function getActionClass(string $actionType): string public static function getActionClass(string $actionType): string