function tripal_jobs_cancel

2.x tripal_core.DEPRECATED.api.inc tripal_jobs_cancel($job_id, $redirect = TRUE)
3.x tripal_core.DEPRECATED.inc tripal_jobs_cancel($job_id, $redirect = TRUE)
1.x tripal_core_jobs.api.inc tripal_jobs_cancel($job_id, $redirect = TRUE)

Deprecated

Restructured API to make naming more readable and consistent. Function was deprecated in Tripal 2.0 and will be removed 2 releases from now. This function has been replaced by tripal_cancel_job().

See also

tripal_cancel_job().

File

legacy/tripal_core/api/tripal_core.DEPRECATED.inc, line 603
Contains all the deprecated functions to keep the tripal api backwards compatible.

Code

function tripal_jobs_cancel($job_id, $redirect = TRUE) {
  tripal_report_error(
  'tripal_deprecated', 
  TRIPAL_NOTICE, 
  "DEPRECATED: %old_function has been replaced with %new_function. Please update your code.", 
  array(
    '%old_function' => 'tripal_jobs_cancel',
    '%new_function' => 'tripal_cancel_job'
  )
  );

  //New API Function
  return tripal_cancel_job($job_id);
}