PlacementUtils
in package
Shared functions for Afform Placements
A Placement is an existing place in which an Afform can be inserted, e.g. the Contact Summary Screen.
The list of placements is in the afform_placement option group.
Table of Contents
Methods
- filterContactTypes() : array<string|int, mixed>
- Resolve a mixed list of contact types and sub-types into just top-level contact types (Individual, Organization, Household)
- getAfformContextOptions() : array<string|int, mixed>
- getAfformsForPlacement() : array<string|int, mixed>
- getEntityTypeFilterFields() : array<string|int, mixed>
- getEntityTypeFilterLabel() : string|null
- getEntityTypeFilterName() : string|null
- getEntityTypeFilterOptions() : array<string|int, mixed>|null
- getEntityTypeId() : string
- getPlacements() : array<string|int, mixed>
- matchesContextFilters() : bool
Methods
filterContactTypes()
Resolve a mixed list of contact types and sub-types into just top-level contact types (Individual, Organization, Household)
public
static filterContactTypes(array<string|int, mixed> $mixedTypes) : array<string|int, mixed>
Parameters
- $mixedTypes : array<string|int, mixed>
Return values
array<string|int, mixed>getAfformContextOptions()
public
static getAfformContextOptions(string $placement, array<string|int, mixed> $context) : array<string|int, mixed>
Parameters
- $placement : string
- $context : array<string|int, mixed>
Return values
array<string|int, mixed>getAfformsForPlacement()
public
static getAfformsForPlacement(string $placement) : array<string|int, mixed>
Parameters
- $placement : string
Return values
array<string|int, mixed>getEntityTypeFilterFields()
public
static getEntityTypeFilterFields(string $entityName[, bool $addSuffix = false ]) : array<string|int, mixed>
Parameters
- $entityName : string
- $addSuffix : bool = false
Return values
array<string|int, mixed>getEntityTypeFilterLabel()
public
static getEntityTypeFilterLabel(string $entityName) : string|null
Parameters
- $entityName : string
Return values
string|nullgetEntityTypeFilterName()
public
static getEntityTypeFilterName(string $entityName) : string|null
Parameters
- $entityName : string
Return values
string|nullgetEntityTypeFilterOptions()
public
static getEntityTypeFilterOptions(string $entityName) : array<string|int, mixed>|null
Parameters
- $entityName : string
Return values
array<string|int, mixed>|nullgetEntityTypeId()
public
static getEntityTypeId(string $entityName) : string
Parameters
- $entityName : string
Return values
stringgetPlacements()
public
static getPlacements() : array<string|int, mixed>
Return values
array<string|int, mixed>matchesContextFilters()
public
static matchesContextFilters(string $placement, array<string|int, mixed> $afform, array<string|int, mixed> &$context) : bool
Parameters
- $placement : string
- $afform : array<string|int, mixed>
- $context : array<string|int, mixed>