Heratio Framework API Reference

IdentifierSchemeService
in package

IdentifierSchemeService

Implements AtoM-compatible identifier masks:

  • strftime tokens (e.g. %Y-%m-%d)
  • incremental placeholder: #i

Supports sector overrides stored as settings named: sector__identifier_mask_enabled sector_identifier_mask sector_identifier_counter (and the same for accession*).

Table of Contents

Constants

PLACEHOLDER_INCREMENT  = '#i'
TYPE_ACCESSION  = 'accession'
TYPE_IDENTIFIER  = 'identifier'

Methods

generateAndIncrement()  : string|null
Generate identifier/accession value and increment the relevant counter.
getEffectiveValue()  : string|null
Get effective value: sector override if present, else global.
settingName()  : string
Builds the setting name for a sector override.

Constants

Methods

generateAndIncrement()

Generate identifier/accession value and increment the relevant counter.

public static generateAndIncrement(string $type[, string|null $sector = null ][, string $culture = 'en' ]) : string|null

Returns null if mask is disabled (effective).

Parameters
$type : string
$sector : string|null = null
$culture : string = 'en'
Return values
string|null

getEffectiveValue()

Get effective value: sector override if present, else global.

public static getEffectiveValue(string $key[, string|null $sector = null ][, string $culture = 'en' ]) : string|null
Parameters
$key : string
$sector : string|null = null
$culture : string = 'en'
Return values
string|null

settingName()

Builds the setting name for a sector override.

public static settingName(string $key[, string|null $sector = null ]) : string
Parameters
$key : string
$sector : string|null = null
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results