Heratio Framework API Reference

QubitRights
in package
uses QubitModelTrait

Table of Contents

Constants

ACT_ID  = 'rights.act_id'
BASIS_ID  = 'rights.basis_id'
COPYRIGHT_JURISDICTION  = 'rights.copyright_jurisdiction'
COPYRIGHT_STATUS_ID  = 'rights.copyright_status_id'
END_DATE  = 'rights.end_date'
ID  = 'rights.id'
OBJECT_ID  = 'rights.object_id'
RIGHTS_HOLDER_ID  = 'rights.rights_holder_id'
SOURCE_CULTURE  = 'rights.source_culture'
START_DATE  = 'rights.start_date'
STATUTE_DETERMINATION_DATE  = 'rights.statute_determination_date'

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
copy()  : int
Copy rights from one object to another (stub).
getAll()  : Collection
Get all rows matching criteria.
getAncestors()  : object
Get ancestors using MPTT (nested set) lft/rgt columns.
getBasis()  : QubitTerm|null
Get the basis term.
getById()  : static|null
Load an entity by primary key.
getByObjectId()  : array<string|int, mixed>
Get all rights for a specific object.
getBySlug()  : object|null
Load an entity by slug.
getChildren()  : Collection
Get children using MPTT parent_id.
getGrantedRights()  : array<string|int, mixed>
Get the granted rights for this rights statement.
getOne()  : object|null
Get a single row matching criteria.
getRightsHolder()  : QubitRightsHolder|null
Get the rights holder.
getTaxonomy()  : object|null
Get taxonomy (for terms).
hydrate()  : static
Hydrate a database row into an instance of the calling class.

Constants

COPYRIGHT_JURISDICTION

public mixed COPYRIGHT_JURISDICTION = 'rights.copyright_jurisdiction'

COPYRIGHT_STATUS_ID

public mixed COPYRIGHT_STATUS_ID = 'rights.copyright_status_id'

OBJECT_ID

public mixed OBJECT_ID = 'rights.object_id'

RIGHTS_HOLDER_ID

public mixed RIGHTS_HOLDER_ID = 'rights.rights_holder_id'

SOURCE_CULTURE

public mixed SOURCE_CULTURE = 'rights.source_culture'

START_DATE

public mixed START_DATE = 'rights.start_date'

STATUTE_DETERMINATION_DATE

public mixed STATUTE_DETERMINATION_DATE = 'rights.statute_determination_date'

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

copy()

Copy rights from one object to another (stub).

public static copy(int $sourceId, int $targetId) : int
Parameters
$sourceId : int
$targetId : int
Return values
int —

Number of rights copied (0 in read-only mode)

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 all rights for a specific object.

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

getGrantedRights()

Get the granted rights for this rights statement.

public getGrantedRights() : 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

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