require_once "PEAR.php";
+
+/**
+ * Class CRM_Core_Session
+ */
class CRM_Core_Session {
/**
static $_managedNames = NULL;
/**
- * key is used to allow the application to have multiple top
+ * Key is used to allow the application to have multiple top
* level scopes rather than a single scope. (avoids naming
* conflicts). We also extend this idea further and have local
* scopes within a global scope. Allows us to do cool things
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @return CRM_Core_Session
* @static
}
/**
- * creates a session local scope
+ * Creates a session local scope
*
* @param string prefix local scope name
* @param boolean isRead is this a read operation, in this case, the session will not be touched
}
/**
- * resets the session local scope
+ * Resets the session local scope
*
* @param string local scope name
* @access public
}
/**
- * adds a userContext to the stack
+ * Adds a userContext to the stack
*
* @param string $userContext the url to return to when done
* @param boolean $check should we do a dupe checking with the top element
}
/**
- * replace the userContext of the stack with the passed one
+ * Replace the userContext of the stack with the passed one
*
* @param string the url to return to when done
*
}
/**
- * pops the top userContext stack
+ * Pops the top userContext stack
*
* @param void
*
}
/**
- * reads the top userContext stack
+ * Reads the top userContext stack
*
* @param void
*
}
/**
- * dumps the session to the log
+ * Dumps the session to the log
*/
function debug($all = 1) {
$this->initialize();
}
}
+ /**
+ * @param string $names
+ */
static function registerAndRetrieveSessionObjects($names) {
if (!is_array($names)) {
$names = array($names);
CRM_Core_BAO_Cache::restoreSessionFromCache($names);
}
+ /**
+ * @param bool $reset
+ */
static function storeSessionObjects($reset = TRUE) {
if (empty(self::$_managedNames)) {
return;
return $session->get('userID');
}
+ /**
+ * @return bool
+ */
function isEmpty() {
// check if session is empty, if so we dont cache
// stuff that we can get away with