Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2014-06-25-23-42-42

[civicrm-core.git] / CRM / Activity / StateMachine / Search.php

diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php
index 75b987ffe1353c75ec64e21fc1ecbe22a50bd430..ad14391ecdb9a711316851283d19fa8360c15d0d 100644 (file)
--- a/CRM/Activity/StateMachine/Search.php
+++ b/CRM/Activity/StateMachine/Search.php
@@ -97,6 +97,18 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine {
     return CRM_Utils_String::getClassName($this->_task);
   }
 
+  /**
+   * Should the controller reset the session
+   * In some cases, specifically search we want to remember
+   * state across various actions and want to go back to the
+   * beginning from the final state, but retain the same session
+   * values
+   *
+   * @return boolean
+   */
+  /**
+   * @return bool
+   */
   function shouldReset() {
     return FALSE;
   }