Heratio Framework API Reference

ExtendedRightsService
in package

Extended Rights Service Handles RightsStatements.org, Creative Commons, TK Labels, and Embargoes

Table of Contents

Methods

__construct()  : mixed
assignCreativeCommons()  : bool
assignRightsStatement()  : bool
assignTkLabel()  : bool
batchAssignRights()  : int
createEmbargo()  : int
extendEmbargo()  : bool
getActiveEmbargoes()  : Collection
getCreativeCommonsLicenseByCode()  : object|null
getCreativeCommonsLicenses()  : Collection
getEmbargoForObject()  : object|null
getObjectRights()  : object
getRightsStatementByCode()  : object|null
getRightsStatements()  : Collection
getRightsStatistics()  : object
getTkLabelByCode()  : object|null
getTkLabelCategories()  : Collection
getTkLabels()  : Collection
getTkLabelsByCategory()  : Collection
liftEmbargo()  : bool
removeTkLabel()  : bool

Methods

__construct()

public __construct(DatabaseManager $db) : mixed
Parameters
$db : DatabaseManager

assignCreativeCommons()

public assignCreativeCommons(int $objectId, int $licenseId[, string|null $notes = null ]) : bool
Parameters
$objectId : int
$licenseId : int
$notes : string|null = null
Return values
bool

assignRightsStatement()

public assignRightsStatement(int $objectId, int $rightsStatementId[, string|null $notes = null ]) : bool
Parameters
$objectId : int
$rightsStatementId : int
$notes : string|null = null
Return values
bool

assignTkLabel()

public assignTkLabel(int $objectId, int $labelId[, array<string|int, mixed> $data = [] ]) : bool
Parameters
$objectId : int
$labelId : int
$data : array<string|int, mixed> = []
Return values
bool

batchAssignRights()

public batchAssignRights(array<string|int, mixed> $objectIds, string $type, int $valueId[, string|null $notes = null ]) : int
Parameters
$objectIds : array<string|int, mixed>
$type : string
$valueId : int
$notes : string|null = null
Return values
int

createEmbargo()

public createEmbargo(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>
Return values
int

extendEmbargo()

public extendEmbargo(int $embargoId, string $newEndDate[, string|null $reason = null ]) : bool
Parameters
$embargoId : int
$newEndDate : string
$reason : string|null = null
Return values
bool

getCreativeCommonsLicenseByCode()

public getCreativeCommonsLicenseByCode(string $code) : object|null
Parameters
$code : string
Return values
object|null

getCreativeCommonsLicenses()

public getCreativeCommonsLicenses([bool $activeOnly = true ]) : Collection
Parameters
$activeOnly : bool = true
Return values
Collection

getEmbargoForObject()

public getEmbargoForObject(int $objectId) : object|null
Parameters
$objectId : int
Return values
object|null

getObjectRights()

public getObjectRights(int $objectId) : object
Parameters
$objectId : int
Return values
object

getRightsStatementByCode()

public getRightsStatementByCode(string $code) : object|null
Parameters
$code : string
Return values
object|null

getRightsStatements()

public getRightsStatements([bool $activeOnly = true ]) : Collection
Parameters
$activeOnly : bool = true
Return values
Collection

getTkLabelByCode()

public getTkLabelByCode(string $code) : object|null
Parameters
$code : string
Return values
object|null

getTkLabels()

public getTkLabels([bool $activeOnly = true ]) : Collection
Parameters
$activeOnly : bool = true
Return values
Collection

getTkLabelsByCategory()

public getTkLabelsByCategory(int $categoryId) : Collection
Parameters
$categoryId : int
Return values
Collection

liftEmbargo()

public liftEmbargo(int $embargoId[, int|null $userId = null ]) : bool
Parameters
$embargoId : int
$userId : int|null = null
Return values
bool

removeTkLabel()

public removeTkLabel(int $objectId, int $labelId) : bool
Parameters
$objectId : int
$labelId : int
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results