Heratio Framework API Reference

QubitInformationObject
in package
uses QubitModelTrait

Table of Contents

Constants

COLLECTION_TYPE_ID  = 'information_object.collection_type_id'
DESCRIPTION_DETAIL_ID  = 'information_object.description_detail_id'
DESCRIPTION_IDENTIFIER  = 'information_object.description_identifier'
DESCRIPTION_STATUS_ID  = 'information_object.description_status_id'
DISPLAY_STANDARD_ID  = 'information_object.display_standard_id'
ID  = 'information_object.id'
IDENTIFIER  = 'information_object.identifier'
LEVEL_OF_DESCRIPTION_ID  = 'information_object.level_of_description_id'
LFT  = 'information_object.lft'
OAI_LOCAL_IDENTIFIER  = 'information_object.oai_local_identifier'
PARENT_ID  = 'information_object.parent_id'
REPOSITORY_ID  = 'information_object.repository_id'
RGT  = 'information_object.rgt'
ROOT_ID  = 1
SOURCE_CULTURE  = 'information_object.source_culture'
SOURCE_STANDARD  = 'information_object.source_standard'

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
getActorEvents()  : array<string|int, mixed>
Get actor-related events (events with an actor_id).
getActors()  : array<string|int, mixed>
Get actors related via events.
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.
getCollectionRoot()  : static|null
Get the collection root (highest non-root ancestor).
getCreationEvents()  : array<string|int, mixed>
Get creation events.
getCreators()  : array<string|int, mixed>
Get creators (actors with CREATION event type).
getDates()  : array<string|int, mixed>
Get date-related events.
getGenreAccessPoints()  : array<string|int, mixed>
Get genre access points.
getInheritedReferenceCode()  : string
Get inherited reference code by walking the parent chain.
getMaterialTypes()  : array<string|int, mixed>
Get material types.
getNameAccessPoints()  : array<string|int, mixed>
Get name access points (actor relations of type NAME_ACCESS_POINT_ID).
getOne()  : object|null
Get a single row matching criteria.
getPlaceAccessPoints()  : array<string|int, mixed>
Get place access points.
getProperties()  : array<string|int, mixed>
Get properties by name and/or scope.
getPublicationStatus()  : object|null
Get publication status.
getRepository()  : QubitRepository|null
Get associated repository.
getRoot()  : mixed
getSubjectAccessPoints()  : array<string|int, mixed>
Get subject access points.
getTaxonomy()  : object|null
Get taxonomy (for terms).
getTermRelations()  : array<string|int, mixed>
Get term relations for a given taxonomy.
hydrate()  : static
Hydrate a database row into an instance of the calling class.

Constants

DESCRIPTION_DETAIL_ID

public mixed DESCRIPTION_DETAIL_ID = 'information_object.description_detail_id'

DESCRIPTION_IDENTIFIER

public mixed DESCRIPTION_IDENTIFIER = 'information_object.description_identifier'

DESCRIPTION_STATUS_ID

public mixed DESCRIPTION_STATUS_ID = 'information_object.description_status_id'

LEVEL_OF_DESCRIPTION_ID

public mixed LEVEL_OF_DESCRIPTION_ID = 'information_object.level_of_description_id'

OAI_LOCAL_IDENTIFIER

public mixed OAI_LOCAL_IDENTIFIER = 'information_object.oai_local_identifier'

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

getActorEvents()

Get actor-related events (events with an actor_id).

public getActorEvents([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []

Options

Return values
array<string|int, mixed> —

Array of QubitEvent instances

getActors()

Get actors related via events.

public getActors([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []

Options: 'eventTypeId' to filter by event type

Return values
array<string|int, mixed> —

Array of QubitActor instances

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

getCollectionRoot()

Get the collection root (highest non-root ancestor).

public getCollectionRoot() : static|null
Return values
static|null

getCreationEvents()

Get creation events.

public getCreationEvents() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Array of QubitEvent instances

getCreators()

Get creators (actors with CREATION event type).

public getCreators([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []

Options

Return values
array<string|int, mixed> —

Array of QubitActor instances

getDates()

Get date-related events.

public getDates([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []

Options

Return values
array<string|int, mixed> —

Array of QubitEvent instances

getGenreAccessPoints()

Get genre access points.

public getGenreAccessPoints() : array<string|int, mixed>
Return values
array<string|int, mixed>

getInheritedReferenceCode()

Get inherited reference code by walking the parent chain.

public getInheritedReferenceCode([bool $includeRepoAndCountry = false ]) : string
Parameters
$includeRepoAndCountry : bool = false

Prepend repository identifier and country code

Return values
string

getMaterialTypes()

Get material types.

public getMaterialTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getNameAccessPoints()

Get name access points (actor relations of type NAME_ACCESS_POINT_ID).

public getNameAccessPoints() : array<string|int, mixed>
Return values
array<string|int, mixed>

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

getPlaceAccessPoints()

Get place access points.

public getPlaceAccessPoints([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []

Options

Return values
array<string|int, mixed>

getProperties()

Get properties by name and/or scope.

public getProperties([string|null $name = null ][, string|null $scope = null ]) : array<string|int, mixed>
Parameters
$name : string|null = null

Property name

$scope : string|null = null

Property scope

Return values
array<string|int, mixed>

getPublicationStatus()

Get publication status.

public getPublicationStatus() : object|null
Return values
object|null —

Status object with status_id property

getRepository()

Get associated repository.

public getRepository([array<string|int, mixed> $options = [] ]) : QubitRepository|null
Parameters
$options : array<string|int, mixed> = []

Options: 'inherit' => true to walk parent chain

Return values
QubitRepository|null

getSubjectAccessPoints()

Get subject access points.

public getSubjectAccessPoints() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTaxonomy()

Get taxonomy (for terms).

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

getTermRelations()

Get term relations for a given taxonomy.

public getTermRelations([int $taxonomyId = null ]) : array<string|int, mixed>
Parameters
$taxonomyId : int = null

Taxonomy ID to filter by

Return values
array<string|int, mixed>

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