IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2024-12-26 00:41:34 -06:00
Code Issues Packages Projects Releases Wiki Activity

More phpdoc.

Browse Source
This commit is contained in:
James Cole 2016-02-18 06:45:10 +01:00
parent b8df2226ae
commit bdcb7372a5
2 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -23,10 +23,10 @@ use FireflyIII\Support\Domain;
*/
class ActionFactory
{
protected static $actionTypes = null;
protected static $actionTypes = [];
/**
* This method returns the actual implementation (Rules/Action/[object]) for a given
* This method returns the actual implementation (Rules/Actions/[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.
@ -70,10 +70,12 @@ class ActionFactory
/**
* Returns a map with actiontypes, mapped to the class representing that type
*
* @return array
*/
protected static function getActionTypes()
protected static function getActionTypes(): array
{
if (!self::$actionTypes) {
if (count(self::$actionTypes) === 0) {
self::$actionTypes = Domain::getRuleActions();
}

28
app/Rules/Factory/TriggerFactory.php
View File

@ -24,10 +24,14 @@ use FireflyIII\Support\Domain;
*/
class TriggerFactory
{
protected static $triggerTypes = null;
protected static $triggerTypes = [];
/**
* Returns the trigger for the given type and journal
* Returns the trigger for the given type and journal. This method returns the actual implementation
* (Rules/Triggers/[object]) for a given RuleTrigger (database object). If for example the database object
* contains trigger_type "description_is" with value "Rent" this method will return a corresponding
* DescriptionIs object preset to "Rent". Any transaction journal then fed to this object will
* be triggered if its description actually is "Rent".
*
* @param RuleTrigger $trigger
*
@ -45,11 +49,17 @@ class TriggerFactory
}
/**
* This method is equal to TriggerFactory::getTrigger but accepts a textual representation of the trigger type
* (for example "description_is"), the trigger value ("Rent") and whether or not Firefly III should stop processing
* other triggers (if present) after this trigger.
*
* This method is used when the RuleTriggers from TriggerFactory::getTrigger do not exist (yet).
*
* @param string $triggerType
* @param string $triggerValue
*
* @param bool $stopProcessing
*
* @see TriggerFactory::getTrigger
* @return AbstractTrigger
* @throws FireflyException
*/
@ -63,11 +73,13 @@ class TriggerFactory
}
/**
* Returns a map with triggertypes, mapped to the class representing that type
* Returns a map with trigger types, mapped to the class representing that type.
*
* @return array
*/
protected static function getTriggerTypes()
protected static function getTriggerTypes(): array
{
if (!self::$triggerTypes) {
if (count(self::$triggerTypes) === 0) {
self::$triggerTypes = Domain::getRuleTriggers();
}
@ -75,7 +87,9 @@ class TriggerFactory
}
/**
* Returns the class name to be used for triggers with the given name
* Returns the class name to be used for triggers with the given name. This is a lookup function
* that will match the given trigger type (ie. "from_account_ends") to the matching class name
* (FromAccountEnds) using the configuration (firefly.php).
*
* @param string $triggerType
*