acquia_purge.api.php in Acquia Purge 7

Hooks provided by the Acquia Purge module.

File

acquia_purge.api.php

<?php

/**
 * @file
 * Hooks provided by the Acquia Purge module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Register pre-flight diagnostic check functions.
 *
 * Each function referred to in these hook implementations, are called before
 * Acquia Purge starts operating or when "drush ap-diagnosis" is called. These
 * checks should be as lightweight as possible to prevent performance problems.
 *
 * Each function, is called with these parameters:
 *   - string $t: Name of the t() function to call.
 *   - AcquiaPurgeService $service: The Acquia Purge service.
 *
 * Each function, should return an associative array with these elements:
 *   - title: The name of the requirement.
 *   - value: The current value (e.g., version, time, level, etc).
 *   - description: The description of the requirement/status.
 *   - severity:
 *       - ACQUIA_PURGE_SEVLEVEL_INFO
 *       - ACQUIA_PURGE_SEVLEVEL_OK
 *       - ACQUIA_PURGE_SEVLEVEL_WARNING
 *       - ACQUIA_PURGE_SEVLEVEL_ERROR <-- blocks Acquia Purge from executing!
 *
 * If you need to load a file before your test functions get called, add this:
 *   'module_load_include' => array('inc', 'mymodule', 'ap_diagnostics')
 *
 * @see acquia_purge.diagnostics.inc
 */
function hook_acquia_purge_diagnostics() {
  return array(
    'module_load_include' => array(
      'inc',
      'mymodule',
      'ap_diagnostics',
    ),
    '_mymodule_ap_diagnostic_apikey',
    '_mymodule_ap_diagnostic_apirate',
  );
}

/**
 * Alter the list of domains Acquia Purge operates on.
 *
 * Modules may implement this hook to influence the domain names Acquia Purge
 * is purging and have more narrow control over it. Although it is generally
 * discouraged to do this, it does make sense in complexer scenarios with many
 * domains that need to be reduced to stay under the diagnostic limit.
 *
 * @param string[] $domains
 *   Unassociative array with domain names as string values.
 *
 * @see AcquiaPurgeHostingInfo::getDomains()
 */
function hook_acquia_purge_domains_alter(array &$domains) {
  $blacklist = array(
    'domain_a',
    'domain_b',
  );
  foreach ($domains as $i => $domain) {
    if (in_array($domain, $blacklist)) {
      unset($domains[$i]);
    }
  }
  $domains[] = 'my_domain';
}

/**
 * DEPRECATED: React after paths paths purged failed.
 *
 * @deprecated
 */
function hook_acquia_purge_purge_failure(array $paths) {
  foreach ($paths as $path) {
    drupal_set_message(t('"@path"', array(
      '@path' => $path,
    )), 'error');
  }
}

/**
 * DEPRECATED: React after paths paths purged successfully.
 *
 * @deprecated
 */
function hook_acquia_purge_purge_success(array $paths) {
  foreach ($paths as $path) {
    drupal_set_message(t('"@path"', array(
      '@path' => $path,
    )));
  }
}

/**
 * Register executor backends to run after Acquia Purge's core executors.
 *
 * @param string[] $paths
 *   List of paths to files declaring AcquiaPurgeExecutorInterface derivatives.
 *
 * @see _acquia_purge_load()
 * @see AcquiaPurgeExecutorsService::getRegisteredBackends()
 * @see AcquiaPurgeExecutorBase
 * @see AcquiaPurgeExecutorInterface
 */
function hook_acquia_purge_executors(&$paths) {
  $paths[] = drupal_get_path('module', 'mymodule') . '/myExecutorBackend.php';
}

/**
 * Edit/extend the list of variations for $path.
 *
 * When the site has variations enabled, administrators will automatically
 * see their manual purge attempts getting more purged than they asked for,
 * which happens to aid them in wiping absolutely everything they wanted
 * cleaned. For instance editors on your site always want to get the RSS
 * feed refreshed when they wipe the 'news' page, which you can easily
 * tweak for them with this hook.
 *
 * @param string $path
 *   The Drupal path (for example: '<front>', 'user/1' or a alias).
 * @param string[] $variations
 *   All the variations that have been made up as possible other incarnations
 *   of the page that needs a manual wipe. You can delete items as well as
 *   adding new ones, as long as they are path sections (and NOT full urls!)
 *   on which Acquia Purge can perform Varnish purges thereafter.
 *
 * @see _acquia_purge_input_path_variations()
 */
function hook_acquia_purge_variations_alter($path, array &$variations) {
  if (in_array($path, array(
    '<front>',
    '',
    '/',
  ))) {
    $variations[] = 'rss.xml';
  }
  if ($path === 'news') {
    $variations[] = 'news/feed';
  }
}

/**
 * @} End of "addtogroup hooks".
 */

Functions

Name	Description
hook_acquia_purge_diagnostics	Register pre-flight diagnostic check functions.
hook_acquia_purge_domains_alter	Alter the list of domains Acquia Purge operates on.
hook_acquia_purge_executors	Register executor backends to run after Acquia Purge's core executors.
hook_acquia_purge_purge_failure	DEPRECATED: React after paths paths purged failed.
hook_acquia_purge_purge_success	DEPRECATED: React after paths paths purged successfully.
hook_acquia_purge_variations_alter	Edit/extend the list of variations for $path.