Heratio Framework API Reference

RicSyncService
in package
implements RicSyncContract

Table of Contents

Interfaces

RicSyncContract

Methods

__construct()  : mixed
bulkSync()  : array<string|int, mixed>
cleanupOrphanedTriples()  : array<string|int, mixed>
findInconsistencies()  : array<string|int, mixed>
findMissingRecords()  : array<string|int, mixed>
findOrphanedTriples()  : array<string|int, mixed>
fullResync()  : array<string|int, mixed>
getIntegritySchedule()  : string
Get the configured integrity check schedule (daily/weekly/monthly/disabled).
getSyncHistory()  : array<string|int, mixed>
getSyncStats()  : array<string|int, mixed>
handleBatchDeletion()  : array<string|int, mixed>
handleDeletion()  : int
handleMove()  : bool
isIntegrityCheckEnabled()  : bool
Check if integrity checks are enabled based on schedule setting.
logOperation()  : void
previewDeletion()  : array<string|int, mixed>
repairInconsistencies()  : array<string|int, mixed>
runIntegrityCheck()  : array<string|int, mixed>
syncRecord()  : bool
updateHierarchy()  : int

Methods

bulkSync()

public bulkSync(array<string|int, mixed> $records) : array<string|int, mixed>
Parameters
$records : array<string|int, mixed>
Return values
array<string|int, mixed>

cleanupOrphanedTriples()

public cleanupOrphanedTriples([bool $dryRun = false ]) : array<string|int, mixed>
Parameters
$dryRun : bool = false
Return values
array<string|int, mixed>

findInconsistencies()

public findInconsistencies([string|null $entityType = null ]) : array<string|int, mixed>
Parameters
$entityType : string|null = null
Return values
array<string|int, mixed>

findMissingRecords()

public findMissingRecords([string|null $entityType = null ]) : array<string|int, mixed>
Parameters
$entityType : string|null = null
Return values
array<string|int, mixed>

findOrphanedTriples()

public findOrphanedTriples([string|null $entityType = null ]) : array<string|int, mixed>
Parameters
$entityType : string|null = null
Return values
array<string|int, mixed>

fullResync()

public fullResync([string|null $entityType = null ][, callable|null $progressCallback = null ]) : array<string|int, mixed>
Parameters
$entityType : string|null = null
$progressCallback : callable|null = null
Return values
array<string|int, mixed>

getIntegritySchedule()

Get the configured integrity check schedule (daily/weekly/monthly/disabled).

public getIntegritySchedule() : string
Return values
string

getSyncHistory()

public getSyncHistory(string $entityType, int $entityId) : array<string|int, mixed>
Parameters
$entityType : string
$entityId : int
Return values
array<string|int, mixed>

getSyncStats()

public getSyncStats([string|null $since = null ]) : array<string|int, mixed>
Parameters
$since : string|null = null
Return values
array<string|int, mixed>

handleBatchDeletion()

public handleBatchDeletion(array<string|int, mixed> $entities) : array<string|int, mixed>
Parameters
$entities : array<string|int, mixed>
Return values
array<string|int, mixed>

handleDeletion()

public handleDeletion(string $entityType, int $entityId[, bool $cascade = true ]) : int
Parameters
$entityType : string
$entityId : int
$cascade : bool = true
Return values
int

handleMove()

public handleMove(string $entityType, int $entityId, int|null $oldParentId, int|null $newParentId) : bool
Parameters
$entityType : string
$entityId : int
$oldParentId : int|null
$newParentId : int|null
Return values
bool

isIntegrityCheckEnabled()

Check if integrity checks are enabled based on schedule setting.

public isIntegrityCheckEnabled() : bool
Return values
bool

logOperation()

public logOperation(string $operation, string $entityType, int|null $entityId, string $status[, string|null $details = null ]) : void
Parameters
$operation : string
$entityType : string
$entityId : int|null
$status : string
$details : string|null = null

previewDeletion()

public previewDeletion(string $entityType, int $entityId) : array<string|int, mixed>
Parameters
$entityType : string
$entityId : int
Return values
array<string|int, mixed>

repairInconsistencies()

public repairInconsistencies(array<string|int, mixed> $inconsistencies) : array<string|int, mixed>
Parameters
$inconsistencies : array<string|int, mixed>
Return values
array<string|int, mixed>

runIntegrityCheck()

public runIntegrityCheck() : array<string|int, mixed>
Return values
array<string|int, mixed>

syncRecord()

public syncRecord(string $entityType, int $entityId, string $operation) : bool
Parameters
$entityType : string
$entityId : int
$operation : string
Return values
bool

updateHierarchy()

public updateHierarchy(string $entityType, int $entityId) : int
Parameters
$entityType : string
$entityId : int
Return values
int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results