Heratio Framework API Reference

ExtensionRepository
in package

Table of Contents

Methods

all()  : Collection
Get all extensions
cancelPendingDeletion()  : bool
Cancel pending deletion
create()  : int
Create extension record
delete()  : bool
Delete extension record
exists()  : bool
Check if extension exists
find()  : object|null
Find by ID
findByMachineName()  : object|null
Find by machine name
getAuditLog()  : Collection
Get audit log for extension
getByStatus()  : Collection
Get extensions by status
getPendingDeletions()  : Collection
Get pending deletions ready to process
getPendingForExtension()  : Collection
Get pending deletions for extension
getSetting()  : mixed
Get setting value
getSettings()  : Collection
Get all settings for extension
logAction()  : int
Log an action
queueForDeletion()  : int
Queue table for deletion
setSetting()  : bool
Set setting value
update()  : bool
Update extension record
updateByMachineName()  : bool
Update by machine name
updatePendingStatus()  : bool
Update pending deletion status

Methods

cancelPendingDeletion()

Cancel pending deletion

public cancelPendingDeletion(string $extensionName) : bool
Parameters
$extensionName : string
Return values
bool

create()

Create extension record

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

delete()

Delete extension record

public delete(int $id) : bool
Parameters
$id : int
Return values
bool

exists()

Check if extension exists

public exists(string $machineName) : bool
Parameters
$machineName : string
Return values
bool

find()

Find by ID

public find(int $id) : object|null
Parameters
$id : int
Return values
object|null

findByMachineName()

Find by machine name

public findByMachineName(string $machineName) : object|null
Parameters
$machineName : string
Return values
object|null

getAuditLog()

Get audit log for extension

public getAuditLog([string|null $extensionName = null ][, int $limit = 50 ]) : Collection
Parameters
$extensionName : string|null = null
$limit : int = 50
Return values
Collection

getByStatus()

Get extensions by status

public getByStatus(string $status) : Collection
Parameters
$status : string
Return values
Collection

getPendingDeletions()

Get pending deletions ready to process

public getPendingDeletions() : Collection
Return values
Collection

getPendingForExtension()

Get pending deletions for extension

public getPendingForExtension(string $extensionName) : Collection
Parameters
$extensionName : string
Return values
Collection

getSetting()

Get setting value

public getSetting(string $key[, int|null $extensionId = null ][, mixed $default = null ]) : mixed
Parameters
$key : string
$extensionId : int|null = null
$default : mixed = null

getSettings()

Get all settings for extension

public getSettings([int|null $extensionId = null ]) : Collection
Parameters
$extensionId : int|null = null
Return values
Collection

logAction()

Log an action

public logAction(string $extensionName, string $action[, int|null $extensionId = null ][, int|null $userId = null ][, array<string|int, mixed> $details = [] ]) : int
Parameters
$extensionName : string
$action : string
$extensionId : int|null = null
$userId : int|null = null
$details : array<string|int, mixed> = []
Return values
int

queueForDeletion()

Queue table for deletion

public queueForDeletion(string $extensionName, string $tableName, int $recordCount, string|null $backupPath, DateTime $deleteAfter) : int
Parameters
$extensionName : string
$tableName : string
$recordCount : int
$backupPath : string|null
$deleteAfter : DateTime
Return values
int

setSetting()

Set setting value

public setSetting(string $key, mixed $value[, int|null $extensionId = null ][, string $type = 'string' ]) : bool
Parameters
$key : string
$value : mixed
$extensionId : int|null = null
$type : string = 'string'
Return values
bool

update()

Update extension record

public update(int $id, array<string|int, mixed> $data) : bool
Parameters
$id : int
$data : array<string|int, mixed>
Return values
bool

updateByMachineName()

Update by machine name

public updateByMachineName(string $machineName, array<string|int, mixed> $data) : bool
Parameters
$machineName : string
$data : array<string|int, mixed>
Return values
bool

updatePendingStatus()

Update pending deletion status

public updatePendingStatus(int $id, string $status[, string|null $error = null ]) : bool
Parameters
$id : int
$status : string
$error : string|null = null
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results