KMP PHP API Reference

MembersController extends AppController
in package

Application

uses QueuedMailerAwareTrait, MailerAwareTrait, DataverseGridTrait

Manages member CRUD, authentication, profiles, and member discovery.

Handles login/logout, password reset, registration, member search, mobile card display, and verification workflows. Uses DataverseGridTrait for index listing with server-side filtering.

Constants

VIEW_DATA_EVENT = 'KMP.plugins.callForViewData'
VIEW_PLUGIN_EVENT = 'KMP.plugins.callForViewCells'
QUICK_LOGIN_LOCKOUT_SECONDS = 300: Quick PIN lockout window in seconds.
QUICK_LOGIN_MAX_PIN_ATTEMPTS = 5: Maximum failed quick PIN attempts before temporary lockout.
QUICK_LOGIN_SETUP_SESSION_KEY = 'QuickLoginSetup': Session key for deferred quick-login PIN setup.

Properties

$inject : array<string|int, string>
$Members : MembersTable
$csvExportService : CsvExportService
$isCsvRequest : bool
$mailer : Mailer
$pluginViewCells : array<string|int, mixed>
$quickLoginDisabledEmailForRequest : string: Request-scoped email used to prefill password login after quick-login reset.
$quickLoginDisabledForRequest : bool: Request-scoped flag to instruct login UI to clear stale quick-login config.

Methods

add() : mixed: Create new member with age-based status and email notifications.
autoComplete() : mixed: Auto complete.
beforeFilter() : void: Configure authorization and authentication filters.
changePassword() : mixed: Change password.
delete() : Response|null: Delete method
edit() : Response|null|void: Edit method
editAdditionalInfo() : mixed: Edit additional info.
emailTaken() : mixed: Email taken.
forgotPassword() : mixed: Forgot password.
gatheringsGridData() : Response|null|void: Gathering attendances grid data for Gatherings tab in member profile.
gridData() : Response|null|void: Dataverse grid data endpoint for members listing.
impersonate() : Response|null: Begin impersonating another member (super user only).
importExpirationDates() : mixed: Import Member Expiration dates from CSV based on Membership number
index() : Response|null|void: Display member listing with Dataverse grid (saved views, filters, sorting).
initialize() : void: Load shared components: Authentication, Authorization, Flash.
isCsvRequest() : bool: Check if current request is for CSV export.
login() : mixed: login logic
logout() : mixed: Logout.
mobileCardPhoto() : Response: Stream the authenticated member's mobile profile photo.
mobileCardUploadProfilePhoto() : Response: Upload a profile photo from the mobile card flow.
partialEdit() : mixed: Partial edit.
profile() : Response|null|void: Profile method
profilePhoto() : Response: Stream a member profile photo document inline.
publicProfile() : mixed: Public profile.
register() : mixed: Register.
removeProfilePhoto() : Response: Remove a member profile photo and underlying document atomically.
removeQuickLoginDevice() : Response: Remove an enrolled quick-login device.
resetPassword() : mixed: Reset password.
rolesGridData() : Response|null|void: Member roles grid data for Roles tab in member profile.
searchMembers() : mixed: Search members.
sendMobileCardEmail() : mixed: Send mobile card email.
setupQuickLoginPin() : Response|null|void: Collect and save a quick-login PIN after a successful password login.
stopImpersonating() : Response|null: Stop impersonating and restore original super user identity.
submitScaMemberInfo() : mixed: Submit sca member info.
subRow() : void: Return sub-row content for expandable grid rows.
switchView() : Response: Switch between mobile and desktop view modes.
uploadProfilePhoto() : Response: Upload and assign a member profile photo.
verifyMembership() : mixed: Verify membership.
verifyQueue() : Response|null|void: Display member verification queue for administrative processing.
verifyQueueGridData() : Response|null|void: Dataverse grid data endpoint for verification queue.
view() : Response|null|void: Display detailed member profile with relationships and management tools.
viewCard() : mixed: View card.
viewCardJson() : mixed: View card json.
viewMobileCard() : mixed: View mobile card.
viewMobileCardJson() : mixed: View mobile card json.
_addRolesSelectAndContain() : mixed: Internal: add roles select and contain.
applyCustomFilterHandlers() : SelectQuery: Apply custom filter handlers for columns with complex filtering logic
applyVerifyQueueBaseFilter() : SelectQuery: Apply base filter for verification queue (all items needing verification)
authorizeCurrentUrl() : void: Authorize the current URL/action via Authorization component.
buildDataverseGridState() : array<string|int, mixed>: Build complete grid state object (single source of truth)
buildExportDataFromEntities() : array<string|int, mixed>: Build export data from pre-processed entities (Data Mode)
buildExportDataFromQuery() : array<string|int, mixed>: Build export data from database query (Query Mode)
extractExportValue() : string: Extract export value from entity using column metadata
extractFilterFromExpression() : mixed: Recursively extract a filter value from an expression tree
extractFilterFromSystemView() : mixed: Extract a specific filter value from a system view configuration
extractFilterFromViewConfig() : mixed: Extract a specific filter value from a saved user view's config
extractFilterGrouping() : array<string|int, mixed>: Extract filter grouping information from expression tree
extractSystemViewDefaults() : array{filters: array, dateRange: array, search: ?string, skipFilterColumns: array}: Extract default filters/search metadata for a system view configuration
formatExportValue() : string: Format value for CSV export
getVerifyQueueSystemViewCounts() : array<string, int>: Get record counts for each verify queue system view.
handleCsvExport() : Response: Handle CSV export from grid result
isCsvExportRequest() : bool: Check if the current request is for CSV export
loadFilterOptions() : array<string|int, mixed>: Load filter options from a data source
organizeViewCells() : array<string|int, mixed>: Organize view cells by type and display order.
processDataverseGrid() : array<string|int, mixed>: Process dataverse grid request with unified logic
queueMail() : Mailer: Returns a mailer instance.
queueMailJob() : void: Queues a mail job to be processed later.
resolveNestedValue() : mixed: Resolve nested value from entity using dot notation path
sendMailNow() : Mailer: Returns a mailer instance.
attemptQuickPinLogin() : Response|null: Attempt authentication using quick-login PIN credentials from the login form.
clearPendingQuickLoginSetup() : void: Clear any pending quick-login setup state from the current session.
defaultPostLoginRedirectTarget() : array<string, string>: Determine the default post-login destination based on device type.
flagQuickLoginOutOfSync() : void: Mark quick login as out of sync and prompt password re-authentication.
getProxyHeaders() : array<string, string>: Extract proxy headers relevant for geolocation from the current request.
isQuickLoginAccountEligible() : bool: Check whether a member is eligible for quick-login PIN authentication.
isSafeInternalRedirectPath() : bool: Validate whether a redirect path is an internal URL safe for post-login navigation.
legacyIndex() : mixed: Legacy paginated member listing (deprecated, use index with Dataverse grid).
markQuickPinLoginSuccess() : void: Reset lockout counters and timestamps after successful quick PIN login.
maybeQueueQuickLoginPinSetup() : Response|null: Queue quick-login PIN setup after successful password login when requested.
redirectAfterSuccessfulLogin() : Response: Redirect after successful login.
resolvePostLoginRedirectTarget() : array<string|int, mixed>|string: Resolve where the member should land after a successful sign-in.

VIEW_DATA_EVENT


    public
        string
    VIEW_DATA_EVENT
    = 'KMP.plugins.callForViewData'

Event for plugin view data enhancement

VIEW_PLUGIN_EVENT


    public
        string
    VIEW_PLUGIN_EVENT
    = 'KMP.plugins.callForViewCells'

Event for plugin view cell registration

QUICK_LOGIN_LOCKOUT_SECONDS

Quick PIN lockout window in seconds.


    private
        mixed
    QUICK_LOGIN_LOCKOUT_SECONDS
    = 300

QUICK_LOGIN_MAX_PIN_ATTEMPTS

Maximum failed quick PIN attempts before temporary lockout.


    private
        mixed
    QUICK_LOGIN_MAX_PIN_ATTEMPTS
    = 5

QUICK_LOGIN_SETUP_SESSION_KEY

Session key for deferred quick-login PIN setup.


    private
        mixed
    QUICK_LOGIN_SETUP_SESSION_KEY
    = 'QuickLoginSetup'

$inject


        public
        static    array<string|int, string>
    $inject
     = [\App\Services\CsvExportService::class]

Service injection configuration

$Members


        public
            MembersTable
    $Members

$csvExportService


        protected
            CsvExportService
    $csvExportService

$isCsvRequest


        protected
            bool
    $isCsvRequest
     = false

Whether current request is for CSV export (.csv extension)

$mailer


        protected
            Mailer
    $mailer

$pluginViewCells


        protected
            array<string|int, mixed>
    $pluginViewCells
     = []

View cells from plugins for current request

$quickLoginDisabledEmailForRequest

Request-scoped email used to prefill password login after quick-login reset.


        private
            string
    $quickLoginDisabledEmailForRequest
     = ''

$quickLoginDisabledForRequest

Request-scoped flag to instruct login UI to clear stale quick-login config.


        private
            bool
    $quickLoginDisabledForRequest
     = false

add()

Create new member with age-based status and email notifications.


    public
                    add() : mixed

Adults get STATUS_ACTIVE with password reset email. Minors get STATUS_UNVERIFIED_MINOR requiring verification. Generates mobile card token and sends appropriate notifications.

autoComplete()

Auto complete.


    public
                    autoComplete(MemberSearchService $searchService) : mixed

Parameters

$searchService : MemberSearchService

beforeFilter()

Configure authorization and authentication filters.


    public
                    beforeFilter(EventInterface $event) : void

Parameters

$event : EventInterface: The beforeFilter event

changePassword()

Change password.


    public
                    changePassword([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

delete()

Delete method


    public
                    delete([string|null $id = null ]) : Response|null

Parameters

$id : string|null = null: Member id.

Return values

Response|null —

Redirects to index.

edit()

Edit method


    public
                    edit([string|null $id = null ]) : Response|null|void

Parameters

$id : string|null = null: Member id.

Return values

Response|null|void —

Redirects on successful edit, renders view otherwise.

editAdditionalInfo()

Edit additional info.


    public
                    editAdditionalInfo([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

emailTaken()

Email taken.


    public
                    emailTaken(MemberSearchService $searchService) : mixed

Parameters

$searchService : MemberSearchService

forgotPassword()

Forgot password.


    public
                    forgotPassword(MemberAuthenticationService $authService) : mixed

Parameters

$authService : MemberAuthenticationService

gatheringsGridData()

Gathering attendances grid data for Gatherings tab in member profile.


    public
                    gatheringsGridData(int $memberId) : Response|null|void

Parameters

$memberId : int: The member ID

Return values

Response|null|void

gridData()

Dataverse grid data endpoint for members listing.


    public
                    gridData(CsvExportService $csvExportService) : Response|null|void

Handles toolbar+table frame, table-only frame, and CSV export.

Parameters

$csvExportService : CsvExportService: CSV export service

Return values

Response|null|void

impersonate()

Begin impersonating another member (super user only).


    public
                    impersonate(int $memberId, ImpersonationService $impersonationService) : Response|null

Parameters

$memberId : int: Target member ID
$impersonationService : ImpersonationService: Session helper

Return values

Response|null

importExpirationDates()

Import Member Expiration dates from CSV based on Membership number


    public
                    importExpirationDates() : mixed

index()

Display member listing with Dataverse grid (saved views, filters, sorting).


    public
                    index() : Response|null|void

Return values

Response|null|void

initialize()

Load shared components: Authentication, Authorization, Flash.


    public
                    initialize() : void

isCsvRequest()

Check if current request is for CSV export.


    public
                    isCsvRequest() : bool

Return values

bool

login()


    public
                    login(MemberAuthenticationService $authService, QuickLoginDeviceService $quickLoginService) : mixed

Parameters

$authService : MemberAuthenticationService
$quickLoginService : QuickLoginDeviceService

logout()

Logout.


    public
                    logout() : mixed

mobileCardPhoto()

Stream the authenticated member's mobile profile photo.


    public
                    mobileCardPhoto(MemberProfileService $profileService) : Response

Parameters

$profileService : MemberProfileService

Return values

Response —

Inline file response

mobileCardUploadProfilePhoto()

Upload a profile photo from the mobile card flow.


    public
                    mobileCardUploadProfilePhoto(MemberProfileService $profileService[, string|null $id = null ]) : Response

Parameters

$profileService : MemberProfileService
$id : string|null = null

Return values

Response —

Redirect response

partialEdit()

Partial edit.


    public
                    partialEdit([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

profile()

Profile method


    public
                    profile() : Response|null|void

Shows the current user's profile without changing the URL

Return values

Response|null|void —

Renders view

profilePhoto()

Stream a member profile photo document inline.


    public
                    profilePhoto(MemberProfileService $profileService[, int|null $id = null ]) : Response

Parameters

$profileService : MemberProfileService
$id : int|null = null: Member ID

Return values

Response —

Inline file response

publicProfile()

Public profile.


    public
                    publicProfile([mixed $publicId = null ]) : mixed

Parameters

$publicId : mixed = null

register()


    public
                    register(MemberRegistrationService $regService) : mixed

Parameters

$regService : MemberRegistrationService

removeProfilePhoto()

Remove a member profile photo and underlying document atomically.


    public
                    removeProfilePhoto(MemberProfileService $profileService[, int|null $id = null ]) : Response

Parameters

$profileService : MemberProfileService
$id : int|null = null: Member ID

Return values

Response —

Redirect response

removeQuickLoginDevice()

Remove an enrolled quick-login device.


    public
                    removeQuickLoginDevice([string|null $id = null ]) : Response

Parameters

$id : string|null = null: Quick login device record ID

Return values

Response

resetPassword()

Reset password.


    public
                    resetPassword(MemberAuthenticationService $authService[, mixed $token = null ]) : mixed

Parameters

$authService : MemberAuthenticationService
$token : mixed = null

rolesGridData()

Member roles grid data for Roles tab in member profile.


    public
                    rolesGridData(int $memberId) : Response|null|void

Parameters

$memberId : int: The member ID

Return values

Response|null|void

searchMembers()

Search members.


    public
                    searchMembers(MemberSearchService $searchService) : mixed

Parameters

$searchService : MemberSearchService

sendMobileCardEmail()

Send mobile card email.


    public
                    sendMobileCardEmail(MemberProfileService $profileService[, mixed $id = null ]) : mixed

Parameters

$profileService : MemberProfileService
$id : mixed = null

setupQuickLoginPin()

Collect and save a quick-login PIN after a successful password login.


    public
                    setupQuickLoginPin(QuickLoginDeviceService $quickLoginService) : Response|null|void

Parameters

$quickLoginService : QuickLoginDeviceService

Return values

Response|null|void

stopImpersonating()

Stop impersonating and restore original super user identity.


    public
                    stopImpersonating(ImpersonationService $impersonationService) : Response|null

Parameters

$impersonationService : ImpersonationService: Session helper

Return values

Response|null

submitScaMemberInfo()

Submit sca member info.


    public
                    submitScaMemberInfo(MemberRegistrationService $regService) : mixed

Parameters

$regService : MemberRegistrationService

subRow()

Return sub-row content for expandable grid rows.


    public
                    subRow([string|null $id = null ][, string|null $type = null ]) : void

Parameters

$id : string|null = null: Member ID
$type : string|null = null: Type of sub-row content (e.g., 'warrantreasons')

switchView()

Switch between mobile and desktop view modes.


    public
                    switchView() : Response

Stores preference in session and redirects to appropriate interface. Mobile redirects to viewMobileCard, desktop to profile.

Return values

Response —

Redirect response

uploadProfilePhoto()

Upload and assign a member profile photo.


    public
                    uploadProfilePhoto(MemberProfileService $profileService) : Response

Parameters

$profileService : MemberProfileService

Return values

Response —

Redirect response

verifyMembership()

Verify membership.


    public
                    verifyMembership([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

verifyQueue()

Display member verification queue for administrative processing.


    public
                    verifyQueue() : Response|null|void

Shows members needing verification: card validation, age/parent verification.

Return values

Response|null|void

verifyQueueGridData()

Dataverse grid data endpoint for verification queue.


    public
                    verifyQueueGridData() : Response|null|void

Handles toolbar+table frame, table-only frame for members needing verification.

Return values

Response|null|void

view()

Display detailed member profile with relationships and management tools.


    public
                    view([string|null $id = null ]) : Response|null|void

Loads roles, branch, parent, current/upcoming/previous role assignments, and gathering attendances. Handles session-based form error display.

Parameters

$id : string|null = null: Member ID to display

Return values

Response|null|void

viewCard()

View card.


    public
                    viewCard([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

viewCardJson()

View card json.


    public
                    viewCardJson([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

viewMobileCard()

View mobile card.


    public
                    viewMobileCard([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

viewMobileCardJson()

View mobile card json.


    public
                    viewMobileCardJson([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

_addRolesSelectAndContain()

Internal: add roles select and contain.


    protected
                    _addRolesSelectAndContain(SelectQuery $q) : mixed

Parameters

$q : SelectQuery

applyCustomFilterHandlers()

Apply custom filter handlers for columns with complex filtering logic


    protected
                    applyCustomFilterHandlers(SelectQuery $query, array<string|int, mixed> $customFilterColumns, string $tableName, bool $canFilter, array<string|int, mixed> $currentFilters, mixed $currentView, array<string|int, mixed>|null $selectedSystemView, bool $dirtyFilters) : SelectQuery

Columns can define a customFilterHandler in their metadata to specify a static method that handles their filtering. This allows complex filter logic (like querying multiple tables) to be defined alongside the column definition rather than requiring special controller knowledge.

Filter values are extracted from:

Query string parameters (user-applied filters)
Saved user view configuration (when loading a saved view)
System view configuration (when loading a system view)

Parameters

$query : SelectQuery: The query to filter
$customFilterColumns : array<string|int, mixed>: Columns with customFilterHandler defined
$tableName : string: The main table name
$canFilter : bool: Whether user filtering is enabled
$currentFilters : array<string|int, mixed>: Current filter values from query params
$currentView : mixed: Current saved user view (or null)
$selectedSystemView : array<string|int, mixed>|null: Current system view config (or null)
$dirtyFilters : bool: Whether user explicitly modified filters

Return values

SelectQuery —

The filtered query

applyVerifyQueueBaseFilter()

Apply base filter for verification queue (all items needing verification)


    protected
                    applyVerifyQueueBaseFilter(SelectQuery $query) : SelectQuery

Parameters

$query : SelectQuery: Base query to filter

Return values

SelectQuery —

Filtered query

authorizeCurrentUrl()

Authorize the current URL/action via Authorization component.


    protected
                    authorizeCurrentUrl() : void

buildDataverseGridState()

Build complete grid state object (single source of truth)


    protected
                    buildDataverseGridState(mixed $currentView, array<string|int, mixed>|null $selectedSystemView, array<string|int, mixed>|null $systemViews, iterable<string|int, mixed> $availableViews, Member|null $currentMember, string|int|null $preferredViewId, string $search, array<string|int, mixed> $filters, array<string|int, mixed> $filterOptions, array<string|int, mixed> $dropdownFilterColumns, array<string|int, mixed> $dateRangeFilterColumns, array<string|int, mixed> $sort, array<string|int, mixed> $visibleColumns, array<string|int, mixed> $allColumns, string $gridKey, int $pageSize, bool $showAllTab, bool $canAddViews, bool $canFilter, bool $hasSearch, bool $hasDropdownFilters, bool $hasDateRangeFilters, array<string|int, mixed> $skipFilterColumns, bool $canExportCsv, bool $showFilterPills, bool $showViewTabs, bool $enableColumnPicker[, array<string|int, mixed> $lockedFilters = [] ][, bool $enableBulkSelection = false ][, array<string|int, mixed> $bulkActions = [] ]) : array<string|int, mixed>

Parameters

$currentView : mixed: Current saved view entity (null for system views or "All")
$selectedSystemView : array<string|int, mixed>|null: Currently selected system view
$systemViews : array<string|int, mixed>|null: All available system views
$availableViews : iterable<string|int, mixed>: Collection of saved views
$currentMember : Member|null: Authenticated member
$preferredViewId : string|int|null: Preferred view ID from user preferences
$search : string: Current search term
$filters : array<string|int, mixed>: Active filters by column key
$filterOptions : array<string|int, mixed>: Available filter options by column key
$dropdownFilterColumns : array<string|int, mixed>: Metadata for filterable columns
$dateRangeFilterColumns : array<string|int, mixed>
$sort : array<string|int, mixed>: Current sort configuration
$visibleColumns : array<string|int, mixed>: Array of visible column keys
$allColumns : array<string|int, mixed>: Complete column metadata
$gridKey : string: Unique grid identifier
$pageSize : int: Number of rows per page
$showAllTab : bool: Whether to show "All" tab
$canAddViews : bool: Whether users can create custom views
$canFilter : bool: Whether filtering is enabled
$hasSearch : bool
$hasDropdownFilters : bool
$hasDateRangeFilters : bool
$skipFilterColumns : array<string|int, mixed>: Columns with filter UI but not query application
$canExportCsv : bool: Whether CSV export button is shown
$showFilterPills : bool: Whether active filter pills/badges are displayed
$showViewTabs : bool: Whether view tabs are displayed
$enableColumnPicker : bool: Whether column picker is available
$lockedFilters : array<string|int, mixed> = []: Filter column keys that cannot be removed by users
$enableBulkSelection : bool = false
$bulkActions : array<string|int, mixed> = []

Return values

array<string|int, mixed> —

Complete grid state

buildExportDataFromEntities()

Build export data from pre-processed entities (Data Mode)


    protected
                    buildExportDataFromEntities(iterable<string|int, mixed> $data, array<string|int, mixed> $visibleColumns, array<string|int, mixed> $columnsMetadata) : array<string|int, mixed>

Extracts values from entities using column metadata configuration. Supports virtual properties, nested relations via renderField, and custom exportValue callbacks.

Parameters

$data : iterable<string|int, mixed>: Pre-processed entities or arrays
$visibleColumns : array<string|int, mixed>: List of visible column keys
$columnsMetadata : array<string|int, mixed>: Column configuration metadata

Return values

array<string|int, mixed> —

Transformed data ready for CSV export

buildExportDataFromQuery()

Build export data from database query (Query Mode)


    protected
                    buildExportDataFromQuery(Query $query, array<string|int, mixed> $visibleColumns, array<string|int, mixed> $columnsMetadata, string $tableName) : array<string|int, mixed>

Builds SQL SELECT statements and executes query for simple database fields. Best for exports that don't require computed fields.

Parameters

$query : Query: Database query to execute
$visibleColumns : array<string|int, mixed>: List of visible column keys
$columnsMetadata : array<string|int, mixed>: Column configuration metadata
$tableName : string: Full table name for model alias extraction

Return values

array<string|int, mixed> —

Transformed data ready for CSV export

extractExportValue()

Extract export value from entity using column metadata


    protected
                    extractExportValue(mixed $entity, string $columnKey, array<string|int, mixed> $columnMeta) : string

Resolution order:

exportValue callback if defined in column metadata
renderField path for nested entity access (e.g., 'member.name_for_herald')
Direct property access using column key

Parameters

$entity : mixed: Entity or array to extract value from
$columnKey : string: Column key identifier
$columnMeta : array<string|int, mixed>: Column metadata configuration

Return values

string —

Extracted and formatted value

extractFilterFromExpression()

Recursively extract a filter value from an expression tree


    protected
                    extractFilterFromExpression(array<string|int, mixed> $expression, string $columnKey) : mixed

Parameters

$expression : array<string|int, mixed>: The expression node to search
$columnKey : string: The column key to find

Return values

mixed —

The filter value or null if not found

extractFilterFromSystemView()

Extract a specific filter value from a system view configuration


    protected
                    extractFilterFromSystemView(array<string|int, mixed> $systemView, string $columnKey) : mixed

Parameters

$systemView : array<string|int, mixed>: The system view configuration
$columnKey : string: The column key to find

Return values

mixed —

The filter value or null if not found

extractFilterFromViewConfig()

Extract a specific filter value from a saved user view's config


    protected
                    extractFilterFromViewConfig(mixed $view, string $columnKey) : mixed

Parameters

$view : mixed: The GridView entity
$columnKey : string: The column key to find

Return values

mixed —

The filter value or null if not found

extractFilterGrouping()

Extract filter grouping information from expression tree


    protected
                    extractFilterGrouping(array<string|int, mixed>|null $selectedSystemView, array<string|int, mixed> $skipFilterColumns) : array<string|int, mixed>

Analyzes the expression tree to determine OR relationships between filters. Returns metadata that the frontend can use to display visual OR indicators.

Parameters

$selectedSystemView : array<string|int, mixed>|null: Currently active system view
$skipFilterColumns : array<string|int, mixed>: Columns that show as pills but don't query

Return values

array<string|int, mixed> —

Grouping metadata with 'orGroups' array

extractSystemViewDefaults()

Extract default filters/search metadata for a system view configuration


    protected
                    extractSystemViewDefaults(array<string, mixed> $systemViewConfig) : array{filters: array, dateRange: array, search: ?string, skipFilterColumns: array}

Parameters

$systemViewConfig : array<string, mixed>: Raw system view config

Return values

array{filters: array, dateRange: array, search: ?string, skipFilterColumns: array}

formatExportValue()

Format value for CSV export


    protected
                    formatExportValue(mixed $value) : string

Handles various data types and converts to string representation.

Parameters

$value : mixed: Value to format

Return values

string —

Formatted string value

getVerifyQueueSystemViewCounts()

Get record counts for each verify queue system view.


    protected
                    getVerifyQueueSystemViewCounts() : array<string, int>

Return values

array<string, int>

handleCsvExport()

Handle CSV export from grid result


    protected
                    handleCsvExport(array<string|int, mixed> $result, CsvExportService $csvExportService, string $entityName[, string|null $tableName = null ][, iterable<string|int, mixed>|null $data = null ]) : Response

Generates a CSV export response from the grid processing result. Supports two modes:

Query Mode (default): Uses the query from result to build SQL SELECT statements. Best for simple fields that map directly to database columns.
Data Mode: Pass pre-processed data with computed/virtual fields already populated. Best for exports that include calculated fields, virtual properties, or complex transformations that can't be done in SQL.

Column Value Resolution (in order of precedence):

exportValue callback in column metadata - custom formatting function
renderField path (e.g., 'member.name_for_herald') - for nested entity access
queryField for relation columns in query mode
Direct column key access on entity/array

Parameters

$result : array<string|int, mixed>: Result from processDataverseGrid() with isCsvExport flag
$csvExportService : CsvExportService: CSV export service instance
$entityName : string: Base name for the export file (e.g., 'members', 'warrants')
$tableName : string|null = null: Optional table name for fetchTable (e.g., 'Awards.Recommendations' for plugin tables) If not provided, uses ucfirst($entityName)
$data : iterable<string|int, mixed>|null = null: Optional pre-processed data. If provided, uses data mode instead of query mode. Data should be an iterable of entities or arrays with all computed fields populated.

Return values

Response —

CSV download response

isCsvExportRequest()

Check if the current request is for CSV export


    protected
                    isCsvExportRequest() : bool

Return values

bool —

True if CSV export is requested

loadFilterOptions()

Load filter options from a data source


    protected
                    loadFilterOptions(array<string|int, mixed>|string $source) : array<string|int, mixed>

Supports multiple formats for filterOptionsSource:

Simple string (table name): Uses 'id' for value, 'name' for label
```
'filterOptionsSource' => 'Branches'
```

Array with table: Database table with full control

'filterOptionsSource' => [
    'table' => 'Waivers.WaiverTypes',  // Required: table name for fetchTable()
    'valueField' => 'id',              // Optional: field for option value (default: 'id')
    'labelField' => 'name',            // Optional: field for option label (default: 'name')
    'conditions' => ['is_active' => true],  // Optional: filter conditions
    'order' => ['name' => 'ASC'],      // Optional: sort order (default: labelField ASC)
]

Array with appSetting: Load from app settings (YAML array)
```
'filterOptionsSource' => [
    'appSetting' => 'Branches.Types',  // Required: app setting key
]
```
The app setting should contain a YAML array like: ['Kingdom', 'Principality', 'Barony'] Both value and label will be set to the array item value.

Array with method: Call a static method on a class to get options

'filterOptionsSource' => [
    'method' => 'getGatheringsFilterOptions',  // Required: static method name
    'class' => 'Awards\\KMP\\GridColumns\\RecommendationsGridColumns',  // Required: fully qualified class name
]

The method should return array of ['value' => string, 'label' => string].

Parameters

$source : array<string|int, mixed>|string: Source identifier string (table name) or configuration array

Return values

array<string|int, mixed> —

Filter options as array of ['value' => string, 'label' => string]

organizeViewCells()

Organize view cells by type and display order.


    protected
                    organizeViewCells(array<string|int, mixed> $viewCells) : array<string|int, mixed>

Unused - view cells organized in ViewCellRegistry

Parameters

$viewCells : array<string|int, mixed>: Flat array of view cell configurations

Return values

array<string|int, mixed> —

Organized array grouped by type and sorted by order

processDataverseGrid()

Process dataverse grid request with unified logic


    protected
                    processDataverseGrid(array<string|int, mixed> $config) : array<string|int, mixed>

This method handles all aspects of grid processing including view management, filtering, searching, sorting, and pagination. It supports both saved user views and system-defined views.

Parameters

$config : array<string|int, mixed>

Grid configuration with the following keys:

gridKey (string): Unique identifier for the grid
gridColumnsClass (string): Fully qualified class name for grid columns metadata
baseQuery (Query): Base query object to start with
tableName (string): Primary table name for field qualification
defaultSort (array): Default sort configuration ['field' => 'direction']
defaultPageSize (int): Default number of records per page (default: 25)
systemViews (array|null): Optional array of system views (for Warrants-style grids)
defaultSystemView (string|null): Default system view key (required if systemViews provided)
queryCallback (callable|null): Optional callback to modify query per system view
showAllTab (bool): Whether to show "All" tab (default: true for saved views, false for system views)
canAddViews (bool): Whether users can create custom views (default: true)
canFilter (bool): Whether user filtering is enabled (default: true). When false, users cannot add/remove filters via the UI or query parameters. However, filters defined by system views are ALWAYS applied regardless of this setting.
canExportCsv (bool): Whether CSV export button is shown (default: true)
showFilterPills (bool): Whether active filter pills/badges are displayed (default: true)
showViewTabs (bool): Whether view tabs are displayed (default: true)
enableColumnPicker (bool): Whether column picker is available (default: true)
lockedFilters (array): Array of filter column keys that cannot be removed by users. Locked filters will not show remove (×) buttons and their values cannot be cleared via query string parameters. Useful for embedded grids where context filters (e.g., member_id) must always be applied.
enableBulkSelection (bool): Whether row selection checkboxes are shown (default: false)
bulkActions (array): Array of bulk action button configurations when enableBulkSelection is true. Each action is an array with keys: label, icon, modalTarget, permission.

NOTE: Authorization scope must be applied to baseQuery BEFORE calling this method. Use $baseQuery = $this->Authorization->applyScope($baseQuery, 'index'); in your controller before passing the query to processDataverseGrid().

Return values

array<string|int, mixed> —

Result array with keys: data, gridState, columnsMetadata, etc.

queueMail()

Returns a mailer instance.


    protected
                    queueMail(string $name, mixed $action, mixed $to, mixed $vars) : Mailer

Parameters

$name : string: Mailer's name.
$action : mixed
$to : mixed
$vars : mixed

Return values

Mailer

queueMailJob()

Queues a mail job to be processed later.


    protected
                    queueMailJob(array<string|int, mixed> $data) : void

Parameters

$data : array<string|int, mixed>: Data to be passed to the mailer.

resolveNestedValue()

Resolve nested value from entity using dot notation path


    protected
                    resolveNestedValue(mixed $entity, string $path) : mixed

Parameters

$entity : mixed: Entity to traverse
$path : string: Dot-notation path (e.g., 'member.name_for_herald')

Return values

mixed —

Resolved value or null if path doesn't exist

sendMailNow()

Returns a mailer instance.


    protected
                    sendMailNow(array<string|int, mixed> $data) : Mailer

Parameters

$data : array<string|int, mixed>

Return values

Mailer

attemptQuickPinLogin()

Attempt authentication using quick-login PIN credentials from the login form.


    private
                    attemptQuickPinLogin(QuickLoginDeviceService $quickLoginService) : Response|null

Parameters

$quickLoginService : QuickLoginDeviceService: Quick-login device service.

Return values

Response|null —

Redirect response on successful login, otherwise null.

clearPendingQuickLoginSetup()

Clear any pending quick-login setup state from the current session.


    private
                    clearPendingQuickLoginSetup() : void

defaultPostLoginRedirectTarget()

Determine the default post-login destination based on device type.


    private
                    defaultPostLoginRedirectTarget() : array<string, string>

Return values

array<string, string>

flagQuickLoginOutOfSync()

Mark quick login as out of sync and prompt password re-authentication.


    private
                    flagQuickLoginOutOfSync(string $emailAddress) : void

Parameters

$emailAddress : string: Email used for the failed quick-login attempt.

getProxyHeaders()

Extract proxy headers relevant for geolocation from the current request.


    private
                    getProxyHeaders() : array<string, string>

Return values

array<string, string>

isQuickLoginAccountEligible()

Check whether a member is eligible for quick-login PIN authentication.


    private
                    isQuickLoginAccountEligible(Member $member) : bool

Parameters

$member : Member: Candidate member account.

Return values

bool —

True when account status and lockout state permit quick login.

isSafeInternalRedirectPath()

Validate whether a redirect path is an internal URL safe for post-login navigation.


    private
                    isSafeInternalRedirectPath(string $page) : bool

Parameters

$page : string: Redirect path from query string.

Return values

bool

legacyIndex()

Legacy paginated member listing (deprecated, use index with Dataverse grid).


    private
                    legacyIndex() : mixed

Supports search with Þ/th character conversion for medieval names.

markQuickPinLoginSuccess()

Reset lockout counters and timestamps after successful quick PIN login.


    private
                    markQuickPinLoginSuccess(Member $member) : void

Parameters

$member : Member: Authenticated member entity.

maybeQueueQuickLoginPinSetup()

Queue quick-login PIN setup after successful password login when requested.


    private
                    maybeQueueQuickLoginPinSetup(Member $member, array<string|int, mixed>|string $redirectTarget) : Response|null

Parameters

$member : Member: Authenticated member.
$redirectTarget : array<string|int, mixed>|string: Destination after login or setup skip.

Return values

Response|null —

Redirect to PIN setup or null when setup is not required.

redirectAfterSuccessfulLogin()

Redirect after successful login.


    private
                    redirectAfterSuccessfulLogin() : Response

Return values

Response

resolvePostLoginRedirectTarget()

Resolve where the member should land after a successful sign-in.


    private
                    resolvePostLoginRedirectTarget() : array<string|int, mixed>|string

Return values

array<string|int, mixed>|string

MembersController extends AppController in package Application uses QueuedMailerAwareTrait, MailerAwareTrait, DataverseGridTrait

Table of Contents

Constants

Properties

Methods

Constants

VIEW_DATA_EVENT

VIEW_PLUGIN_EVENT

QUICK_LOGIN_LOCKOUT_SECONDS

QUICK_LOGIN_MAX_PIN_ATTEMPTS

QUICK_LOGIN_SETUP_SESSION_KEY

Properties

$inject

$Members

$csvExportService

$isCsvRequest

$mailer

$pluginViewCells

$quickLoginDisabledEmailForRequest

$quickLoginDisabledForRequest

Methods

add()

Tags

autoComplete()

Parameters

beforeFilter()

Parameters

changePassword()

Parameters

delete()

Parameters

Tags

Return values

edit()

Parameters

Tags

Return values

editAdditionalInfo()

Parameters

emailTaken()

Parameters

forgotPassword()

Parameters

gatheringsGridData()

Parameters

Return values

gridData()

Parameters

Return values

impersonate()

Parameters

Tags

Return values

importExpirationDates()

index()

Return values

initialize()

isCsvRequest()

Return values

login()

Parameters

logout()

mobileCardPhoto()

Parameters

Return values

mobileCardUploadProfilePhoto()

Parameters

Return values

partialEdit()

Parameters

profile()

Return values

profilePhoto()

Parameters

Return values

publicProfile()

Parameters

register()

Parameters

removeProfilePhoto()

MembersController extends AppController
in package

Application

uses QueuedMailerAwareTrait, MailerAwareTrait, DataverseGridTrait