Newer
Older
Earl Miles
committed
<?php
// $Id$
/**
* @file
Earl Miles
committed
* Provides a simple time-based caching option for panel panes.
*/
// Plugin definition
$plugin = array(
'title' => t("Simple cache"),
'description' => t('Simple caching is a time-based cache. This is a hard limit, and once cached it will remain that way until the time limit expires.'),
'cache get' => 'panels_simple_cache_get_cache',
'cache set' => 'panels_simple_cache_set_cache',
'cache clear' => 'panels_simple_cache_clear_cache',
'settings form' => 'panels_simple_cache_settings_form',
'settings form submit' => 'panels_simple_cache_settings_form_submit',
'defaults' => array(
'lifetime' => 15,
'granularity' => 'none',
),
);
Earl Miles
committed
/**
* Get cached content.
*/
function panels_simple_cache_get_cache($conf, $display, $args, $contexts, $pane = NULL) {
$cid = panels_simple_cache_get_id($conf, $display, $args, $contexts, $pane);
$cache = cache_get($cid, 'cache');
if (!$cache) {
return FALSE;
}
if ((time() - $cache->created) > $conf['lifetime']) {
return FALSE;
}
return $cache->data;
Earl Miles
committed
}
/**
* Set cached content.
*/
function panels_simple_cache_set_cache($conf, $content, $display, $args, $contexts, $pane = NULL) {
$cid = panels_simple_cache_get_id($conf, $display, $args, $contexts, $pane);
cache_set($cid, $content);
Earl Miles
committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
}
/**
* Clear cached content.
*
* Cache clears are always for an entire display, regardless of arguments.
*/
function panels_simple_cache_clear_cache($display) {
$cid = 'panels_simple_cache';
// This is used in case this is an in-code display, which means did will be something like 'new-1'.
if (isset($display->owner) && isset($display->owner->id)) {
$cid .= ':' . $display->owner->id;
}
$cid .= ':' . $display->did;
cache_clear_all($cid, 'cache', TRUE);
}
/**
* Figure out an id for our cache based upon input and settings.
*/
function panels_simple_cache_get_id($conf, $display, $args, $contexts, $pane) {
$id = 'panels_simple_cache';
// This is used in case this is an in-code display, which means did will be something like 'new-1'.
if (isset($display->owner) && isset($display->owner->id)) {
$id .= ':' . $display->owner->id;
}
$id .= ':' . $display->did;
if ($pane) {
$id .= ':' . $pane->pid;
}
if (user_access('view pane admin links')) {
$id .= ':admin';
}
switch ($conf['granularity']) {
case 'args':
foreach ($args as $arg) {
$id .= ':' . $arg;
}
break;
case 'context':
if (!is_array($contexts)) {
$contexts = array($contexts);
}
foreach ($contexts as $context) {
if (isset($context->argument)) {
$id .= ':' . $context->argument;
}
}
}
if (module_exists('locale')) {
global $language;
$id .= ':' . $language->language;
}
if($pane->configuration['use_pager'] == 1) {
$id .= ':p' . check_plain($_GET['page']);
}
Earl Miles
committed
return $id;
}
function panels_simple_cache_settings_form($conf, $display, $pid) {
$options = drupal_map_assoc(array(15, 30, 60, 120, 180, 240, 300, 600, 900, 1200, 1800, 3600, 7200, 14400, 28800, 43200, 86400, 172800, 259200, 345600, 604800), 'format_interval');
$form['lifetime'] = array(
'#title' => t('Lifetime'),
'#type' => 'select',
'#options' => $options,
'#default_value' => $conf['lifetime'],
);
$form['granularity'] = array(
'#title' => t('Granularity'),
'#type' => 'select',
Earl Miles
committed
'#options' => array(
'args' => t('Arguments'),
'context' => t('Context'),
'none' => t('None'),
),
'#description' => t('If "arguments" are selected, this content will be cached per individual argument to the entire display; if "contexts" are selected, this content will be cached per unique context in the pane or display; if "neither" there will be only one cache for this pane.'),
'#default_value' => $conf['granularity'],
);
return $form;
}