SproutCMS

class WorkerCtrl

Functions to update and report on worker status

• File: /sprout/Helpers/WorkerCtrl.php
• Namespace: Sprout\Helpers

Functions

private findPhp

Looks in a few places for a PHP binary

public getStatus

Return the status and metric values for a given worker job.

Statuses are:
  'Prepared', 'Running', 'Success', 'Failed'.

Returns an array of ['status', 'metric1val', 'metric2val', 'metric3val'], or NULL on error.

public start

Starts a new worker
Workers are run in their own process (using the PHP CLI)

The first argument is the class name
Additional arguments can be provided directly in the function call

Return value is an array with the following keys
  job_id    The ID of the new job
  log_url   URL to view ongoing status and log