You are here

AuthcacheP13nFragmentInterface.inc in Authenticated User Page Caching (Authcache) 7.2

Defines authcache personalized fragment renderer.

File

modules/authcache_p13n/includes/AuthcacheP13nFragmentInterface.inc
View source
<?php

/**
 * @file
 * Defines authcache personalized fragment renderer.
 */

/**
 * Interface for personalization fragment renderers.
 */
interface AuthcacheP13nFragmentInterface {

  /**
   * Render and return fragment.
   *
   * @param string $key
   *   The key for the fragment to be rendered.
   *
   * @param var $subject
   *   The result of the loader function for the given key. If no
   *   AuthcacheP13nFragmentLoader is associated with this fragment, subject is
   *   equal to key.
   *
   * @param array $context
   *   Additional run-time per-request context (key-value pairs).
   *
   * @return string
   *   Return a string representing the HTML fragment
   */
  public function render($key, $subject, $context);

}

Interfaces

Namesort descending Description
AuthcacheP13nFragmentInterface Interface for personalization fragment renderers.