Heratio Framework API Reference

TermService
in package

Term Service - Replaces QubitTerm (658 uses)

Table of Contents

Constants

ACCESSION_ID  = \AtomExtensions\Constants\TermConstants::ACCESSION_ID
ACCRUAL_ID  = \AtomExtensions\Constants\TermConstants::ACCRUAL_ID
ACTOR_OCCUPATION_NOTE_ID  = \AtomExtensions\Constants\TermConstants::ACTOR_OCCUPATION_NOTE_ID
AIP_RELATION_ID  = \AtomExtensions\Constants\TermConstants::AIP_RELATION_ID
ALTERNATIVE_LABEL_ID  = \AtomExtensions\Constants\TermConstants::ALTERNATIVE_LABEL_ID
ARCHIVIST_NOTE_ID  = \AtomExtensions\Constants\TermConstants::ARCHIVIST_NOTE_ID
CHAPTERS_ID  = \AtomExtensions\Constants\TermConstants::CHAPTERS_ID
COLLECTION_ID  = \AtomExtensions\Constants\TermConstants::COLLECTION_ID
CONVERSE_TERM_ID  = \AtomExtensions\Constants\TermConstants::CONVERSE_TERM_ID
CORPORATE_BODY_ID  = \AtomExtensions\Constants\TermConstants::CORPORATE_BODY_ID
CREATION_ID  = \AtomExtensions\Constants\TermConstants::CREATION_ID
DONOR_ID  = \AtomExtensions\Constants\TermConstants::DONOR_ID
EXTERNAL_URI_ID  = \AtomExtensions\Constants\TermConstants::EXTERNAL_URI_ID
FAMILY_ID  = \AtomExtensions\Constants\TermConstants::FAMILY_ID
FILE_ID  = \AtomExtensions\Constants\TermConstants::FILE_ID
FONDS_ID  = \AtomExtensions\Constants\TermConstants::FONDS_ID
GENERAL_NOTE_ID  = \AtomExtensions\Constants\TermConstants::GENERAL_NOTE_ID
ITEM_ID  = \AtomExtensions\Constants\TermConstants::ITEM_ID
LANGUAGE_NOTE_ID  = \AtomExtensions\Constants\TermConstants::LANGUAGE_NOTE_ID
MAINTENANCE_NOTE_ID  = \AtomExtensions\Constants\TermConstants::MAINTENANCE_NOTE_ID
MASTER_ID  = \AtomExtensions\Constants\TermConstants::MASTER_ID
NAME_ACCESS_POINT_ID  = \AtomExtensions\Constants\TermConstants::NAME_ACCESS_POINT_ID
OFFLINE_ID  = \AtomExtensions\Constants\TermConstants::OFFLINE_ID
OTHER_FORM_OF_NAME_ID  = \AtomExtensions\Constants\TermConstants::OTHER_FORM_OF_NAME_ID
OTHER_ID  = \AtomExtensions\Constants\TermConstants::OTHER_ID
PARALLEL_FORM_OF_NAME_ID  = \AtomExtensions\Constants\TermConstants::PARALLEL_FORM_OF_NAME_ID
PERSON_ID  = \AtomExtensions\Constants\TermConstants::PERSON_ID
PUBLICATION_NOTE_ID  = \AtomExtensions\Constants\TermConstants::PUBLICATION_NOTE_ID
PUBLICATION_STATUS_DRAFT_ID  = \AtomExtensions\Constants\TermConstants::PUBLICATION_STATUS_DRAFT_ID
PUBLICATION_STATUS_PUBLISHED_ID  = \AtomExtensions\Constants\TermConstants::PUBLICATION_STATUS_PUBLISHED_ID
REFERENCE_ID  = \AtomExtensions\Constants\TermConstants::REFERENCE_ID
RELATED_MATERIAL_DESCRIPTIONS_ID  = \AtomExtensions\Constants\TermConstants::RELATED_MATERIAL_DESCRIPTIONS_ID
RIGHT_BASIS_COPYRIGHT_ID  = \AtomExtensions\Constants\TermConstants::RIGHT_BASIS_COPYRIGHT_ID
RIGHT_BASIS_LICENSE_ID  = \AtomExtensions\Constants\TermConstants::RIGHT_BASIS_LICENSE_ID
RIGHT_BASIS_STATUTE_ID  = \AtomExtensions\Constants\TermConstants::RIGHT_BASIS_STATUTE_ID
RIGHT_ID  = \AtomExtensions\Constants\TermConstants::RIGHT_ID
ROOT_ID  = \AtomExtensions\Constants\TermConstants::ROOT_ID
SCOPE_NOTE_ID  = \AtomExtensions\Constants\TermConstants::SCOPE_NOTE_ID
SERIES_ID  = \AtomExtensions\Constants\TermConstants::SERIES_ID
STANDARDIZED_FORM_OF_NAME_ID  = \AtomExtensions\Constants\TermConstants::STANDARDIZED_FORM_OF_NAME_ID
SUBTITLES_ID  = \AtomExtensions\Constants\TermConstants::SUBTITLES_ID
THUMBNAIL_ID  = \AtomExtensions\Constants\TermConstants::THUMBNAIL_ID

Methods

__construct()  : mixed
Constructor for instance usage.
countRelatedInformationObjects()  : int
getActorEntityTypes()  : Collection
Get actor entity types (Corporate Body, Person, Family).
getById()  : object|null
getBySlug()  : object|null
getLevelsOfDescription()  : Collection
getLevelsOfDescriptionChoices()  : Collection
Get levels of description (instance method).
getName()  : string
getNoteTypes()  : Collection
getPublicationStatusChoices()  : Collection
Get publication statuses (instance method).
getPublicationStatuses()  : Collection
Get publication statuses.
getRADNotes()  : Collection
getTermName()  : string|null
Get term name by ID (instance method).
isProtected()  : bool
loadTermParentList()  : array<string|int, mixed>
setCulture()  : void
toChoices()  : array<string|int, mixed>
Convert collection to choices array for forms.

Constants

ACCESSION_ID

public mixed ACCESSION_ID = \AtomExtensions\Constants\TermConstants::ACCESSION_ID

ACCRUAL_ID

public mixed ACCRUAL_ID = \AtomExtensions\Constants\TermConstants::ACCRUAL_ID

ACTOR_OCCUPATION_NOTE_ID

public mixed ACTOR_OCCUPATION_NOTE_ID = \AtomExtensions\Constants\TermConstants::ACTOR_OCCUPATION_NOTE_ID

AIP_RELATION_ID

public mixed AIP_RELATION_ID = \AtomExtensions\Constants\TermConstants::AIP_RELATION_ID

ALTERNATIVE_LABEL_ID

public mixed ALTERNATIVE_LABEL_ID = \AtomExtensions\Constants\TermConstants::ALTERNATIVE_LABEL_ID

ARCHIVIST_NOTE_ID

public mixed ARCHIVIST_NOTE_ID = \AtomExtensions\Constants\TermConstants::ARCHIVIST_NOTE_ID

CHAPTERS_ID

public mixed CHAPTERS_ID = \AtomExtensions\Constants\TermConstants::CHAPTERS_ID

COLLECTION_ID

public mixed COLLECTION_ID = \AtomExtensions\Constants\TermConstants::COLLECTION_ID

CONVERSE_TERM_ID

public mixed CONVERSE_TERM_ID = \AtomExtensions\Constants\TermConstants::CONVERSE_TERM_ID

CORPORATE_BODY_ID

public mixed CORPORATE_BODY_ID = \AtomExtensions\Constants\TermConstants::CORPORATE_BODY_ID

CREATION_ID

public mixed CREATION_ID = \AtomExtensions\Constants\TermConstants::CREATION_ID

DONOR_ID

public mixed DONOR_ID = \AtomExtensions\Constants\TermConstants::DONOR_ID

EXTERNAL_URI_ID

public mixed EXTERNAL_URI_ID = \AtomExtensions\Constants\TermConstants::EXTERNAL_URI_ID

FAMILY_ID

public mixed FAMILY_ID = \AtomExtensions\Constants\TermConstants::FAMILY_ID

FILE_ID

public mixed FILE_ID = \AtomExtensions\Constants\TermConstants::FILE_ID

FONDS_ID

public mixed FONDS_ID = \AtomExtensions\Constants\TermConstants::FONDS_ID

GENERAL_NOTE_ID

public mixed GENERAL_NOTE_ID = \AtomExtensions\Constants\TermConstants::GENERAL_NOTE_ID

ITEM_ID

public mixed ITEM_ID = \AtomExtensions\Constants\TermConstants::ITEM_ID

LANGUAGE_NOTE_ID

public mixed LANGUAGE_NOTE_ID = \AtomExtensions\Constants\TermConstants::LANGUAGE_NOTE_ID

MAINTENANCE_NOTE_ID

public mixed MAINTENANCE_NOTE_ID = \AtomExtensions\Constants\TermConstants::MAINTENANCE_NOTE_ID

MASTER_ID

public mixed MASTER_ID = \AtomExtensions\Constants\TermConstants::MASTER_ID

NAME_ACCESS_POINT_ID

public mixed NAME_ACCESS_POINT_ID = \AtomExtensions\Constants\TermConstants::NAME_ACCESS_POINT_ID

OFFLINE_ID

public mixed OFFLINE_ID = \AtomExtensions\Constants\TermConstants::OFFLINE_ID

OTHER_FORM_OF_NAME_ID

public mixed OTHER_FORM_OF_NAME_ID = \AtomExtensions\Constants\TermConstants::OTHER_FORM_OF_NAME_ID

OTHER_ID

public mixed OTHER_ID = \AtomExtensions\Constants\TermConstants::OTHER_ID

PARALLEL_FORM_OF_NAME_ID

public mixed PARALLEL_FORM_OF_NAME_ID = \AtomExtensions\Constants\TermConstants::PARALLEL_FORM_OF_NAME_ID

PERSON_ID

public mixed PERSON_ID = \AtomExtensions\Constants\TermConstants::PERSON_ID

PUBLICATION_NOTE_ID

public mixed PUBLICATION_NOTE_ID = \AtomExtensions\Constants\TermConstants::PUBLICATION_NOTE_ID

PUBLICATION_STATUS_DRAFT_ID

public mixed PUBLICATION_STATUS_DRAFT_ID = \AtomExtensions\Constants\TermConstants::PUBLICATION_STATUS_DRAFT_ID

PUBLICATION_STATUS_PUBLISHED_ID

public mixed PUBLICATION_STATUS_PUBLISHED_ID = \AtomExtensions\Constants\TermConstants::PUBLICATION_STATUS_PUBLISHED_ID

REFERENCE_ID

public mixed REFERENCE_ID = \AtomExtensions\Constants\TermConstants::REFERENCE_ID

RELATED_MATERIAL_DESCRIPTIONS_ID

public mixed RELATED_MATERIAL_DESCRIPTIONS_ID = \AtomExtensions\Constants\TermConstants::RELATED_MATERIAL_DESCRIPTIONS_ID

RIGHT_BASIS_COPYRIGHT_ID

public mixed RIGHT_BASIS_COPYRIGHT_ID = \AtomExtensions\Constants\TermConstants::RIGHT_BASIS_COPYRIGHT_ID

RIGHT_BASIS_LICENSE_ID

public mixed RIGHT_BASIS_LICENSE_ID = \AtomExtensions\Constants\TermConstants::RIGHT_BASIS_LICENSE_ID

RIGHT_BASIS_STATUTE_ID

public mixed RIGHT_BASIS_STATUTE_ID = \AtomExtensions\Constants\TermConstants::RIGHT_BASIS_STATUTE_ID

RIGHT_ID

public mixed RIGHT_ID = \AtomExtensions\Constants\TermConstants::RIGHT_ID

ROOT_ID

public mixed ROOT_ID = \AtomExtensions\Constants\TermConstants::ROOT_ID

SCOPE_NOTE_ID

public mixed SCOPE_NOTE_ID = \AtomExtensions\Constants\TermConstants::SCOPE_NOTE_ID

SERIES_ID

public mixed SERIES_ID = \AtomExtensions\Constants\TermConstants::SERIES_ID

STANDARDIZED_FORM_OF_NAME_ID

public mixed STANDARDIZED_FORM_OF_NAME_ID = \AtomExtensions\Constants\TermConstants::STANDARDIZED_FORM_OF_NAME_ID

SUBTITLES_ID

public mixed SUBTITLES_ID = \AtomExtensions\Constants\TermConstants::SUBTITLES_ID

THUMBNAIL_ID

public mixed THUMBNAIL_ID = \AtomExtensions\Constants\TermConstants::THUMBNAIL_ID

Methods

__construct()

Constructor for instance usage.

public __construct([string|null $culture = null ]) : mixed
Parameters
$culture : string|null = null

countRelatedInformationObjects()

public static countRelatedInformationObjects(int $termId) : int
Parameters
$termId : int
Return values
int

getActorEntityTypes()

Get actor entity types (Corporate Body, Person, Family).

public getActorEntityTypes() : Collection
Return values
Collection

getById()

public static getById(int $id[, string|null $culture = null ]) : object|null
Parameters
$id : int
$culture : string|null = null
Return values
object|null

getBySlug()

public static getBySlug(string $slug) : object|null
Parameters
$slug : string
Return values
object|null

getLevelsOfDescription()

public static getLevelsOfDescription([string|null $culture = null ]) : Collection
Parameters
$culture : string|null = null
Return values
Collection

getLevelsOfDescriptionChoices()

Get levels of description (instance method).

public getLevelsOfDescriptionChoices() : Collection
Return values
Collection

getName()

public static getName(object|null $term) : string
Parameters
$term : object|null
Return values
string

getNoteTypes()

public static getNoteTypes([string|null $culture = null ]) : Collection
Parameters
$culture : string|null = null
Return values
Collection

getPublicationStatusChoices()

Get publication statuses (instance method).

public getPublicationStatusChoices() : Collection
Return values
Collection

getPublicationStatuses()

Get publication statuses.

public static getPublicationStatuses([string|null $culture = null ]) : Collection
Parameters
$culture : string|null = null
Return values
Collection

getRADNotes()

public static getRADNotes([string|null $culture = null ]) : Collection
Parameters
$culture : string|null = null
Return values
Collection

getTermName()

Get term name by ID (instance method).

public getTermName(int $id) : string|null
Parameters
$id : int
Return values
string|null

isProtected()

public static isProtected(int $id) : bool
Parameters
$id : int
Return values
bool

loadTermParentList()

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

setCulture()

public static setCulture(string $culture) : void
Parameters
$culture : string

toChoices()

Convert collection to choices array for forms.

public toChoices(Collection $items[, string $valueField = 'id' ][, string $labelField = 'name' ]) : array<string|int, mixed>
Parameters
$items : Collection
$valueField : string = 'id'
$labelField : string = 'name'
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results