<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
/**
* Retrieve an item from the DB cache
*
- * @param string $group (required) The group name of the item
- * @param string $path (required) The path under which this item is stored
- * @param int $componentID The optional component ID (so componenets can share the same name space)
+ * @param string $group
+ * (required) The group name of the item.
+ * @param string $path
+ * (required) The path under which this item is stored.
+ * @param int $componentID
+ * The optional component ID (so componenets can share the same name space).
*
* @return object The data if present in cache, else null
* @static
- * @access public
*/
- static function &getItem($group, $path, $componentID = NULL) {
+ public static function &getItem($group, $path, $componentID = NULL) {
if (self::$_cache === NULL) {
self::$_cache = array();
}
if (!self::$_cache[$argString]) {
$dao = new CRM_Core_DAO_Cache();
- $dao->group_name = $group;
- $dao->path = $path;
+ $dao->group_name = $group;
+ $dao->path = $path;
$dao->component_id = $componentID;
$data = NULL;
/**
* Retrieve all items in a group
*
- * @param string $group (required) The group name of the item
- * @param int $componentID The optional component ID (so componenets can share the same name space)
+ * @param string $group
+ * (required) The group name of the item.
+ * @param int $componentID
+ * The optional component ID (so componenets can share the same name space).
*
* @return object The data if present in cache, else null
* @static
- * @access public
*/
- static function &getItems($group, $componentID = NULL) {
+ public static function &getItems($group, $componentID = NULL) {
if (self::$_cache === NULL) {
self::$_cache = array();
}
if (!self::$_cache[$argString]) {
$dao = new CRM_Core_DAO_Cache();
- $dao->group_name = $group;
+ $dao->group_name = $group;
$dao->component_id = $componentID;
$dao->find();
/**
* Store an item in the DB cache
*
- * @param object $data (required) A reference to the data that will be serialized and stored
- * @param string $group (required) The group name of the item
- * @param string $path (required) The path under which this item is stored
- * @param int $componentID The optional component ID (so componenets can share the same name space)
+ * @param object $data
+ * (required) A reference to the data that will be serialized and stored.
+ * @param string $group
+ * (required) The group name of the item.
+ * @param string $path
+ * (required) The path under which this item is stored.
+ * @param int $componentID
+ * The optional component ID (so componenets can share the same name space).
*
* @return void
* @static
- * @access public
*/
- static function setItem(&$data, $group, $path, $componentID = NULL) {
+ public static function setItem(&$data, $group, $path, $componentID = NULL) {
if (self::$_cache === NULL) {
self::$_cache = array();
}
$dao = new CRM_Core_DAO_Cache();
- $dao->group_name = $group;
- $dao->path = $path;
+ $dao->group_name = $group;
+ $dao->path = $path;
$dao->component_id = $componentID;
// get a lock so that multiple ajax requests on the same page
* Delete all the cache elements that belong to a group OR
* delete the entire cache if group is not specified
*
- * @param string $group The group name of the entries to be deleted
- * @param string $path path of the item that needs to be deleted
+ * @param string $group
+ * The group name of the entries to be deleted.
+ * @param string $path
+ * Path of the item that needs to be deleted.
* @param bool|\booleab $clearAll clear all caches
*
* @return void
* @static
- * @access public
*/
- static function deleteGroup($group = NULL, $path = NULL, $clearAll = TRUE) {
+ public static function deleteGroup($group = NULL, $path = NULL, $clearAll = TRUE) {
$dao = new CRM_Core_DAO_Cache();
if (!empty($group)) {
* This function takes entries from the session array and stores it in the cache.
* It also deletes the entries from the $_SESSION object (for a smaller session size)
*
- * @param array $names Array of session values that should be persisted
+ * @param array $names
+ * Array of session values that should be persisted.
* This is either a form name + qfKey or just a form name
* (in the case of profile)
- * @param boolean $resetSession Should session state be reset on completion of DB store?
+ * @param bool $resetSession
+ * Should session state be reset on completion of DB store?.
*
* @return void
* @static
- * @access private
*/
- static function storeSessionToCache($names, $resetSession = TRUE) {
+ public static function storeSessionToCache($names, $resetSession = TRUE) {
foreach ($names as $key => $sessionName) {
if (is_array($sessionName)) {
- $value = null;
+ $value = NULL;
if (!empty($_SESSION[$sessionName[0]][$sessionName[1]])) {
$value = $_SESSION[$sessionName[0]][$sessionName[1]];
}
self::setItem($value, 'CiviCRM Session', "{$sessionName[0]}_{$sessionName[1]}");
- if ($resetSession) {
- $_SESSION[$sessionName[0]][$sessionName[1]] = NULL;
- unset($_SESSION[$sessionName[0]][$sessionName[1]]);
- }
+ if ($resetSession) {
+ $_SESSION[$sessionName[0]][$sessionName[1]] = NULL;
+ unset($_SESSION[$sessionName[0]][$sessionName[1]]);
}
+ }
else {
- $value = null;
+ $value = NULL;
if (!empty($_SESSION[$sessionName])) {
$value = $_SESSION[$sessionName];
}
self::setItem($value, 'CiviCRM Session', $sessionName);
- if ($resetSession) {
- $_SESSION[$sessionName] = NULL;
- unset($_SESSION[$sessionName]);
- }
+ if ($resetSession) {
+ $_SESSION[$sessionName] = NULL;
+ unset($_SESSION[$sessionName]);
}
}
+ }
self::cleanup();
}
/* Retrieve the session values from the cache and populate the $_SESSION array
*
- * @param array $names Array of session values that should be persisted
+ * @param array $names
+ * Array of session values that should be persisted.
* This is either a form name + qfKey or just a form name
* (in the case of profile)
*
* @return void
* @static
- * @access private
*/
/**
- * @param $names
+ * @param string $names
*/
- static function restoreSessionFromCache($names) {
+ public static function restoreSessionFromCache($names) {
foreach ($names as $key => $sessionName) {
if (is_array($sessionName)) {
$value = self::getItem('CiviCRM Session',
*
* @return void
* @static
- * @access private
*/
- static function cleanup($session = false, $table = false, $prevNext = false) {
+ public static function cleanup($session = FALSE, $table = FALSE, $prevNext = FALSE) {
// clean up the session cache every $cacheCleanUpNumber probabilistically
$cleanUpNumber = 757;
$timeIntervalMins = 30;
if (mt_rand(1, 100000) % $cleanUpNumber == 0) {
- $session = $table = $prevNext = true;
+ $session = $table = $prevNext = TRUE;
}
- if ( ! $session && ! $table && ! $prevNext ) {
+ if (!$session && !$table && !$prevNext) {
return;
}
- if ( $prevNext ) {
+ if ($prevNext) {
// delete all PrevNext caches
CRM_Core_BAO_PrevNextCache::cleanupCache();
}
- if ( $table ) {
+ if ($table) {
// also delete all the action temp tables
// that were created the same interval ago
$dao = new CRM_Core_DAO();
AND CREATE_TIME < date_sub( NOW( ), INTERVAL $timeIntervalDays day )
";
- $params = array(1 => array($dao->database(), 'String'));
+ $params = array(1 => array($dao->database(), 'String'));
$tableDAO = CRM_Core_DAO::executeQuery($query, $params);
- $tables = array();
+ $tables = array();
while ($tableDAO->fetch()) {
$tables[] = $tableDAO->tableName;
}
}
}
- if ( $session ) {
+ if ($session) {
// first delete all sessions which are related to any potential transaction
// page
$transactionPages = array(
- 'CRM_Contribute_Controller_Contribution',
- 'CRM_Event_Controller_Registration',
- );
+ 'CRM_Contribute_Controller_Contribution',
+ 'CRM_Event_Controller_Registration',
+ );
$params = array(
1 => array(date('Y-m-d H:i:s', time() - $timeIntervalMins * 60), 'String'),
);
foreach ($transactionPages as $trPage) {
$params[] = array("%${trPage}%", 'String');
- $where[] = 'path LIKE %' . sizeof($params);
+ $where[] = 'path LIKE %' . sizeof($params);
}
$sql = "
DELETE FROM civicrm_cache
WHERE group_name = 'CiviCRM Session'
AND created_date <= %1
-AND (" . implode(' OR ', $where) . ")";
+AND (" . implode(' OR ', $where) . ")";
CRM_Core_DAO::executeQuery($sql, $params);
$sql = "
}
}
}
-
projects / civicrm-core.git / blobdiff