Heratio Framework API Reference

RightsHolderWriteServiceInterface
in

Contract for rights holder write operations.

RightsHolder extends Actor in AtoM's entity hierarchy: object -> actor -> rights_holder

The Propel adapter wraps QubitRightsHolder. The standalone adapter uses Laravel Query Builder.

Table of Contents

Methods

createRightsHolder()  : int
Create a new rights holder. Returns the new ID.
deleteRightsHolder()  : void
Delete a rights holder.
newRightsHolder()  : object
Create a new, empty rights holder object for form binding.
updateRightsHolder()  : void
Update an existing rights holder.

Methods

createRightsHolder()

Create a new rights holder. Returns the new ID.

public createRightsHolder(array<string|int, mixed> $data[, string $culture = 'en' ]) : int

Handles the entity inheritance: INSERT object -> INSERT actor -> INSERT rights_holder

Parameters
$data : array<string|int, mixed>

Rights holder data (authorized_form_of_name, etc.)

$culture : string = 'en'

Culture code (e.g., 'en')

Return values
int

The new rights_holder.id

newRightsHolder()

Create a new, empty rights holder object for form binding.

public newRightsHolder() : object

In Propel mode, returns a new QubitRightsHolder instance. In standalone mode, returns a stdClass with expected properties.

Return values
object

updateRightsHolder()

Update an existing rights holder.

public updateRightsHolder(int $id, array<string|int, mixed> $data[, string $culture = 'en' ]) : void
Parameters
$id : int

Rights holder ID

$data : array<string|int, mixed>

Column => value pairs to update

$culture : string = 'en'

Culture code for i18n attributes


        
On this page

Search results