Add comment [skip ci]

This commit is contained in:
James Cole 2017-04-28 18:03:27 +02:00
parent 42322055f9
commit 9d1508049e
No known key found for this signature in database
GPG Key ID: C16961E655E74B5E

View File

@ -49,6 +49,13 @@ class Support
}
/**
* This method removes transactions from the collection based on the amount and the opposing account. Usually
* this is used to filter double entries (both sides of a journal get included)
*
* - Opposing account is in $accounts. This usually indicates a transfer and should not be included.
* - Amount is less or more than zero. If the modifier is -1, only the positive amount remains, emphasising
* deposits. If the modifier is +1, only the negative ones remain, emphasising withdrawals.
*
* @param Collection $collection
* @param array $accounts
* @param int $modifier