mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-12 23:45:10 +00:00
Add php doc blocks.
This commit is contained in:
@@ -38,6 +38,8 @@ interface ActionInterface
|
||||
public function __construct(RuleAction $action);
|
||||
|
||||
/**
|
||||
* Execute the action.
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -32,7 +32,7 @@ use Log;
|
||||
*/
|
||||
class AddTag implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction */
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -46,6 +46,8 @@ class AddTag implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a tag
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -31,6 +31,7 @@ use Log;
|
||||
*/
|
||||
class AppendDescription implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -44,6 +45,8 @@ class AppendDescription implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Append description with X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -32,6 +32,7 @@ use Log;
|
||||
*/
|
||||
class AppendNotes implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -45,6 +46,8 @@ class AppendNotes implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Append notes with X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -31,6 +31,7 @@ use Log;
|
||||
*/
|
||||
class ClearBudget implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -44,6 +45,8 @@ class ClearBudget implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all budgets
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -31,6 +31,7 @@ use Log;
|
||||
*/
|
||||
class ClearCategory implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -44,6 +45,8 @@ class ClearCategory implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all categories
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -32,6 +32,7 @@ use Log;
|
||||
*/
|
||||
class ClearNotes implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -45,6 +46,8 @@ class ClearNotes implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove notes
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -31,6 +31,7 @@ use Log;
|
||||
*/
|
||||
class PrependDescription implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -44,6 +45,8 @@ class PrependDescription implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepend description with X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -32,6 +32,7 @@ use Log;
|
||||
*/
|
||||
class PrependNotes implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -45,6 +46,8 @@ class PrependNotes implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepend notes with X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -31,6 +31,7 @@ use Log;
|
||||
*/
|
||||
class RemoveAllTags implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -44,6 +45,8 @@ class RemoveAllTags implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove all tags
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -32,6 +32,7 @@ use Log;
|
||||
*/
|
||||
class RemoveTag implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -45,6 +46,8 @@ class RemoveTag implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove tag X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -34,6 +34,7 @@ use Log;
|
||||
*/
|
||||
class SetBudget implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -47,6 +48,8 @@ class SetBudget implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Set budget X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -32,6 +32,7 @@ use Log;
|
||||
*/
|
||||
class SetCategory implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -45,6 +46,8 @@ class SetCategory implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Set category X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -31,9 +31,11 @@ use Log;
|
||||
*/
|
||||
class SetDescription implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
*
|
||||
* TriggerInterface constructor.
|
||||
*
|
||||
* @param RuleAction $action
|
||||
@@ -44,6 +46,8 @@ class SetDescription implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Set description to X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -35,15 +35,16 @@ use Log;
|
||||
*/
|
||||
class SetDestinationAccount implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/** @var TransactionJournal */
|
||||
/** @var TransactionJournal The journal */
|
||||
private $journal;
|
||||
|
||||
/** @var Account */
|
||||
/** @var Account The new account */
|
||||
private $newDestinationAccount;
|
||||
|
||||
/** @var AccountRepositoryInterface */
|
||||
/** @var AccountRepositoryInterface Account repository */
|
||||
private $repository;
|
||||
|
||||
/**
|
||||
@@ -57,6 +58,7 @@ class SetDestinationAccount implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Set destination account to X
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -18,6 +18,7 @@
|
||||
* 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;
|
||||
@@ -32,6 +33,7 @@ use Log;
|
||||
*/
|
||||
class SetNotes implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/**
|
||||
@@ -45,6 +47,8 @@ class SetNotes implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Set notes to X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
@@ -18,6 +18,7 @@
|
||||
* 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;
|
||||
@@ -35,15 +36,16 @@ use Log;
|
||||
*/
|
||||
class SetSourceAccount implements ActionInterface
|
||||
{
|
||||
/** @var RuleAction The rule action */
|
||||
private $action;
|
||||
|
||||
/** @var TransactionJournal */
|
||||
/** @var TransactionJournal The journal */
|
||||
private $journal;
|
||||
|
||||
/** @var Account */
|
||||
/** @var Account The new source account*/
|
||||
private $newSourceAccount;
|
||||
|
||||
/** @var AccountRepositoryInterface */
|
||||
/** @var AccountRepositoryInterface Account repository */
|
||||
private $repository;
|
||||
|
||||
/**
|
||||
@@ -57,6 +59,8 @@ class SetSourceAccount implements ActionInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Set source account to X
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return bool
|
||||
|
Reference in New Issue
Block a user