Heratio Framework API Reference

RequestToPublishWriteServiceInterface
in

Contract for request-to-publish write operations.

Covers: creating and updating request-to-publish records on information objects. The request_to_publish entity uses the AtoM inheritance chain: object -> request_to_publish -> request_to_publish_i18n

Table of Contents

Methods

createRequest()  : int
Create a new request-to-publish record.
updateRequest()  : void
Update an existing request-to-publish record.

Methods

createRequest()

Create a new request-to-publish record.

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

Request data including:

  • rtp_name (string)
  • rtp_surname (string)
  • rtp_phone (string)
  • rtp_email (string)
  • rtp_institution (string)
  • rtp_motivation (string)
  • rtp_planned_use (string)
  • rtp_need_image_by (string|null)
  • parent_id (string) unique identifier
  • unique_identifier (string)
  • object_id (int) information object ID
  • status_id (int)
$culture : string = 'en'

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

Return values
int

The new request-to-publish ID

updateRequest()

Update an existing request-to-publish record.

public updateRequest(int $id, array<string|int, mixed> $data) : void
Parameters
$id : int

The request-to-publish ID

$data : array<string|int, mixed>

Column => value pairs to update


        
On this page

Search results