PeopleFinder
in package
implements
FinderInterface
Uses
ValidatesQueryTrait
Tags
Interfaces, Classes, Traits and Enums
Table of Contents
- $client : Client
- __construct() : mixed
- find() : FinderListInterface
- findOne() : Person|null
- Find one people object
- validateQuery() : mixed
Properties
$client
private
Client
$client
Tags
Methods
__construct()
public
__construct(Client $client) : mixed
Parameters
- $client : Client
Tags
Return values
mixed —find()
public
find(Query $query) : FinderListInterface
Parameters
- $query : Query
Tags
Return values
FinderListInterface —findOne()
Find one people object
public
findOne(Query $query) : Person|null
TS docs reference for more detailed descriptions
Query parameter must have the following values:
people_id: <string> UUID
organization_id: <string> T-hub Organization UUID
Parameters
- $query : Query
Tags
Return values
Person|null —validateQuery()
public
validateQuery(Query $query, array<string|int, mixed> $requiredParameters) : mixed
Parameters
- $query : Query
- $requiredParameters : array<string|int, mixed>