+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
require_once "PEAR.php";
class CRM_Core_Session {
/**
- * Cache of all the session names that we manage
+ * Cache of all the session names that we manage.
*/
static $_managedNames = NULL;
* pattern and cache the instance in this variable
*
* @var object
- * @static
*/
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* The CMS takes care of initiating the php session handler session_start().
*
}
/**
- * Singleton function used to manage this object
+ * Singleton function used to manage this object.
*
* @return CRM_Core_Session
- * @static
*/
public static function &singleton() {
if (self::$_singleton === NULL) {
- self::$_singleton = new CRM_Core_Session;
+ self::$_singleton = new CRM_Core_Session();
}
return self::$_singleton;
}
// FIXME: This belongs in CRM_Utils_System_*
if ($config->userSystem->is_drupal && function_exists('drupal_session_start')) {
// https://issues.civicrm.org/jira/browse/CRM-14356
- if (! (isset($GLOBALS['lazy_session']) && $GLOBALS['lazy_session'] == TRUE)) {
+ if (!(isset($GLOBALS['lazy_session']) && $GLOBALS['lazy_session'] == TRUE)) {
drupal_session_start();
}
$_SESSION = array();
) {
$this->_session[$this->_key] = array();
}
- return;
+ return NULL;
}
/**
- * Resets the session store
+ * Resets the session store.
*
*
* @param int $all
$this->_session = array();
}
- return;
+ return NULL;
}
/**
- * Creates a session local scope
+ * Creates a session local scope.
*
* @param string $prefix
* Local scope name.
}
/**
- * Resets the session local scope
+ * Resets the session local scope.
*
* @param string $prefix
* Local scope name.
}
/**
- * Store the variable with the value in the session scope
+ * Store the variable with the value in the session scope.
*
* This function takes a name, value pair and stores this
* in the session scope. Not sure what happens if we try
}
/**
- * Gets the value of the named variable in the session scope
+ * Gets the value of the named variable in the session scope.
*
* This function takes a name and retrieves the value of this
* variable from the session scope.
*
*
* @param string $name
- * : name of the variable.
+ * name of the variable.
* @param string $prefix
- * : adds another level of scope to the session.
+ * adds another level of scope to the session.
*
* @return mixed
*/
*
*
* @param string $name
- * : name of the timer.
+ * name of the timer.
* @param int $expire
- * : expiry time (in seconds).
+ * expiry time (in seconds).
*
* @return mixed
*/
}
/**
- * Adds a userContext to the stack
+ * Adds a userContext to the stack.
*
* @param string $userContext
* The url to return to when done.
}
/**
- * Replace the userContext of the stack with the passed one
+ * Replace the userContext of the stack with the passed one.
*
* @param string $userContext
* The url to return to when done.
}
/**
- * Pops the top userContext stack
+ * Pops the top userContext stack.
*
* @return string
* the top of the userContext stack (also pops the top element)
}
/**
- * Reads the top userContext stack
+ * Reads the top userContext stack.
*
* @return string
* the top of the userContext stack
}
/**
- * Dumps the session to the log
+ * Dumps the session to the log.
* @param int $all
*/
public function debug($all = 1) {
}
/**
- * Fetches status messages
+ * Fetches status messages.
*
* @param bool $reset
* Should we reset the status variable?.
* defaults to 10 seconds for most messages, 5 if it has a title but no body,
* or 0 for errors or messages containing links
*
- * @static
*
* @return void
*/
}
/**
- * Retrieve contact id of the logged in user
- * @return integer|NULL contact ID of logged in user
+ * Retrieve contact id of the logged in user.
+ * @return int|NULL
+ * contact ID of logged in user
*/
public static function getLoggedInContactID() {
$session = CRM_Core_Session::singleton();
// helps proxies like varnish
return empty($_SESSION);
}
+
}
projects / civicrm-core.git / blobdiff