Heratio Framework API Reference

QubitTerm
in package
uses QubitModelTrait

Table of Contents

Constants

ACCESSION_ALTERNATIVE_IDENTIFIER_DEFAULT_TYPE_ID  = 192
ACCESSION_EVENT_NOTE_ID  = 194
ACCESSION_EVENT_PHYSICAL_TRANSFER_ID  = 193
ACCESSION_ID  = 167
ACCRUAL_ID  = 175
ACCUMULATION_ID  = 118
ACTOR_ENTITY_TYPE_CORPORATE_BODY_ID  = 131
ACTOR_ENTITY_TYPE_FAMILY_ID  = 133
ACTOR_ENTITY_TYPE_PERSON_ID  = 132
ACTOR_OCCUPATION_NOTE_ID  = 188
AIP_RELATION_ID  = 178
ALTERNATIVE_LABEL_ID  = 156
ARCHIVAL_MATERIAL_ID  = 128
ARCHIVIST_NOTE_ID  = 124
ARTEFACT_ID  = 146
ARTEFACT_MATERIAL_ID  = 130
ARTWORK_COMPONENT_ID  = 179
ARTWORK_MATERIAL_ID  = 180
ASSOCIATIVE_RELATION_ID  = 153
AUDIO_ID  = 135
CHAPTERS_ID  = 195
CODE  = 'term.code'
COL_ID  = 'term.id'
COLLECTION_ID  = 117
COMPOUND_ID  = 143
CONTAINER_ID  = 145
CONTRIBUTION_ID  = 115
CONVERSE_TERM_ID  = 177
CORPORATE_BODY_ID  = 131
CREATION_ID  = 111
CUSTODY_ID  = 113
DISPLAY_NOTE_ID  = 123
DONOR_ID  = 169
EXTERNAL_FILE_ID  = 191
EXTERNAL_URI_ID  = 166
FAMILY_ID  = 133
FAMILY_NAME_FIRST_NAME_ID  = 134
FAMILY_RELATION_ID  = 152
GENERAL_NOTE_ID  = 125
GENRE_ID  = 78
HAS_PHYSICAL_OBJECT_ID  = 147
HIERARCHICAL_RELATION_ID  = 150
IMAGE_ID  = 136
ISDF_ASSOCIATIVE_RELATION_ID  = 164
ISDF_HIERARCHICAL_RELATION_ID  = 162
ISDF_TEMPORAL_RELATION_ID  = 163
JOB_ERROR_NOTE_ID  = 197
JOB_STATUS_COMPLETED_ID  = 184
JOB_STATUS_ERROR_ID  = 185
JOB_STATUS_IN_PROGRESS_ID  = 183
LANGUAGE_NOTE_ID  = 174
LEVEL_OF_DESCRIPTION_ID  = 34
LFT  = 'term.lft'
LOCATION_ID  = 144
MAINTAINING_REPOSITORY_RELATION_ID  = 187
MAINTENANCE_NOTE_ID  = 127
MASTER_ID  = 140
NAME_ACCESS_POINT_ID  = 161
OFFLINE_ID  = 186
OTHER_DESCRIPTIVE_DATA_ID  = 126
OTHER_FORM_OF_NAME_ID  = 149
OTHER_ID  = 139
PARALLEL_FORM_OF_NAME_ID  = 148
PARENT_ID_COL  = 'term.parent_id'
PERSON_ID  = 132
PHYSICAL_OBJECT_ID  = 67
PLACE_ID  = 42
PUBLICATION_ID  = 114
PUBLICATION_NOTE_ID  = 120
PUBLICATION_STATUS_DRAFT_ID  = 159
PUBLICATION_STATUS_PUBLISHED_ID  = 160
PUBLISHED_MATERIAL_ID  = 129
REFERENCE_ID  = 141
RELATED_MATERIAL_DESCRIPTIONS_ID  = 176
RELATION_NOTE_DATE_ID  = 155
RELATION_NOTE_DESCRIPTION_ID  = 154
RGT  = 'term.rgt'
RIGHT_BASIS_COPYRIGHT_ID  = 170
RIGHT_BASIS_LICENSE_ID  = 171
RIGHT_BASIS_POLICY_ID  = 173
RIGHT_BASIS_STATUTE_ID  = 172
RIGHT_ID  = 168
ROOT_ID  = 110
SCOPE_NOTE_ID  = 122
SOURCE_CULTURE  = 'term.source_culture'
SOURCE_NOTE_ID  = 121
STANDARDIZED_FORM_OF_NAME_ID  = 165
STATUS_TYPE_PUBLICATION_ID  = 158
SUBJECT_ID  = 35
SUBTITLES_ID  = 196
SUPPORTING_DOCUMENTATION_ID  = 181
SUPPORTING_TECHNOLOGY_ID  = 182
TABLE_NAME  = 'term'
TAXONOMY_ID_COL  = 'term.taxonomy_id'
TEMPORAL_RELATION_ID  = 151
TERM_RELATION_ASSOCIATIVE_ID  = 157
TEXT_ID  = 137
THUMBNAIL_ID  = 142
TITLE_NOTE_ID  = 119
USER_ACTION_CREATION_ID  = 189
USER_ACTION_MODIFICATION_ID  = 190
VIDEO_ID  = 138

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.
getByTaxonomyId()  : mixed
getChildren()  : Collection
Get children using MPTT parent_id.
getNameById()  : mixed
getOne()  : object|null
Get a single row matching criteria.
getRoot()  : mixed
getTaxonomy()  : object|null
Get taxonomy (for terms).
hydrate()  : static
Hydrate a database row into an instance of the calling class.
isProtected()  : mixed
loadTermParentList()  : array<string|int, mixed>
Load term parent list for given taxonomy IDs.

Constants

ACCESSION_ALTERNATIVE_IDENTIFIER_DEFAULT_TYPE_ID

public mixed ACCESSION_ALTERNATIVE_IDENTIFIER_DEFAULT_TYPE_ID = 192

ACCESSION_EVENT_NOTE_ID

public mixed ACCESSION_EVENT_NOTE_ID = 194

ACCESSION_EVENT_PHYSICAL_TRANSFER_ID

public mixed ACCESSION_EVENT_PHYSICAL_TRANSFER_ID = 193

ACCESSION_ID

public mixed ACCESSION_ID = 167

ACCUMULATION_ID

public mixed ACCUMULATION_ID = 118

ACTOR_ENTITY_TYPE_CORPORATE_BODY_ID

public mixed ACTOR_ENTITY_TYPE_CORPORATE_BODY_ID = 131

ACTOR_ENTITY_TYPE_FAMILY_ID

public mixed ACTOR_ENTITY_TYPE_FAMILY_ID = 133

ACTOR_ENTITY_TYPE_PERSON_ID

public mixed ACTOR_ENTITY_TYPE_PERSON_ID = 132

ACTOR_OCCUPATION_NOTE_ID

public mixed ACTOR_OCCUPATION_NOTE_ID = 188

AIP_RELATION_ID

public mixed AIP_RELATION_ID = 178

ALTERNATIVE_LABEL_ID

public mixed ALTERNATIVE_LABEL_ID = 156

ARCHIVAL_MATERIAL_ID

public mixed ARCHIVAL_MATERIAL_ID = 128

ARCHIVIST_NOTE_ID

public mixed ARCHIVIST_NOTE_ID = 124

ARTEFACT_MATERIAL_ID

public mixed ARTEFACT_MATERIAL_ID = 130

ARTWORK_COMPONENT_ID

public mixed ARTWORK_COMPONENT_ID = 179

ARTWORK_MATERIAL_ID

public mixed ARTWORK_MATERIAL_ID = 180

ASSOCIATIVE_RELATION_ID

public mixed ASSOCIATIVE_RELATION_ID = 153

COLLECTION_ID

public mixed COLLECTION_ID = 117

CONTAINER_ID

public mixed CONTAINER_ID = 145

CONTRIBUTION_ID

public mixed CONTRIBUTION_ID = 115

CONVERSE_TERM_ID

public mixed CONVERSE_TERM_ID = 177

CORPORATE_BODY_ID

public mixed CORPORATE_BODY_ID = 131

DISPLAY_NOTE_ID

public mixed DISPLAY_NOTE_ID = 123

EXTERNAL_FILE_ID

public mixed EXTERNAL_FILE_ID = 191

EXTERNAL_URI_ID

public mixed EXTERNAL_URI_ID = 166

FAMILY_NAME_FIRST_NAME_ID

public mixed FAMILY_NAME_FIRST_NAME_ID = 134

FAMILY_RELATION_ID

public mixed FAMILY_RELATION_ID = 152

GENERAL_NOTE_ID

public mixed GENERAL_NOTE_ID = 125

HAS_PHYSICAL_OBJECT_ID

public mixed HAS_PHYSICAL_OBJECT_ID = 147

HIERARCHICAL_RELATION_ID

public mixed HIERARCHICAL_RELATION_ID = 150

ISDF_ASSOCIATIVE_RELATION_ID

public mixed ISDF_ASSOCIATIVE_RELATION_ID = 164

ISDF_HIERARCHICAL_RELATION_ID

public mixed ISDF_HIERARCHICAL_RELATION_ID = 162

ISDF_TEMPORAL_RELATION_ID

public mixed ISDF_TEMPORAL_RELATION_ID = 163

JOB_ERROR_NOTE_ID

public mixed JOB_ERROR_NOTE_ID = 197

JOB_STATUS_COMPLETED_ID

public mixed JOB_STATUS_COMPLETED_ID = 184

JOB_STATUS_ERROR_ID

public mixed JOB_STATUS_ERROR_ID = 185

JOB_STATUS_IN_PROGRESS_ID

public mixed JOB_STATUS_IN_PROGRESS_ID = 183

LANGUAGE_NOTE_ID

public mixed LANGUAGE_NOTE_ID = 174

LEVEL_OF_DESCRIPTION_ID

public mixed LEVEL_OF_DESCRIPTION_ID = 34

MAINTAINING_REPOSITORY_RELATION_ID

public mixed MAINTAINING_REPOSITORY_RELATION_ID = 187

MAINTENANCE_NOTE_ID

public mixed MAINTENANCE_NOTE_ID = 127

NAME_ACCESS_POINT_ID

public mixed NAME_ACCESS_POINT_ID = 161

OTHER_DESCRIPTIVE_DATA_ID

public mixed OTHER_DESCRIPTIVE_DATA_ID = 126

OTHER_FORM_OF_NAME_ID

public mixed OTHER_FORM_OF_NAME_ID = 149

PARALLEL_FORM_OF_NAME_ID

public mixed PARALLEL_FORM_OF_NAME_ID = 148

PARENT_ID_COL

public mixed PARENT_ID_COL = 'term.parent_id'

PHYSICAL_OBJECT_ID

public mixed PHYSICAL_OBJECT_ID = 67

PUBLICATION_ID

public mixed PUBLICATION_ID = 114

PUBLICATION_NOTE_ID

public mixed PUBLICATION_NOTE_ID = 120

PUBLICATION_STATUS_DRAFT_ID

public mixed PUBLICATION_STATUS_DRAFT_ID = 159

PUBLICATION_STATUS_PUBLISHED_ID

public mixed PUBLICATION_STATUS_PUBLISHED_ID = 160

PUBLISHED_MATERIAL_ID

public mixed PUBLISHED_MATERIAL_ID = 129

REFERENCE_ID

public mixed REFERENCE_ID = 141
public mixed RELATED_MATERIAL_DESCRIPTIONS_ID = 176

RELATION_NOTE_DATE_ID

public mixed RELATION_NOTE_DATE_ID = 155

RELATION_NOTE_DESCRIPTION_ID

public mixed RELATION_NOTE_DESCRIPTION_ID = 154
public mixed RIGHT_BASIS_COPYRIGHT_ID = 170

RIGHT_BASIS_LICENSE_ID

public mixed RIGHT_BASIS_LICENSE_ID = 171

RIGHT_BASIS_POLICY_ID

public mixed RIGHT_BASIS_POLICY_ID = 173

RIGHT_BASIS_STATUTE_ID

public mixed RIGHT_BASIS_STATUTE_ID = 172

SCOPE_NOTE_ID

public mixed SCOPE_NOTE_ID = 122

SOURCE_CULTURE

public mixed SOURCE_CULTURE = 'term.source_culture'

SOURCE_NOTE_ID

public mixed SOURCE_NOTE_ID = 121

STANDARDIZED_FORM_OF_NAME_ID

public mixed STANDARDIZED_FORM_OF_NAME_ID = 165

STATUS_TYPE_PUBLICATION_ID

public mixed STATUS_TYPE_PUBLICATION_ID = 158

SUBTITLES_ID

public mixed SUBTITLES_ID = 196

SUPPORTING_DOCUMENTATION_ID

public mixed SUPPORTING_DOCUMENTATION_ID = 181

SUPPORTING_TECHNOLOGY_ID

public mixed SUPPORTING_TECHNOLOGY_ID = 182

TAXONOMY_ID_COL

public mixed TAXONOMY_ID_COL = 'term.taxonomy_id'

TEMPORAL_RELATION_ID

public mixed TEMPORAL_RELATION_ID = 151

TERM_RELATION_ASSOCIATIVE_ID

public mixed TERM_RELATION_ASSOCIATIVE_ID = 157

THUMBNAIL_ID

public mixed THUMBNAIL_ID = 142

TITLE_NOTE_ID

public mixed TITLE_NOTE_ID = 119

USER_ACTION_CREATION_ID

public mixed USER_ACTION_CREATION_ID = 189

USER_ACTION_MODIFICATION_ID

public mixed USER_ACTION_MODIFICATION_ID = 190

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

getByTaxonomyId()

public static getByTaxonomyId(mixed $taxonomyId[, mixed $culture = 'en' ]) : mixed
Parameters
$taxonomyId : mixed
$culture : mixed = 'en'

getChildren()

Get children using MPTT parent_id.

public getChildren() : Collection
Return values
Collection

getNameById()

public static getNameById(mixed $id[, mixed $culture = 'en' ]) : mixed
Parameters
$id : mixed
$culture : mixed = 'en'

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

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

isProtected()

public static isProtected(mixed $id) : mixed
Parameters
$id : mixed

loadTermParentList()

Load term parent list for given taxonomy IDs.

public static loadTermParentList([array<string|int, mixed> $taxonomyIds = [] ]) : array<string|int, mixed>

Used by Elasticsearch indexing.

Parameters
$taxonomyIds : array<string|int, mixed> = []
Return values
array<string|int, mixed>

        
On this page

Search results