KMP PHP API Reference

ActivitiesTable extends BaseTable
in package

Application

Manages Activity entities for the Activities Plugin.

Provides data access, validation, and authorization-related queries for activities. Activities represent authorization types requiring member approval before participation.

Constants

CACHE_GROUPS_TO_CLEAR = []
CACHES_TO_CLEAR = []
ID_CACHES_TO_CLEAR = []

Properties

$ActivityGroups : ActivityGroupsTable|BelongsTo
$Authorizations : AuthorizationsTable|HasMany
$CurrentAuthorizations : AuthorizationsTable|HasMany
$PendingAuthorizations : AuthorizationsTable|HasMany
$Permissions : PermissionsTable|BelongsTo
$PreviousAuthorizations : AuthorizationsTable|HasMany
$Roles : RolesTable|BelongsTo
$UpcomingAuthorizations : AuthorizationsTable|HasMany

Methods

addBranchScopeQuery() : SelectQuery: Add branch-based data scoping to a query.
afterDelete() : void: After delete hook to capture impersonation audit trail entries.
afterSave() : void: After-save handler for automatic cache invalidation.
buildRules() : RulesChecker: Returns a rules checker object for validating application integrity.
canAuhtorizeAnyActivity() : bool: Check if user can authorize any activity (has authorization queue access).
canAuthorizeActivity() : bool: Check if user can authorize a specific activity.
get() : Activity
initialize() : void: Initialize method - configures table associations and behaviors.
newEmptyEntity() : Activity
newEntity() : Activity
save() : Activity|false
validationDefault() : Validator: Default validation rules.
logImpersonationAction() : void: Record impersonated writes to audit log table.

CACHE_GROUPS_TO_CLEAR


    protected
        array<string|int, string>
    CACHE_GROUPS_TO_CLEAR
    = []

Cache groups to clear entirely on save

CACHES_TO_CLEAR


    protected
        array<string|int, array{string, string}>
    CACHES_TO_CLEAR
    = []

Static cache entries to clear on save

ID_CACHES_TO_CLEAR


    protected
        array<string|int, array{string, string}>
    ID_CACHES_TO_CLEAR
    = []

Entity-ID cache prefixes to clear on save

$ActivityGroups


        public
            ActivityGroupsTable|BelongsTo
    $ActivityGroups

$Authorizations


        public
            AuthorizationsTable|HasMany
    $Authorizations

$CurrentAuthorizations


        public
            AuthorizationsTable|HasMany
    $CurrentAuthorizations

$PendingAuthorizations


        public
            AuthorizationsTable|HasMany
    $PendingAuthorizations

$Permissions


        public
            PermissionsTable|BelongsTo
    $Permissions

$PreviousAuthorizations


        public
            AuthorizationsTable|HasMany
    $PreviousAuthorizations

$Roles


        public
            RolesTable|BelongsTo
    $Roles

$UpcomingAuthorizations


        public
            AuthorizationsTable|HasMany
    $UpcomingAuthorizations

addBranchScopeQuery()

Add branch-based data scoping to a query.


    public
                    addBranchScopeQuery(SelectQuery $query, array<string|int, int> $branchIDs) : SelectQuery

Child tables should override for custom branch relationships.

Parameters

$query : SelectQuery: The query to modify
$branchIDs : array<string|int, int>: Authorized branch IDs

Return values

SelectQuery —

Query with branch filtering

afterDelete()

After delete hook to capture impersonation audit trail entries.


    public
                    afterDelete(EventInterface $event, EntityInterface $entity, ArrayObject $options) : void

Parameters

$event : EventInterface: Delete event
$entity : EntityInterface: Entity being deleted
$options : ArrayObject: Delete options

afterSave()

After-save handler for automatic cache invalidation.


    public
                    afterSave(EventInterface $event, EntityInterface $entity, ArrayObject $options) : void

Parameters

$event : EventInterface: The afterSave event
$entity : EntityInterface: The saved entity
$options : ArrayObject: Save options

buildRules()

Returns a rules checker object for validating application integrity.


    public
                    buildRules(RulesChecker $rules) : RulesChecker

Parameters

$rules : RulesChecker: The rules object to be modified.

Return values

RulesChecker

canAuhtorizeAnyActivity()

Check if user can authorize any activity (has authorization queue access).


    public
            static        canAuhtorizeAnyActivity(Member $user) : bool

Determines if user has permissions for any activities, enabling authorization queue display and workflow navigation.

Parameters

$user : Member: The user to check

Return values

bool —

True if user can authorize any activities

canAuthorizeActivity()

Check if user can authorize a specific activity.


    public
            static        canAuthorizeActivity(Member $user, int $activityId) : bool

Validates user has the required permission to authorize the specified activity.

Parameters

$user : Member: The user to check
$activityId : int: The activity ID to check

Return values

bool —

True if user can authorize the activity

get()


    public
                    get(mixed $primaryKey[, array<string|int, mixed>|string $finder =  = '\'all\'' ][, CacheInterface|string|null $cache =  = 'null' ][, Closure|string|null $cacheKey =  = 'null' ], mixed ...$args) : Activity

Parameters

$primaryKey : mixed
$finder : array<string|int, mixed>|string = = '\'all\''
$cache : CacheInterface|string|null = = 'null'
$cacheKey : Closure|string|null = = 'null'
$args : mixed

Return values

Activity

initialize()

Initialize method - configures table associations and behaviors.


    public
                    initialize(array<string, mixed> $config) : void

Parameters

$config : array<string, mixed>: The configuration for the Table.

newEmptyEntity()


    public
                    newEmptyEntity() : Activity

Return values

Activity

newEntity()


    public
                    newEntity(array<string|int, mixed> $data[, array<string|int, mixed> $options =  = '[]' ]) : Activity

Parameters

$data : array<string|int, mixed>
$options : array<string|int, mixed> = = '[]'

Return values

Activity

save()


    public
                    save(EntityInterface $entity[, array<string|int, mixed> $options =  = '[]' ]) : Activity|false

Parameters

$entity : EntityInterface
$options : array<string|int, mixed> = = '[]'

Return values

Activity|false

validationDefault()

Default validation rules.


    public
                    validationDefault(Validator $validator) : Validator

Parameters

$validator : Validator: Validator instance.

Return values

Validator

logImpersonationAction()

Record impersonated writes to audit log table.


    protected
                    logImpersonationAction(string $defaultOperation, EntityInterface $entity) : void

Parameters

$defaultOperation : string: Operation fallback (save/delete)
$entity : EntityInterface: Affected entity

ActivitiesTable extends BaseTable in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

CACHE_GROUPS_TO_CLEAR

CACHES_TO_CLEAR

ID_CACHES_TO_CLEAR

Properties

$ActivityGroups

$Authorizations

$CurrentAuthorizations

$PendingAuthorizations

$Permissions

$PreviousAuthorizations

$Roles

$UpcomingAuthorizations

Methods

addBranchScopeQuery()

Parameters

Return values

afterDelete()

Parameters

afterSave()

Parameters

buildRules()

Parameters

Return values

canAuhtorizeAnyActivity()

Parameters

Tags

Return values

canAuthorizeActivity()

Parameters

Tags

Return values

get()

Parameters

Return values

initialize()

Parameters

newEmptyEntity()

Return values

newEntity()

Parameters

Return values

save()

Parameters

Return values

validationDefault()

Parameters

Return values

logImpersonationAction()

Parameters

ActivitiesTable extends BaseTable
in package

Application