Heratio Framework API Reference

PluginRepository
in package

Plugin Repository

Manages atom_plugin table operations using Laravel Query Builder.

Table of Contents

Methods

addAuditLog()  : int
Add an audit log entry.
disable()  : bool
Disable a plugin.
enable()  : bool
Enable a plugin.
exists()  : bool
Check if a plugin exists.
findAll()  : array<string|int, mixed>
Find all plugins with optional filters.
findByName()  : array<string|int, mixed>|null
Find a plugin by name.
findEnabled()  : array<string|int, mixed>
Find all enabled plugin names.
getAllPluginNames()  : array<string|int, mixed>
Get all plugin names.
getAuditLog()  : array<string|int, mixed>
Get audit log entries.
getDependencies()  : array<string|int, mixed>
Get dependencies for a plugin.
getDependents()  : array<string|int, mixed>
Get plugins that depend on a given plugin.
isEnabled()  : bool
Check if a plugin is enabled.

Methods

addAuditLog()

Add an audit log entry.

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

disable()

Disable a plugin.

public disable(string $name) : bool
Parameters
$name : string
Return values
bool

enable()

Enable a plugin.

public enable(string $name) : bool
Parameters
$name : string
Return values
bool

exists()

Check if a plugin exists.

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

findAll()

Find all plugins with optional filters.

public findAll([array<string|int, mixed> $filters = [] ]) : array<string|int, mixed>
Parameters
$filters : array<string|int, mixed> = []
Return values
array<string|int, mixed>

findByName()

Find a plugin by name.

public findByName(string $name) : array<string|int, mixed>|null
Parameters
$name : string
Return values
array<string|int, mixed>|null

findEnabled()

Find all enabled plugin names.

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

getAllPluginNames()

Get all plugin names.

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

getAuditLog()

Get audit log entries.

public getAuditLog([int|null $pluginId = null ][, int $limit = 50 ]) : array<string|int, mixed>
Parameters
$pluginId : int|null = null
$limit : int = 50
Return values
array<string|int, mixed>

getDependencies()

Get dependencies for a plugin.

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

getDependents()

Get plugins that depend on a given plugin.

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

isEnabled()

Check if a plugin is enabled.

public isEnabled(string $name) : bool
Parameters
$name : string
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results