Heratio Framework API Reference

QubitNote
in package
uses QubitModelTrait

Table of Contents

Constants

ARCHIVISTS_NOTE_ID  = 174
GENERAL_NOTE_ID  = 268
ID  = 'note.id'
OBJECT_ID  = 'note.object_id'
PUBLICATION_NOTE_ID  = 147
SCOPE  = 'note.scope'
SOURCE_CULTURE  = 'note.source_culture'
TITLE_NOTE_ID  = 148
TYPE_ID  = 'note.type_id'
USER_ID  = 'note.user_id'

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.
getByObjectId()  : array<string|int, mixed>
Get notes for a specific object and type.
getBySlug()  : object|null
Load an entity by slug.
getChildren()  : Collection
Get children using MPTT parent_id.
getObject()  : object|null
Get the associated object.
getOne()  : object|null
Get a single row matching criteria.
getTaxonomy()  : object|null
Get taxonomy (for terms).
getType()  : QubitTerm|null
Get the note type term.
getUser()  : QubitUser|null
Get the user who created this note.
hydrate()  : static
Hydrate a database row into an instance of the calling class.

Constants

ARCHIVISTS_NOTE_ID

public mixed ARCHIVISTS_NOTE_ID = 174

GENERAL_NOTE_ID

public mixed GENERAL_NOTE_ID = 268

OBJECT_ID

public mixed OBJECT_ID = 'note.object_id'

PUBLICATION_NOTE_ID

public mixed PUBLICATION_NOTE_ID = 147

SOURCE_CULTURE

public mixed SOURCE_CULTURE = 'note.source_culture'

TITLE_NOTE_ID

public mixed TITLE_NOTE_ID = 148

TYPE_ID

public mixed TYPE_ID = 'note.type_id'

USER_ID

public mixed USER_ID = 'note.user_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

getByObjectId()

Get notes for a specific object and type.

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

['typeId' => int, 'culture' => string]

Return values
array<string|int, mixed>

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

getObject()

Get the associated object.

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

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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results