Heratio Framework API Reference

AccessController
in package

Access Controller.

Handles access mediation API requests.

Table of Contents

Methods

__construct()  : mixed
approveRequest()  : array<string|int, mixed>
Approve access request.
checkAccess()  : array<string|int, mixed>
Check access for an object.
createAccessRequest()  : array<string|int, mixed>
Create access request.
createEmbargo()  : array<string|int, mixed>
Create embargo.
createPOPIAFlag()  : array<string|int, mixed>
Create POPIA flag.
denyRequest()  : array<string|int, mixed>
Deny access request.
getEmbargoes()  : array<string|int, mixed>
Get active embargoes.
getEmbargoStats()  : array<string|int, mixed>
Get embargo statistics.
getExpiringEmbargoes()  : array<string|int, mixed>
Get expiring embargoes.
getPendingRequests()  : array<string|int, mixed>
Get pending access requests (admin).
getPOPIAFlags()  : array<string|int, mixed>
Get POPIA flags (admin).
getPOPIAStats()  : array<string|int, mixed>
Get POPIA statistics.
getPurposes()  : array<string|int, mixed>
Get available purposes.
getRequestStats()  : array<string|int, mixed>
Get access request statistics.
getTrustLevels()  : array<string|int, mixed>
Get all trust levels.
getUserRequests()  : array<string|int, mixed>
Get user's access requests.
getUserTrustLevel()  : array<string|int, mixed>
Get user's trust level.
removeEmbargo()  : array<string|int, mixed>
Remove embargo.
resolvePOPIAFlag()  : array<string|int, mixed>
Resolve POPIA flag.

Methods

approveRequest()

Approve access request.

public approveRequest(int $id, int $decisionBy[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$id : int
$decisionBy : int
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

checkAccess()

Check access for an object.

public checkAccess(int $objectId[, int|null $userId = null ][, string $action = 'view' ][, int|null $institutionId = null ]) : array<string|int, mixed>
Parameters
$objectId : int
$userId : int|null = null
$action : string = 'view'
$institutionId : int|null = null
Return values
array<string|int, mixed>

createAccessRequest()

Create access request.

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

createEmbargo()

Create embargo.

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

createPOPIAFlag()

Create POPIA flag.

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

denyRequest()

Deny access request.

public denyRequest(int $id, int $decisionBy[, string|null $reason = null ]) : array<string|int, mixed>
Parameters
$id : int
$decisionBy : int
$reason : string|null = null
Return values
array<string|int, mixed>

getEmbargoes()

Get active embargoes.

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

getEmbargoStats()

Get embargo statistics.

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

getExpiringEmbargoes()

Get expiring embargoes.

public getExpiringEmbargoes([int $days = 30 ]) : array<string|int, mixed>
Parameters
$days : int = 30
Return values
array<string|int, mixed>

getPendingRequests()

Get pending access requests (admin).

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

getPOPIAFlags()

Get POPIA flags (admin).

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

getPOPIAStats()

Get POPIA statistics.

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

getPurposes()

Get available purposes.

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

getRequestStats()

Get access request statistics.

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

getTrustLevels()

Get all trust levels.

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

getUserRequests()

Get user's access requests.

public getUserRequests(int $userId[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$userId : int
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getUserTrustLevel()

Get user's trust level.

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

removeEmbargo()

Remove embargo.

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

resolvePOPIAFlag()

Resolve POPIA flag.

public resolvePOPIAFlag(int $id, int $resolvedBy[, string|null $notes = null ]) : array<string|int, mixed>
Parameters
$id : int
$resolvedBy : int
$notes : string|null = null
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results