Heratio Framework API Reference

ContributorService
in package

Contributor Service.

Manages public contributor accounts (separate from AtoM users).

Table of Contents

Methods

calculateTrustLevel()  : string
Calculate and update trust level based on contributions.
checkAndAwardBadges()  : array<string|int, mixed>
Award badges to contributor based on achievements.
getLeaderboard()  : array<string|int, mixed>
Get leaderboard.
getProfile()  : array<string|int, mixed>
Get contributor profile.
getStats()  : array<string|int, mixed>
Get contributor statistics.
login()  : array<string|int, mixed>
Login a contributor.
logout()  : array<string|int, mixed>
Logout a contributor (invalidate session).
register()  : array<string|int, mixed>
Register a new contributor.
requestPasswordReset()  : array<string|int, mixed>
Request password reset.
resetPassword()  : array<string|int, mixed>
Reset password with token.
updateProfile()  : array<string|int, mixed>
Update contributor profile.
validateSession()  : object|null
Validate session token and return contributor.
verifyEmail()  : array<string|int, mixed>
Verify email address.

Methods

calculateTrustLevel()

Calculate and update trust level based on contributions.

public calculateTrustLevel(int $contributorId) : string
Parameters
$contributorId : int
Return values
string

checkAndAwardBadges()

Award badges to contributor based on achievements.

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

getLeaderboard()

Get leaderboard.

public getLeaderboard([int $limit = 20 ][, string|null $period = null ]) : array<string|int, mixed>
Parameters
$limit : int = 20
$period : string|null = null
Return values
array<string|int, mixed>

getProfile()

Get contributor profile.

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

getStats()

Get contributor statistics.

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

login()

Login a contributor.

public login(string $email, string $password) : array<string|int, mixed>
Parameters
$email : string
$password : string
Return values
array<string|int, mixed>

logout()

Logout a contributor (invalidate session).

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

register()

Register a new contributor.

public register(string $email, string $displayName, string $password) : array<string|int, mixed>
Parameters
$email : string
$displayName : string
$password : string
Return values
array<string|int, mixed>

requestPasswordReset()

Request password reset.

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

resetPassword()

Reset password with token.

public resetPassword(string $token, string $newPassword) : array<string|int, mixed>
Parameters
$token : string
$newPassword : string
Return values
array<string|int, mixed>

updateProfile()

Update contributor profile.

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

validateSession()

Validate session token and return contributor.

public validateSession(string $token) : object|null
Parameters
$token : string
Return values
object|null

verifyEmail()

Verify email address.

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

        
On this page

Search results