Heratio Framework API Reference

UserManagementService
in package

User Management Service.

Admin functions for managing users and trust levels.

Table of Contents

Methods

assignTrustLevel()  : bool
Assign trust level to user.
getTrustLevels()  : Collection
Get all trust levels.
getUser()  : object|null
Get user by ID with full details.
getUsers()  : array<string|int, mixed>
Get paginated user list with trust levels.
getUserStats()  : array<string|int, mixed>
Get user statistics.
getUserTrustLevel()  : object|null
Get user's trust level.
removeTrustLevel()  : bool
Remove trust level from user.

Methods

assignTrustLevel()

Assign trust level to user.

public assignTrustLevel(int $userId, int $trustLevelId[, int|null $grantedBy = null ][, string|null $expiresAt = null ][, string|null $notes = null ][, int|null $institutionId = null ]) : bool
Parameters
$userId : int
$trustLevelId : int
$grantedBy : int|null = null
$expiresAt : string|null = null
$notes : string|null = null
$institutionId : int|null = null
Return values
bool

getTrustLevels()

Get all trust levels.

public getTrustLevels() : Collection
Return values
Collection

getUser()

Get user by ID with full details.

public getUser(int $userId) : object|null
Parameters
$userId : int
Return values
object|null

getUsers()

Get paginated user list with trust levels.

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

getUserStats()

Get user statistics.

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

getUserTrustLevel()

Get user's trust level.

public getUserTrustLevel(int $userId[, int|null $institutionId = null ]) : object|null
Parameters
$userId : int
$institutionId : int|null = null
Return values
object|null

removeTrustLevel()

Remove trust level from user.

public removeTrustLevel(int $userId[, int|null $institutionId = null ]) : bool
Parameters
$userId : int
$institutionId : int|null = null
Return values
bool

        
On this page

Search results