Heratio Framework API Reference

GlamIdentifierService
in package

GLAM Identifier Service

Handles identifier management across all GLAM sectors. NO slug-based identifiers for barcode generation.

Table of Contents

Constants

SECTOR_ARCHIVE  = 'archive'
SECTOR_DAM  = 'dam'
SECTOR_GALLERY  = 'gallery'
SECTOR_LIBRARY  = 'library'
SECTOR_MUSEUM  = 'museum'
TYPE_ACCESSION  = 'accession_number'
TYPE_ARTWORK_ID  = 'artwork_id'
TYPE_ASSET_ID  = 'asset_id'
TYPE_BARCODE  = 'barcode'
TYPE_CATALOGUE_NUMBER  = 'catalogue_number'
TYPE_DOI  = 'doi'
TYPE_IDENTIFIER  = 'identifier'
TYPE_ISBN10  = 'isbn10'
TYPE_ISBN13  = 'isbn13'
TYPE_ISSN  = 'issn'
TYPE_LCCN  = 'lccn'
TYPE_OBJECT_NUMBER  = 'object_number'
TYPE_REFERENCE_CODE  = 'reference_code'

Methods

convertIsbn10ToIsbn13()  : string|null
detectIdentifierType()  : string|null
detectObjectSector()  : string
getAllIdentifiers()  : array<string|int, mixed>
Get all identifiers for a record including minted DOI.
getBestBarcodeIdentifier()  : array<string|int, mixed>|null
getDoiDisplayInfo()  : array<string|int, mixed>|null
Get DOI display info for a record (for UI display).
getDoiRecord()  : object|null
Get full DOI record for an object.
getIdentifierTypesForSector()  : array<string|int, mixed>
getMintedDoi()  : string|null
Get minted DOI for an object from ahg_doi table.
getPrimaryIdentifierType()  : string
hasMintedDoi()  : bool
Check if a record has a minted DOI.
validateDoi()  : array<string|int, mixed>
validateIdentifier()  : array<string|int, mixed>
validateIsbn10()  : array<string|int, mixed>
validateIsbn13()  : array<string|int, mixed>
validateIssn()  : array<string|int, mixed>

Constants

Methods

convertIsbn10ToIsbn13()

public convertIsbn10ToIsbn13(string $isbn10) : string|null
Parameters
$isbn10 : string
Return values
string|null

detectIdentifierType()

public detectIdentifierType(string $value) : string|null
Parameters
$value : string
Return values
string|null

detectObjectSector()

public detectObjectSector(int $objectId) : string
Parameters
$objectId : int
Return values
string

getAllIdentifiers()

Get all identifiers for a record including minted DOI.

public getAllIdentifiers(int $objectId[, string|null $sector = null ]) : array<string|int, mixed>
Parameters
$objectId : int

Information object ID

$sector : string|null = null

Sector to get identifiers for

Return values
array<string|int, mixed> —

Array of identifier info with type, value, label

getBestBarcodeIdentifier()

public getBestBarcodeIdentifier(int $objectId[, string|null $sector = null ]) : array<string|int, mixed>|null
Parameters
$objectId : int
$sector : string|null = null
Return values
array<string|int, mixed>|null

getDoiDisplayInfo()

Get DOI display info for a record (for UI display).

public getDoiDisplayInfo(int $objectId) : array<string|int, mixed>|null
Parameters
$objectId : int

Information object ID

Return values
array<string|int, mixed>|null —

Array with doi, url, status, minted_at or null

getDoiRecord()

Get full DOI record for an object.

public getDoiRecord(int $objectId) : object|null
Parameters
$objectId : int

Information object ID

Return values
object|null —

DOI record with doi, status, minted_at, url

getIdentifierTypesForSector()

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

getMintedDoi()

Get minted DOI for an object from ahg_doi table.

public getMintedDoi(int $objectId) : string|null
Parameters
$objectId : int

Information object ID

Return values
string|null —

DOI string or null

getPrimaryIdentifierType()

public getPrimaryIdentifierType(string $sector) : string
Parameters
$sector : string
Return values
string

hasMintedDoi()

Check if a record has a minted DOI.

public hasMintedDoi(int $objectId) : bool
Parameters
$objectId : int

Information object ID

Return values
bool

validateDoi()

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

validateIdentifier()

public validateIdentifier(string $value, string $type) : array<string|int, mixed>
Parameters
$value : string
$type : string
Return values
array<string|int, mixed>

validateIsbn10()

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

validateIsbn13()

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

validateIssn()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results