1. class
  2. Civi
  3. \
  4. Api4
  5. \
  6. Service
  7. \
  8. Schema
  9. \
  10. Joiner

Joiner

class Joiner

Properties

protected SchemaMap $schemaMap
protected Joinable[][] $cache

Methods

__construct(SchemaMap $schemaMap)

No description

Joinable[]
join(Api4SelectQuery $query, string $joinPath, string $side = 'LEFT')

No description

bool
canJoin(Api4SelectQuery $query, $joinPath)

No description

array
getPath(string $baseTable, string $joinPath)

No description

Details

at line 56
__construct(SchemaMap $schemaMap)

Parameters

SchemaMap $schemaMap

at line 72
Joinable[] join(Api4SelectQuery $query, string $joinPath, string $side = 'LEFT')

Parameters

Api4SelectQuery $query The query object to do the joins on
string $joinPath A path of aliases in dot notation, e.g. contact.phone
string $side Can be LEFT or INNER

Return Value

Joinable[] The path used to make the join

Exceptions

Exception

at line 96
bool canJoin(Api4SelectQuery $query, $joinPath)

Parameters

Api4SelectQuery $query
$joinPath

Return Value

bool

at line 107
protected array getPath(string $baseTable, string $joinPath)

Parameters

string $baseTable
string $joinPath

Return Value

array

Exceptions

Exception