CustodianController
in package
Custodian Controller.
Handles custodian interface API requests.
Table of Contents
Methods
- __construct() : mixed
- cancelBatchJob() : array<string|int, mixed>
- Cancel batch job.
- createBatchJob() : array<string|int, mixed>
- Create batch job.
- executeBatchUpdate() : array<string|int, mixed>
- Execute batch update.
- getBatchJob() : array<string|int, mixed>
- Get batch job details.
- getBatchJobItems() : array<string|int, mixed>
- Get batch job items.
- getBatchJobs() : array<string|int, mixed>
- Get batch jobs.
- getDashboard() : array<string|int, mixed>
- Get custodian dashboard data.
- getItem() : array<string|int, mixed>
- Get item for editing.
- getItemHistory() : array<string|int, mixed>
- Get item history.
- getRecentActivity() : array<string|int, mixed>
- Get recent activity.
- searchAuditLogs() : array<string|int, mixed>
- Search audit logs.
- updateItem() : array<string|int, mixed>
- Update item.
Methods
__construct()
public
__construct([string $culture = 'en' ]) : mixed
Parameters
- $culture : string = 'en'
cancelBatchJob()
Cancel batch job.
public
cancelBatchJob(int $jobId) : array<string|int, mixed>
Parameters
- $jobId : int
Return values
array<string|int, mixed>createBatchJob()
Create batch job.
public
createBatchJob(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
Return values
array<string|int, mixed>executeBatchUpdate()
Execute batch update.
public
executeBatchUpdate(int $jobId, array<string|int, mixed> $updates, int $userId) : array<string|int, mixed>
Parameters
- $jobId : int
- $updates : array<string|int, mixed>
- $userId : int
Return values
array<string|int, mixed>getBatchJob()
Get batch job details.
public
getBatchJob(int $jobId) : array<string|int, mixed>
Parameters
- $jobId : int
Return values
array<string|int, mixed>getBatchJobItems()
Get batch job items.
public
getBatchJobItems(int $jobId[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $jobId : int
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>getBatchJobs()
Get batch jobs.
public
getBatchJobs([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>getDashboard()
Get custodian dashboard data.
public
getDashboard([int|null $userId = null ]) : array<string|int, mixed>
Parameters
- $userId : int|null = null
Return values
array<string|int, mixed>getItem()
Get item for editing.
public
getItem(int $objectId) : array<string|int, mixed>
Parameters
- $objectId : int
Return values
array<string|int, mixed>getItemHistory()
Get item history.
public
getItemHistory(int $objectId[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $objectId : int
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>getRecentActivity()
Get recent activity.
public
getRecentActivity([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>searchAuditLogs()
Search audit logs.
public
searchAuditLogs(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>updateItem()
Update item.
public
updateItem(int $objectId, array<string|int, mixed> $data[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
- $objectId : int
- $data : array<string|int, mixed>
- $userId : int|null = null