TransactionFinder
in package
implements
FinderInterface
Uses
ValidatesQueryTrait
Tags
Interfaces, Classes, Traits and Enums
Table of Contents
- $client : Client
- __construct() : mixed
- buildQueryString() : array<string|int, mixed>
- Build an array of query params to be sent in the call
- find() : TransactionList|null
- Find transactions
- findByPeopleId() : TransactionList|null
- Find transactions by people ID
- findByUserId() : TransactionList|null
- Find User transactions
- findOne() : Transaction|null
- Find one transaction
- findOneByUserId() : Transaction|null
- Find one User transaction
- validateQuery() : mixed
Properties
$client
protected
Client
$client
Tags
Methods
__construct()
public
__construct(Client $client) : mixed
Parameters
- $client : Client
Tags
Return values
mixed —buildQueryString()
Build an array of query params to be sent in the call
public
buildQueryString(Query $query) : array<string|int, mixed>
Parameters
- $query : Query
Tags
Return values
array<string|int, mixed> —find()
Find transactions
public
find(Query $query) : TransactionList|null
TS docs reference for more detailed descriptions
Query parameter must have the following value:
organization_id: <string> T-hub Organization UUID
Query parameter can have the following values:
amount: <int>
backdate_before: <int> unix timestamp
backdate_after: <int> unix timestamp
currency: <string>
deposit_account_id: <string> UUID
deposit_id: <string> UUID
deposit_before: <int> unix timestamp
deposit_after: <int> unix timestamp
drupal_payment_category: <string> Legacy Payment Category ID
location_id: <string> T-hub Location UUID
name_email_search: <string>
payment_category_id: <string> must use the following format "{product}:{ID}"
payment_type: <string>
product: <string>
status: <string>
payment_meta: <string>
refund: <boolean> true or false
remote_or_drupal_id: <string> must use the following format "{product}:{remote_id}:{drupal_id},{product}:{remote_id}:{drupal_id}"
order_by: <string>
Parameters
- $query : Query
Tags
Return values
TransactionList|null —findByPeopleId()
Find transactions by people ID
public
findByPeopleId(Query $query) : TransactionList|null
Query parameter must have the following values:
organization_id: <string> T-hub Organization UUID
people_id: <string> Person UUID
Parameters
- $query : Query
Tags
Return values
TransactionList|null —findByUserId()
Find User transactions
public
findByUserId(Query $query) : TransactionList|null
TS docs reference for more detailed descriptions
Query parameter must have the following value:
people_id: <string> T-hub People UUID
Query parameter can have the following values:
amount: <int>
backdate_before: <int> unix timestamp
backdate_after: <int> unix timestamp
currency: <string>
deposit_account_id: <string> UUID
deposit_id: <string> UUID
deposit_before: <int> unix timestamp
deposit_after: <int> unix timestamp
drupal_payment_category: <string> Legacy Payment Category ID
location_id: <string> T-hub Location UUID
name_email_search: <string>
organization_id: <string> T-hub Organization UUID
payment_category_id: <string> must use the following format "{product}:{ID}"
payment_type: <string>
product: <string>
status: <string>
payment_meta: <string>
refund: <boolean> true or false
remote_or_drupal_id: <string> must use the following format "{product}:{remote_id}:{drupal_id},{product}:{remote_id}:{drupal_id}"
order_by: <string>
Parameters
- $query : Query
Tags
Return values
TransactionList|null —findOne()
Find one transaction
public
findOne(Query $query) : Transaction|null
Query parameter must have the following values:
organization_id: <string> T-hub Organization UUID
id: <string> e.g. txn_1jdm13H55HFKKAG2152818mBZzML
Parameters
- $query : Query
Tags
Return values
Transaction|null —findOneByUserId()
Find one User transaction
public
findOneByUserId(Query $query) : Transaction|null
Query parameter must have the following values:
user_id: <string> T-hub User UUID
id: <string> e.g. txn_1jdm13H55HFKKAG2152818mBZzML
Parameters
- $query : Query
Tags
Return values
Transaction|null —validateQuery()
public
validateQuery(Query $query, array<string|int, mixed> $requiredParameters) : mixed
Parameters
- $query : Query
- $requiredParameters : array<string|int, mixed>