Heratio Framework API Reference

QubitActor
in package
uses QubitModelTrait

Table of Contents

Constants

CORPORATE_BODY_IDENTIFIERS  = 'actor.corporate_body_identifiers'
DESCRIPTION_DETAIL_ID  = 'actor.description_detail_id'
DESCRIPTION_IDENTIFIER  = 'actor.description_identifier'
DESCRIPTION_STATUS_ID  = 'actor.description_status_id'
ENTITY_TYPE_ID  = 'actor.entity_type_id'
ID  = 'actor.id'
PARENT_ID  = 'actor.parent_id'
ROOT_ID  = 3
SOURCE_CULTURE  = 'actor.source_culture'

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
getActorNotes()  : array<string|int, mixed>
Get actor-specific notes.
getActorRelations()  : array<string|int, mixed>
Get actor-to-actor relations.
getAll()  : Collection
Get all rows matching criteria.
getAncestors()  : object
Get ancestors using MPTT (nested set) lft/rgt columns.
getByAuthorizedFormOfName()  : static|null
Find actor by authorized form of name.
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.
getContactInformation()  : array<string|int, mixed>
Get all contact information records for this actor.
getMaintainingRepository()  : QubitRepository|null
Get maintaining repository for this actor.
getOccupations()  : array<string|int, mixed>
Get actor occupations (term relations via ACTOR_OCCUPATION_ID taxonomy).
getOne()  : object|null
Get a single row matching criteria.
getPlaceAccessPoints()  : array<string|int, mixed>
Get place access points.
getPrimaryContact()  : object|null
Get primary contact, or first contact as fallback.
getResourceRelations()  : array<string|int, mixed>
Get resource relations (events linking actor to information objects).
getRoot()  : mixed
getSubjectAccessPoints()  : array<string|int, mixed>
Get subject access points.
getTaxonomy()  : object|null
Get taxonomy (for terms).
hydrate()  : static
Hydrate a database row into an instance of the calling class.

Constants

CORPORATE_BODY_IDENTIFIERS

public mixed CORPORATE_BODY_IDENTIFIERS = 'actor.corporate_body_identifiers'

DESCRIPTION_DETAIL_ID

public mixed DESCRIPTION_DETAIL_ID = 'actor.description_detail_id'

DESCRIPTION_IDENTIFIER

public mixed DESCRIPTION_IDENTIFIER = 'actor.description_identifier'

DESCRIPTION_STATUS_ID

public mixed DESCRIPTION_STATUS_ID = 'actor.description_status_id'

ENTITY_TYPE_ID

public mixed ENTITY_TYPE_ID = 'actor.entity_type_id'

PARENT_ID

public mixed PARENT_ID = 'actor.parent_id'

SOURCE_CULTURE

public mixed SOURCE_CULTURE = 'actor.source_culture'

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

getActorNotes()

Get actor-specific notes.

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

getActorRelations()

Get actor-to-actor relations.

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

Array of relation objects

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

getByAuthorizedFormOfName()

Find actor by authorized form of name.

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

Authorized form of name

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

Options (culture)

Return values
static|null

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

getContactInformation()

Get all contact information records for this actor.

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

Array of hydrated objects

getOccupations()

Get actor occupations (term relations via ACTOR_OCCUPATION_ID taxonomy).

public getOccupations() : 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>
Return values
array<string|int, mixed>

getPrimaryContact()

Get primary contact, or first contact as fallback.

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

getResourceRelations()

Get resource relations (events linking actor to information objects).

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

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

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