KMP PHP API Reference

RecommendationsStatesLogsTable extends BaseTable
in package

Manages audit trail for recommendation state transitions.

Provides immutable state change logging for accountability and compliance. Integrates with RecommendationsTable.afterSave() for automatic logging.

See /docs/5.2.3-awards-recommendations-states-logs-table.md for complete documentation.

Tags
mixin

Table of Contents

Constants

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

Properties

$AwardsRecommendations  : RecommendationsTable|BelongsTo
$Timestamp  : TimestampBehavior|Behavior

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
Business rules for recommendation reference integrity.
deleteMany()  : iterable<string|int, RecommendationsStatesLog>|ResultSetInterface<string|int, RecommendationsStatesLog>|false
deleteManyOrFail()  : iterable<string|int, RecommendationsStatesLog>|ResultSetInterface<string|int, RecommendationsStatesLog>
findOrCreate()  : RecommendationsStatesLog
get()  : RecommendationsStatesLog
initialize()  : void
Initialize table settings, associations, and behaviors.
newEmptyEntity()  : RecommendationsStatesLog
newEntities()  : array<string|int, RecommendationsStatesLog>
newEntity()  : RecommendationsStatesLog
patchEntities()  : array<string|int, RecommendationsStatesLog>
patchEntity()  : RecommendationsStatesLog
save()  : RecommendationsStatesLog|false
saveMany()  : iterable<string|int, RecommendationsStatesLog>|ResultSetInterface<string|int, RecommendationsStatesLog>|false
saveManyOrFail()  : iterable<string|int, RecommendationsStatesLog>|ResultSetInterface<string|int, RecommendationsStatesLog>
saveOrFail()  : RecommendationsStatesLog
validationDefault()  : Validator
Default validation rules for state transition logs.
logImpersonationAction()  : void
Record impersonated writes to audit log table.

Constants

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

Properties

Methods

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()

Business rules for recommendation reference integrity.

public buildRules(RulesChecker $rules) : RulesChecker
Parameters
$rules : RulesChecker

The rules object to be modified.

Return values
RulesChecker

get()

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

initialize()

Initialize table settings, associations, and behaviors.

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

The configuration for the Table.

patchEntities()

public patchEntities(iterable<string|int, mixed> $entities, array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : array<string|int, RecommendationsStatesLog>
Parameters
$entities : iterable<string|int, mixed>
$data : array<string|int, mixed>
$options : array<string|int, mixed> = = '[]'
Return values
array<string|int, RecommendationsStatesLog>

validationDefault()

Default validation rules for state transition logs.

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


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results