boost.rules.inc in Boost 6

Integration with the rules module

File

boost.rules.inc

<?php

/**
 * @file
 * Integration with the rules module
 */

/**
 * Implementation of hook_rules_action_info().
 *
 * @ingroup rules
 */
function boost_rules_action_info() {
  return array(
    'boost_rules_action_clear_page' => array(
      'label' => t('Clear a page from the boost cache.'),
      'arguments' => array(
        'page' => array(
          'type' => 'string',
          'label' => t('URL of page to clear'),
        ),
      ),
      'module' => 'Boost',
    ),
  );
}

/**
 * Clears a page from the Boost cache
 */
function boost_rules_action_clear_page($page, $settings) {
  if (file_exists(boost_file_path($page, FALSE))) {
    $expire_now = $settings['expire_now'];
    boost_cache_expire_derivative(array(
      $page,
    ), $expire_now, $expire_now);
    if (BOOST_VERBOSE >= 5) {
      watchdog('boost', 'Rules flushed !page from static page cache.', array(
        '!page' => $page,
      ));
    }
  }
}

/**
 * Action clear page from cache configuration form.
 */
function boost_rules_action_clear_page_form($settings, &$form) {
  $settings += array(
    'page' => '',
  );
  $form['settings']['page'] = array(
    '#type' => 'textarea',
    '#title' => t('Page URL'),
    '#default_value' => $settings['page'],
    '#description' => t('The short URL of the page to clear from the Boost cache.'),
  );
  $form['settings']['expire_now'] = array(
    '#type' => 'checkbox',
    '#title' => t('Clear cache file(s) immediately.'),
    '#default_value' => $settings['expire_now'],
    '#description' => t('If unchecked, cache file(s) will be cleared on the next cron run.'),
  );
}

Functions

Name	Description
boost_rules_action_clear_page	Clears a page from the Boost cache
boost_rules_action_clear_page_form	Action clear page from cache configuration form.
boost_rules_action_info	Implementation of hook_rules_action_info().