Heratio Framework API Reference

OaiService
in package

OAI Service - Replaces QubitOai.

Provides OAI-PMH functionality using Laravel Query Builder.

Tags
author

Johan Pieterse johan@theahg.co.za

Table of Contents

Methods

areAdditionalSetsEnabled()  : bool
Check if additional sets are enabled.
createResumptionToken()  : string
Create resumption token.
getAdminEmails()  : array<string|int, mixed>
Get OAI admin emails.
getOaiSampleIdentifier()  : string
Get sample OAI identifier.
getRepositoryIdentifier()  : string
Get repository identifier.
getResumptionTokenLimit()  : int
Get resumption token limit.
isAuthenticationEnabled()  : bool
Check if OAI authentication is enabled.
parseResumptionToken()  : array<string|int, mixed>|null
Parse resumption token.

Methods

areAdditionalSetsEnabled()

Check if additional sets are enabled.

public static areAdditionalSetsEnabled() : bool
Return values
bool

createResumptionToken()

Create resumption token.

public static createResumptionToken(array<string|int, mixed> $params) : string
Parameters
$params : array<string|int, mixed>
Return values
string

getAdminEmails()

Get OAI admin emails.

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

getOaiSampleIdentifier()

Get sample OAI identifier.

public static getOaiSampleIdentifier() : string

Replaces: QubitOai::getOaiSampleIdentifier()

Return values
string

getRepositoryIdentifier()

Get repository identifier.

public static getRepositoryIdentifier() : string

Replaces: QubitOai::getRepositoryIdentifier()

Return values
string

getResumptionTokenLimit()

Get resumption token limit.

public static getResumptionTokenLimit() : int
Return values
int

isAuthenticationEnabled()

Check if OAI authentication is enabled.

public static isAuthenticationEnabled() : bool
Return values
bool

parseResumptionToken()

Parse resumption token.

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

        
On this page

Search results