Merge remote-tracking branch 'origin/4.4' into 4.4-4.5-2014-09-14-13-58-42

[civicrm-core.git] / CRM / Core / Session.php

diff --git a/CRM/Core/Session.php b/CRM/Core/Session.php
index 059fb22bdd4195d87960f8c01a41c248feb3852c..24f53be63f093c779df17d17550c100963b7a090 100644 (file)
--- a/CRM/Core/Session.php
+++ b/CRM/Core/Session.php
@@ -27,6 +27,10 @@
 
 
 require_once "PEAR.php";
+
+/**
+ * Class CRM_Core_Session
+ */
 class CRM_Core_Session {
 
   /**
@@ -79,7 +83,7 @@ class CRM_Core_Session {
    * This constructor is invoked whenever any module requests an instance of
    * the session and one is not available.
    *
-   * @return void
+   * @return \CRM_Core_Session
    */
   function __construct() {
     $this->_session = null;
@@ -149,6 +153,8 @@ class CRM_Core_Session {
    *
    * @access public
    *
+   * @param int $all
+   *
    * @return void
    */
   function reset($all = 1) {
@@ -518,6 +524,9 @@ class CRM_Core_Session {
     }
   }
 
+  /**
+   * @param $names
+   */
   static function registerAndRetrieveSessionObjects($names) {
     if (!is_array($names)) {
       $names = array($names);
@@ -533,6 +542,9 @@ class CRM_Core_Session {
     CRM_Core_BAO_Cache::restoreSessionFromCache($names);
   }
 
+  /**
+   * @param bool $reset
+   */
   static function storeSessionObjects($reset = TRUE) {
     if (empty(self::$_managedNames)) {
       return;
@@ -557,6 +569,9 @@ class CRM_Core_Session {
     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