Changes between Version 6 and Version 7 of Drupal HowTo Write Cron Tasks for CiviCRM

Timestamp:

05/30/14 15:02:26 (11 years ago)

Author:

Richard Bramley

Comment:

--

Drupal HowTo Write Cron Tasks for CiviCRM

@@ -30 +30 @@
 
 However, for an automated process this isn't what we want, because cron jobs will be assigned to whichever user happens to be logged in at the time the job is triggered. Instead, the LCBRU module creates a CiviCRM contact called 'Cron System' (LCBRU Staff sub-type), and all the functions and activities performed by cron tasks should be explicitly assigned to that specific contact ID. This will require the cron job to look up the Cron System in order to obtain the correct contact ID.
+
+== !CronHelper
+
+In order to assist with some of the common tasks associated with Drupal cron tasks a new !CronHelper class has been created.
+
+=== Functions
+
+1. Initialise CiviCRM
+1. Switch the user used for thr cron job from the anonymous user to the Cron System User for the duration of the processing.
+1. Ascertain if the cron processing is due to run.
+
+=== Usage
+
+The following code shows how the cron Helper should used.
+
+{{{#!php
+ // Implementation of Drupal cron hook
+ function module_cron() {
+
+    $helper = new CronHelper('JobName', variable_get('MODULE_CRON_FREQUENCY', CronHelper::FREQUENCY_WEEKLY));
+
+     if (!$helper->is_due()) {
+        return;
+     }
+
+    $helper->start();
+    
+    try {
+        if 
+        // Do stuff here
+        
+    } catch (Exception $ex) {
+        throw $ex;
+    } finally {
+        $helper->end();
+    }
+    
+ }
+}}}