PaymentBatchList
extends FinderListAbstract
in package
implements
FinderListInterface
Tags
Interfaces, Classes, Traits and Enums
Table of Contents
- $items : array<string|int, mixed>
- $total : int
- __construct() : mixed
- add() : $this
- Add a single item to the collection
- combine() : array<string|int, mixed>
- Create an array with keys from one property value, values from another property value
- filter() : FinderListAbstract
- Filter the list items according to $callback, and returns a new list instance
- first() : DomainObjectInterface|null
- Retrieve the first item in the collection
- getById() : DomainObjectInterface
- Get a single Domain object by ID search
- getIterator() : ArrayIterator
- items() : array<string|int, PaymentBatch>
- last() : DomainObjectInterface|null
- Retrieve the last item in the collection
- pluck() : array<string|int, mixed>
- Pluck all values of a particular property from a list
- sort() : FinderListAbstract
- Sorts the list items according to $callback, and returns a new list instance
- total() : int
Properties
$items
protected
array<string|int, mixed>
$items
Tags
$total
protected
int
$total
Tags
Methods
__construct()
public
__construct(array<string|int, DomainObjectInterface> $items, int $total) : mixed
Parameters
- $items : array<string|int, DomainObjectInterface>
- $total : int
Tags
Return values
mixed —add()
Add a single item to the collection
public
add(DomainObjectInterface $item) : $this
Parameters
- $item : DomainObjectInterface
Tags
Return values
$this —combine()
Create an array with keys from one property value, values from another property value
public
combine(string $columnKey, string $valueKey) : array<string|int, mixed>
Parameters
- $columnKey : string
- $valueKey : string
Tags
Return values
array<string|int, mixed> —filter()
Filter the list items according to $callback, and returns a new list instance
public
filter(callable $callback) : FinderListAbstract
Parameters
- $callback : callable
Tags
Return values
FinderListAbstract —first()
Retrieve the first item in the collection
public
first() : DomainObjectInterface|null
Tags
Return values
DomainObjectInterface|null —getById()
Get a single Domain object by ID search
public
getById(string $id[, string $property = 'id' ]) : DomainObjectInterface
Parameters
- $id : string
- $property : string = 'id'
Tags
Return values
DomainObjectInterface —getIterator()
public
getIterator() : ArrayIterator
Tags
Return values
ArrayIterator —items()
public
items() : array<string|int, PaymentBatch>
Return values
array<string|int, PaymentBatch> —last()
Retrieve the last item in the collection
public
last() : DomainObjectInterface|null
Tags
Return values
DomainObjectInterface|null —pluck()
Pluck all values of a particular property from a list
public
pluck(string $property) : array<string|int, mixed>
Parameters
- $property : string
Tags
Return values
array<string|int, mixed> —sort()
Sorts the list items according to $callback, and returns a new list instance
public
sort(callable $callback) : FinderListAbstract
Parameters
- $callback : callable
Tags
Return values
FinderListAbstract —total()
public
total() : int