Heratio Framework API Reference

QubitTaxonomy
in package
uses QubitModelTrait

Table of Contents

Constants

ACCESSION_ACQUISITION_TYPE_ID  = 63
ACCESSION_ALTERNATIVE_IDENTIFIER_TYPE_ID  = 82
ACCESSION_EVENT_TYPE_ID  = 83
ACCESSION_PROCESSING_PRIORITY_ID  = 64
ACCESSION_PROCESSING_STATUS_ID  = 65
ACCESSION_RESOURCE_TYPE_ID  = 62
ACTOR_ENTITY_TYPE_ID  = 32
ACTOR_NAME_TYPE_ID  = 36
ACTOR_OCCUPATION_ID  = 80
ACTOR_RELATION_TYPE_ID  = 55
AIP_TYPE_ID  = 71
COLLECTION_TYPE_ID  = 45
COPYRIGHT_STATUS_ID  = 69
DACS_NOTE_ID  = 74
DC_TYPE_ID  = 54
DEACCESSION_SCOPE_ID  = 66
DESCRIPTION_DETAIL_LEVEL_ID  = 31
DESCRIPTION_STATUS_ID  = 33
DIGITAL_OBJECT_USAGE_ID  = 47
EVENT_TYPE_ID  = 40
FUNCTION_ID  = 43
GENRE_ID  = 78
GEOGRAPHIC_SUBREGION_ID  = 73
HISTORICAL_EVENT_ID  = 44
INFORMATION_OBJECT_TEMPLATE_ID  = 70
ISDF_RELATION_TYPE_ID  = 61
JOB_STATUS_ID  = 79
LEVEL_OF_DESCRIPTION_ID  = 34
MATERIAL_TYPE_ID  = 50
MEDIA_TYPE_ID  = 46
MODS_RESOURCE_TYPE_ID  = 53
NOTE_TYPE_ID  = 37
PHYSICAL_OBJECT_TYPE_ID  = 48
PLACE_ID  = 42
PUBLICATION_STATUS_ID  = 60
QUBIT_SETTING_LABEL_ID  = 41
RAD_NOTE_ID  = 51
RAD_TITLE_NOTE_ID  = 52
RELATION_NOTE_TYPE_ID  = 56
RELATION_TYPE_ID  = 49
REPOSITORY_TYPE_ID  = 38
RIGHT_ACT_ID  = 67
RIGHT_BASIS_ID  = 68
RIGHTS_STATUTES_ID  = 75
ROOT_ID  = 30
STATUS_TYPE_ID  = 59
SUBJECT_ID  = 35
TERM_RELATION_TYPE_ID  = 57
THEMATIC_AREA_ID  = 72
USER_ACTION_ID  = 81

Properties

$lockedTaxonomies  : mixed

Methods

__call()  : mixed
Magic method caller — handles Propel-style getXxx() accessors and i18n field getters with cultureFallback option.
__get()  : mixed
Magic property access — resolves camelCase to snake_case columns, Propel relationships, and serialized property table values.
__isset()  : bool
getAll()  : Collection
Get all rows matching criteria.
getAncestors()  : object
Get ancestors using MPTT (nested set) lft/rgt columns.
getById()  : static|null
Load an entity by primary key.
getBySlug()  : object|null
Load an entity by slug.
getChildren()  : Collection
Get children using MPTT parent_id.
getOne()  : object|null
Get a single row matching criteria.
getRoot()  : mixed
getTaxonomy()  : object|null
Get taxonomy (for terms).
getTermsById()  : Collection
hydrate()  : static
Hydrate a database row into an instance of the calling class.

Constants

ACCESSION_ACQUISITION_TYPE_ID

public mixed ACCESSION_ACQUISITION_TYPE_ID = 63

ACCESSION_ALTERNATIVE_IDENTIFIER_TYPE_ID

public mixed ACCESSION_ALTERNATIVE_IDENTIFIER_TYPE_ID = 82

ACCESSION_EVENT_TYPE_ID

public mixed ACCESSION_EVENT_TYPE_ID = 83

ACCESSION_PROCESSING_PRIORITY_ID

public mixed ACCESSION_PROCESSING_PRIORITY_ID = 64

ACCESSION_PROCESSING_STATUS_ID

public mixed ACCESSION_PROCESSING_STATUS_ID = 65

ACCESSION_RESOURCE_TYPE_ID

public mixed ACCESSION_RESOURCE_TYPE_ID = 62

ACTOR_RELATION_TYPE_ID

public mixed ACTOR_RELATION_TYPE_ID = 55

DESCRIPTION_DETAIL_LEVEL_ID

public mixed DESCRIPTION_DETAIL_LEVEL_ID = 31

DESCRIPTION_STATUS_ID

public mixed DESCRIPTION_STATUS_ID = 33

DIGITAL_OBJECT_USAGE_ID

public mixed DIGITAL_OBJECT_USAGE_ID = 47

GEOGRAPHIC_SUBREGION_ID

public mixed GEOGRAPHIC_SUBREGION_ID = 73

INFORMATION_OBJECT_TEMPLATE_ID

public mixed INFORMATION_OBJECT_TEMPLATE_ID = 70

ISDF_RELATION_TYPE_ID

public mixed ISDF_RELATION_TYPE_ID = 61

LEVEL_OF_DESCRIPTION_ID

public mixed LEVEL_OF_DESCRIPTION_ID = 34

MODS_RESOURCE_TYPE_ID

public mixed MODS_RESOURCE_TYPE_ID = 53

PHYSICAL_OBJECT_TYPE_ID

public mixed PHYSICAL_OBJECT_TYPE_ID = 48

PUBLICATION_STATUS_ID

public mixed PUBLICATION_STATUS_ID = 60

QUBIT_SETTING_LABEL_ID

public mixed QUBIT_SETTING_LABEL_ID = 41

RELATION_NOTE_TYPE_ID

public mixed RELATION_NOTE_TYPE_ID = 56

TERM_RELATION_TYPE_ID

public mixed TERM_RELATION_TYPE_ID = 57

Properties

$lockedTaxonomies

public static mixed $lockedTaxonomies = [self::QUBIT_SETTING_LABEL_ID, self::COLLECTION_TYPE_ID, self::DIGITAL_OBJECT_USAGE_ID, self::MEDIA_TYPE_ID, self::RELATION_TYPE_ID, self::RELATION_NOTE_TYPE_ID, self::TERM_RELATION_TYPE_ID, self::ROOT_ID, self::STATUS_TYPE_ID, self::PUBLICATION_STATUS_ID, self::ACTOR_NAME_TYPE_ID, self::INFORMATION_OBJECT_TEMPLATE_ID, self::JOB_STATUS_ID]

Methods

__call()

Magic method caller — handles Propel-style getXxx() accessors and i18n field getters with cultureFallback option.

public __call(string $method, array<string|int, mixed> $args) : mixed
Parameters
$method : string
$args : array<string|int, mixed>

__get()

Magic property access — resolves camelCase to snake_case columns, Propel relationships, and serialized property table values.

public __get(string $name) : mixed
Parameters
$name : string

__isset()

public __isset(string $name) : bool
Parameters
$name : string
Return values
bool

getAll()

Get all rows matching criteria.

public static getAll([array<string|int, mixed> $criteria = [] ]) : Collection
Parameters
$criteria : array<string|int, mixed> = []

Column => value pairs

Return values
Collection

getAncestors()

Get ancestors using MPTT (nested set) lft/rgt columns.

public getAncestors() : object

Returns a fluent collection wrapper that supports andSelf() and orderBy().

Return values
object —

Collection-like object with andSelf(), orderBy(), get() methods

getById()

Load an entity by primary key.

public static getById(int $id[, array<string|int, mixed> $options = [] ]) : static|null

Delegates to EntityQueryService when the class is mapped there, otherwise falls back to a direct table query.

Returns an instance of the calling class so that instanceof checks work correctly (e.g., $obj instanceof QubitTaxonomy).

Parameters
$id : int
$options : array<string|int, mixed> = []

Optional. Keys: 'culture' => string

Return values
static|null —

Instance of calling class or null

getBySlug()

Load an entity by slug.

public static getBySlug(string $slug[, array<string|int, mixed> $options = [] ]) : object|null
Parameters
$slug : string
$options : array<string|int, mixed> = []

Optional. Keys: 'culture' => string

Return values
object|null

getChildren()

Get children using MPTT parent_id.

public getChildren() : Collection
Return values
Collection

getOne()

Get a single row matching criteria.

public static getOne([array<string|int, mixed> $criteria = [] ]) : object|null
Parameters
$criteria : array<string|int, mixed> = []

Column => value pairs

Return values
object|null

getTaxonomy()

Get taxonomy (for terms).

public getTaxonomy() : object|null
Return values
object|null

getTermsById()

public static getTermsById(int $taxonomyId[, string $culture = 'en' ]) : Collection
Parameters
$taxonomyId : int
$culture : string = 'en'
Return values
Collection

hydrate()

Hydrate a database row into an instance of the calling class.

public static hydrate(object $row) : static

Copies all stdClass properties onto a new instance so that instanceof checks work correctly (e.g., $obj instanceof QubitTaxonomy). Also resolves the parent property from the MPTT parent_id column in the object table (Qubit entities inherit from object).

Parameters
$row : object

stdClass from DB query

Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results