UserJobInterface
in
Table of Contents
Methods
- getUserJobInfo() : array<string|int, mixed>
- Get information about the provided job.
- runJob() : bool
- Run import.
Methods
getUserJobInfo()
Get information about the provided job.
public
static getUserJobInfo() : array<string|int, mixed>
- name
- id (generally the same as name)
- label
- entity
- url
e.g. ['activity_import' => ['id' => 'activity_import', 'label' => ts('Activity Import'), 'name' => 'activity_import']]
Return values
array<string|int, mixed>runJob()
Run import.
public
static runJob(CRM_Queue_TaskContext $taskContext, int $userJobID, int $limit, int $offset) : bool
Parameters
- $taskContext : CRM_Queue_TaskContext
- $userJobID : int
-
The id in the civicrm_user_job table.
- $limit : int
-
A value of zero means no limit
- $offset : int