Changes between Version 11 and Version 12 of Drupal HowTo Write Cron Tasks for CiviCRM

Timestamp:

06/02/14 13:59:38 (10 years ago)

Author:

Richard Bramley

Comment:

--

Drupal HowTo Write Cron Tasks for CiviCRM

@@ -47 +47 @@
 
 {{{#!php
- // Implementation of Drupal cron hook
- function module_cron() {
+// 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 {
-
-        // Do stuff here
-        
-    } catch (Exception $ex) {
-        throw $ex;
-    } finally {
-        $helper->end();
-    }
-    
- }
+   $helper = new CronHelper('JobName');
+   $helper->runCron(function() {
+           // Do stuff here
+       });
+}
 }}}
 
 Things to note are:
-* The job name and frequency parameters for the constructor are optional and are only used if the helper is being used to check if the job is due.
-* The variable get for the frequency uses a default value from the constants defined in the !CronHelper class.
-* The start() method should be called before any processing occurs.
-* The end() method should *always* be called after processing.  Therefore, in the example all processing is placed in a try block with the end() method called from the matching finally block.
-
+* The jobName parameter cannot be NULL or empty.
+* The following additional option constructor parameters can be used to change the default enabled status and frequency:
+ * $defaultEnabled - takes values true or false.  The default is false.
+ * $defaultFrequency - takes one of the CronHelper frequency constant values:
+  * CronHelper::FREQUENCY_EVERY_CRON
+  * CronHelper::FREQUENCY_DAILY
+  * CronHelper::FREQUENCY_WEEKLY (default)
+  * CronHelper::FREQUENCY_MONTHLY
+* The runCron function takes either an anonymous function or a function name as it's argument.
 === Config Usage
 
+The values for the enable status and frequency can be changed by the user using a module configuration form.  CronHelper provides a utility function to add the setting fields to a configuration form.  For example
+
+{{{#!php
+function _module_config_form($form, &$form_state) {
+
+  $helper = new CronHelper('JobName');
+
+  $helper->addSettingsToForm($form);
+
+  return system_settings_form($form);
+}
+
+}}}
+