Criterion for filtering payment by status.
The following example requests payments in the 'pending' status:
$query = new PaymentQuery();
$query->setQuery(new Status('pending'));
$payments = $paymentService->findPayments($query);
Tags
Constants¶
COMPARISON_CONTAINS ¶
FieldValueCriterion.php
:
30
|
|
COMPARISON_ENDS_WITH ¶
FieldValueCriterion.php
:
36
|
|
COMPARISON_EQ ¶
FieldValueCriterion.php
:
14
|
|
COMPARISON_GT ¶
FieldValueCriterion.php
:
22
|
|
COMPARISON_GTE ¶
FieldValueCriterion.php
:
24
|
|
COMPARISON_IN ¶
FieldValueCriterion.php
:
26
|
|
COMPARISON_LT ¶
FieldValueCriterion.php
:
18
|
|
COMPARISON_LTE ¶
FieldValueCriterion.php
:
20
|
|
COMPARISON_MEMBER_OF ¶
FieldValueCriterion.php
:
32
|
|
COMPARISON_NEQ ¶
FieldValueCriterion.php
:
16
|
|
COMPARISON_NIN ¶
FieldValueCriterion.php
:
28
|
|
COMPARISON_STARTS_WITH ¶
FieldValueCriterion.php
:
34
|
|
Methods¶
__construct() ¶
Status.php
:
32
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$value | string|array<string|int, string> | - |
Payment status or statuses |
getField() ¶
FieldValueCriterion.php
:
55
|
|
Return values
string
getOperator() ¶
FieldValueCriterion.php
:
81
|
|
Return values
string
getValue() ¶
FieldValueCriterion.php
:
71
|
|
setOperator() ¶
FieldValueCriterion.php
:
76
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$operator | string | - | - |
setValue() ¶
FieldValueCriterion.php
:
63
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$value | mixed | - | - |