Galette\Repository\ScheduledPayments Class Reference

Public Member Functions
	__construct (Db $zdb, Login $login, ?ScheduledPaymentsList $filters=null)
	getListFromContribution (int $contrib_id)
	getArrayList (array $ids, bool $as_object=false, ?array $fields=null)
	getList (bool $as_object=true, ?array $fields=null)
	getCount ()
	getSum ()
	remove (int|array $ids, History $hist, bool $transaction=true)

Public Attributes
const	TABLE = ScheduledPayment::TABLE
const	PK = ScheduledPayment::PK

Detailed Description

Scheduled payments class for galette

Author

Johan Cwiklinski johan.nosp@m.@x-t.nosp@m.nd.be

Constructor & Destructor Documentation

__construct()

Galette\Repository\ScheduledPayments::__construct	(	Db	$zdb,
		Login	$login,
		?ScheduledPaymentsList	$filters = null
	)

Default constructor

Parameters

Db	$zdb	Database
Login	$login	Login
	?ScheduledPaymentsList	$filters Filtering

Member Function Documentation

getArrayList()

Galette\Repository\ScheduledPayments::getArrayList	(	array	$ids,
		bool	$as_object = false,
		?array	$fields = null
	)

Get scheduled payments list for a specific contribution

Parameters

	array<int>	$ids an array of members id that has been selected
bool	$as_object	return the results as an array of
	?array<string>	$fields field(s) name(s) to get. Should be a string or an array. If null, all fields will be returned

Returns

array<int, Contribution>|false

getCount()

Galette\Repository\ScheduledPayments::getCount

(

)

Get count for current query

Returns

int

getList()

Galette\Repository\ScheduledPayments::getList	(	bool	$as_object = true,
		?array	$fields = null
	)

Get scheduled payments list

Parameters

bool	$as_object	return the results as an array of ScheduledPayment object.
	?array<string>	$fields field(s) name(s) to get. Should be a string or an array. If null, all fields will be returned

Returns

array<int, Contribution>|ResultSet

getListFromContribution()

Galette\Repository\ScheduledPayments::getListFromContribution

(

int

$contrib_id

)

Get scheduled payments list for a specific contribution

Parameters

int

$contrib_id

Contribution identifier

Returns

ScheduledPayment[]

@phpstan-ignore-next-line

getSum()

Galette\Repository\ScheduledPayments::getSum

(

)

Get sum

Returns

float

remove()

Galette\Repository\ScheduledPayments::remove	(	int|array	$ids,
		History	$hist,
		bool	$transaction = true
	)

Remove specified scheduled payments

Parameters

	integer|array<int>	$ids Scheduled payments identifiers to delete
History	$hist	History
boolean	$transaction	True to begin a database transaction

Returns

boolean

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/galette-apidoc/checkouts/develop/galette/lib/Galette/Repository/ScheduledPayments.php