authcache_debug.api.php in Authenticated User Page Caching (Authcache) 7.2

API documentation for hooks exposed by Authcache Debug.

File

modules/authcache_debug/authcache_debug.api.php

<?php

/**
 * @file
 * API documentation for hooks exposed by Authcache Debug.
 */

/**
 * Prevent that debug info is recorded on a given request.
 *
 * @return bool|NULL
 *   TRUE if no debug info should be recorded, otherwise NULL.
 */
function authcache_p13n_authcache_debug_exclude() {
  if (authcache_p13n_is_authcache_p13n_request()) {
    return TRUE;
  }
}

/**
 * Collect information displayed in the authcache debug widget.
 *
 * Return an array of key-value pairs which will be displayed in the debug
 * widget. This information is stored for each cached page request into the
 * cache bin cache_authcache_debug.
 *
 * @return array
 *   An array of key-value pairs which should be shown in the debug widget.
 */
function hook_authcache_debug_info() {
  global $user;
  return array(
    'Cache User E-Mail' => $user->uid ? $user->mail : 'anonymous',
  );
}

/**
 * Alter debug information before its being stored.
 *
 * @see hook_authcache_debug_info()
 */
function hook_authcache_debug_info_alter(&$debuginfo) {

  // Remove potentially sensitive data form debug info widget.
  unset($debuginfo['Cache User']);
  unset($debuginfo['Cache Users']);
}

Functions

Name	Description
authcache_p13n_authcache_debug_exclude	Prevent that debug info is recorded on a given request.
hook_authcache_debug_info	Collect information displayed in the authcache debug widget.
hook_authcache_debug_info_alter	Alter debug information before its being stored.